{"info":{"_postman_id":"b572c885-365b-4c64-be94-bb319d0aabc0","name":"Abel API","description":"

Abel provides small business lenders with advanced risk and operational capabilities via a single API.

Our technology platform combines granular control over products, risk parameters and lending processes, with SME-specific risk innovations to identify new lending opportunties, unlock new levels of automation, and deliver improved lender profitability.

Lenders can use individual API services to enhance their existing technology estate or combine our APIs to deliver end-to-end lending propositions on Abel infrastructure.

Our capabilities are broadly broken down into 5 key areas, reflecting the major stages of the credit lifecycle and lending experience.

Origination

Originate new lending opportunities quickly, accurately and efficiently.

Lending profitability starts with originating the right clients for your lending approach and appetite. Using advanced data science and real-world lending experience, Abel's origination models generates a range of interactive quotes, considering your full product catalogue, and fit to the unique profile and context.

Generate lending quotes in <50 seconds, using only customer-provided 5 data points, and with >85% likelihood of acceptance at the final offer phase.
Adjust 100+ precise risk parameters that allows you dynamic decision models balance risk, CX and cost
Meet and exceed consumer duty requirements, by matching your customer to the most appropriate product based on their preferences, financial situation and funding context.
Multi-product offers provide

Decisioning

Make quick and confident lending decisions. Abel provides precise control over the underwriting process, augmenting traditional datasets with proprietary models designed to identify lending opportunities missed by tradtional lenders.

Our granular risk controls allow you to precisely understand the risk profile of a company, accelerating underwriter triage and enabling 100% straight through processing for low risk customers and applications.

Fine-grain control of 200+ risk parameters, enabling accurate decisions with a high degree of flexibility. All parameters can be adjusted by business users in seconds using our no-code risk configuration platform.
SME-specific models, including forward-looking affordability and sub-sector economic outlook models, provide additional insight into a customer application, credit worthiness and growth potential, helping you to identify high potential customers missed by traditional approaches.
Transaction analysis via Open Banking or our proprietary statement scanning technology provides us a time series of cashflow and trajectory without requiring manual document review.

Onboarding

Onboard all SME companies, however complex. Abel’s onboarding process has automated verification, customer communications and loan processes to increase turnaround speed and consistency while reducing risks.

A fully paperless onboarding processes, integrateable with leading KYC, KYB and digital documentation applicaitons.
Multi-director processing, verifying all directors depending on policy requirements.
Anti-fraud measures including automated data validation with Companies House and multi-stage withdrawal approval options.
Integrations with GoCardless to setup automated direct debit repayments

Servicing

If there is a choice of who to pay, the better relationship wins. Our APIs enable seamless customer self-service and fully automated loan servicing journeys.

Integrate directly with your chosen Loan Management System or make use of our native Abel Servicing stack, custom-built to support specific SME digital servicing functionality.

Fully automated loan processing and direct debit set up
Embed rich loan detail and interactions into any customer channel.
Advanced capabilities, including early loan repayment, payment holiday calculations and arrears management automation available via the Abel LMS.

Monitoring

Abel's range of granular and forward-looking SME insights help lenders anticipate both challenges and opportunities, enabling a front-footed and agile risk strategy and proactive approach to customer service.

We've developed a continuous feedback loop across macroeconomic, sector, bureau and transactional data, helping you determine the health of a business or portfolio in real-time.

Complete book visibility to individual loan level
Adjust 200+ risk and model parameters in real-time to deliver, granular behavioural segmentation
Push granular risk strategy and appetite changes in real-time using our no-code risk configuration dashboard.
Insert SME-specific intelligence into your monitoring processes, including sub-sector economic outlook indices, behavioural P(d) scores, and forward-looking affordability scores .

Getting Started

To get started with the Abel API

Generate and retrieve your API key from the Abel Dashboard. (Contact our team for access)
Authenticate your API key using the getToken endpoint.
[Optional] Contact our team to get access to a sandbox environment with historic company and risk data, and a range of developer tools to speed testing and integration.
Browse our API collections, and read the step-by-step guides to get successfully integrate with Abels services.

Authentication and Security

The Abel API uses API keys to authenticate requests. You can view and manage your API keys in your Abel Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

All requests need to contain the x-api-key header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

You can retrieve a token using the following endpoint: POST /api/v1/get-token

Request:

{ \"client_id\": \"{{client_id}}\", \"client_secret\": \"{{client_secret}}\" }

Response:

{ \"success\": true, \"message\": \"Success\", \"result\": { \"token\": \"{{TOKEN}}\" } }

API Basics

API Architecture

The Abel API is organised around REST. The API attempts to use predictable, resource-oriented URLs and to use HTTP status codes to indicate errors.

Request Methods

Abel follows standard RESTful API Method conventions to expose API functionality. These are summarised in the table below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Description
GET	The GET method is used to retrieve data from the server. Use the GET method when you want to read or fetch information. It is safe and idempotent, meaning that multiple identical requests will produce the same result. GET requests should not have any side effects on the server or modify the data.
POST	Send data to the server to create a new resource. Use the POST method when you want to create a new entity or submit data to be processed. It is not idempotent, meaning that sending the same request multiple times may result in different outcomes. POST requests can have side effects, such as creating a new record in the database.
PUT	Send data to the server to update or create a resource. Use the PUT method when you want to update an entire resource with new data or replace it entirely. It is idempotent, meaning that sending the same request multiple times will have the same effect as sending it once. PUT requests can be used to create a resource if you provide the identifier.
DELETE	Remove a specified resource from the server. Use the DELETE method when you want to remove a specific resource or entity. It is idempotent, meaning that sending the same request multiple times will have the same effect as sending it once. DELETE requests should not have any side effects other than removing the resource.

Request Headers

All the requests need to contain the x-api-key header and all, execept the getToken endpoint require an authorisation token.

Response Codes

Abel adheres to the range of HTTP Status Codes typical to RESTful APIs.

Pagination

Pagination is not currently supported in this version of the Abel API. We are working to provide support pagination in subsequent versions of this API.

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 1000 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
`X-RateLimit-Limit`	The maximum number of requests that the consumer is permitted to make per minute.
`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Integration Guides

Step-by-step guides

The Abel API is organised into five key collections, reflecting the key stages and activities of each stage of the SME lending lifecycle:

Origination: generating 'quick offer' quotes for a customer
Decisioning: converting those quotes to fully risk underwritten lending decisions.
Onboarding: activating a customer and loan in the systems and disbursing funds
Servicing: exposing live loan information, and automating repayment processes
Monitoring: conducting loan, customer and portfolio-level monitoring activities.

Each collection is prefaced by a step-by-step guides to implement the key lending activities in each phase. Refer to the guides in each section for best practice implementation suggestions and review the various configuration options Abel supports.

Support

For implementation, troubleshooting and best practice support contact our engineering team directly at client-support@beabel.io.

API Reference

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Authentication and Security","slug":"authentication-and-security"},{"content":"API Basics","slug":"api-basics"},{"content":"Integration Guides","slug":"integration-guides"},{"content":"Support","slug":"support"},{"content":"API Reference","slug":"api-reference"}],"owner":"24900067","collectionId":"b572c885-365b-4c64-be94-bb319d0aabc0","publishedId":"2s93z6ciGX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"021715","highlight":"03966F"},"publishDate":"2023-07-14T20:42:36.000Z"},"item":[{"name":"Authentication","item":[{"name":"getToken","event":[{"listen":"test","script":{"id":"f1cdd9e5-54cc-4a0b-9673-b438db8ad860","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.result.token);"],"type":"text/javascript"}}],"id":"9822060d-93c1-4cac-8846-47350347fef3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"{{client_id}}\",\n \"clientSecret\": \"{{client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/get-token","description":"

Retrieves the bearer token to be used in the Authentication header for all requests. The token is valid for 10 minutes.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body parameter
clientId	string
clientSecret	string

Response body

\n\n\n\n\n\n\n\n\n\n\n\n\n

Response parameter
token	string (JWT token)

","urlObject":{"path":["api","v1","get-token"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"e12292a2-9765-491f-8c90-9c6780f545e1","name":"getToken","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"a034ef58-fcc5-414d-acdf-cb4609562b51\",\n \"client_secret\": \"1Dr>o{-To acces the API every request needs to have the header x-api-key: {{API-KEY}} and the Authentication header Authentication: Bearer {{token}}. The authentication token can be aquired via the getToken request and is valid for up to 10 minutes. Once 10 minutes has elapsed, you can retrieve another authentication token by re-invoking the getToken request.

\n","_postman_id":"c12dd24a-7e02-4064-bbfd-3b58c6309ef6"},{"name":"Sandbox","item":[{"name":"deleteCompany","id":"96d4932a-5f4c-4298-b94f-63e155f5aaff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"{{baseUrl}}/api/v1/sandbox/delete-company?companyId={{company_id}}","description":"

Endpoint to delete a company. Use it when you want to delete a company and start the processing over, perhaps with different imput parameters, or to test error behaviours.

Note, this endpont is for Staging use only, and is not available in Production.

This request is asynchronous. You will receive the response code 200 immediately, and then a webhook event of type ACTION_COMPLETED category SANDBOX and detail {\"companyId\": {{companyId}}, \"action\": \"delete\"} when the action is completed.

Request query params

companyId - string, mandatory

\n","urlObject":{"path":["api","v1","sandbox","delete-company"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"34078d52-126c-475b-82e9-2259de94b7c5","name":"deleteCompany","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/sandbox/delete-company?companyId=3049710886601099109","host":["{{baseUrl}}"],"path":["api","v1","sandbox","delete-company"],"query":[{"key":"companyId","value":"3049710886601099109"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 20:15:31 GMT"},{"key":"x-amzn-RequestId","value":"3f54222d-76a7-4bd1-beee-72804ce58c63"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BK2KnGqiLPEFtXw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640103dd-61f1a48564ef7dd16d3396d3;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b6dd76b2674d0d05f01c7ffe053c33aa.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"2n-UFnLQFCFCD_XRL8jVDEhlgmXqVKNV4PXLvMngcGFXrYzQKPcZ1g=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Company deletion initiated\",\n \"result\": {}\n}"}],"_postman_id":"96d4932a-5f4c-4298-b94f-63e155f5aaff"}],"id":"30fc8953-2b2a-4690-8e24-fa67cb07614c","description":"

The Sandbox environment helps developers test production-ready functionality in a controlled environment using mock data.

It also provides additional functionality not available in the production environment to assist with testing and prototyping workflows.

You can access the Sandbox environment by...

\n","_postman_id":"30fc8953-2b2a-4690-8e24-fa67cb07614c"},{"name":"Status","item":[{"name":"getStatus","id":"e9c6794b-8367-425f-bfc7-113712835ebd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"{{baseUrl}}/api/v1/status","description":"

Get the status and the version of the system.

Response fields

version string REQUIRED.\nDeclares the current version of the Abel system.

\n","urlObject":{"path":["api","v1","status"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"4ecad147-c0d8-4e5a-bd13-14f1f3c0c071","name":"getStatus","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/status","host":["{{baseUrl}}"],"path":["api","v1","status"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"88"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 16:18:03 GMT"},{"key":"x-amzn-RequestId","value":"0e6a9425-780d-4991-bde8-350bedfe0165"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BKTZQHBiLPEFjcA="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6400cc3a-499c7bcb7824801d27572323;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 800675e91c111e7a276d8d8cb01627b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"-QWm9lCBGllQZgzSbJE_0N1_UQ1OH9AqCGAKZppwy7Vv_USHsomhaA=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"version\": \"1.0.0\"\n }\n}"}],"_postman_id":"e9c6794b-8367-425f-bfc7-113712835ebd"}],"id":"bd606621-fcc1-43ce-ae96-6cd92bd3056e","description":"

The status endpoint returns the current system status and version of the targeted Abel API.

\n","_postman_id":"bd606621-fcc1-43ce-ae96-6cd92bd3056e"},{"name":"Origination","item":[{"name":"Users and Company","item":[{"name":"createCompany","event":[{"listen":"test","script":{"id":"9906a439-326c-46b5-a600-b9ae5b841d5e","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"company_id\", jsonData.result.companyId);"],"type":"text/javascript"}}],"id":"50104262-1fc9-4729-8e95-180c80148af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companiesHouseNumber\": \"11289915\",\n \"annualTurnover\": 1000000,\n \"desiredAmount\": 10000,\n \"tradesWithRestrictedCountries\": false,\n \"tradesMostlyAbroad\": false,\n \"tradesOutsideUk\": false,\n \"isSme\": true,\n \"reasonForFunding\": \"Making a purchase\",\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradingAddress\": \"54-56 High Street, Grays, Essex, United Kingdom\",\n \"tradingAddressPostcode\": \"RM17 6NA\",\n \"tradingName\": \"WS GLOBAL SERVICES LTD\",\n \"website\": \"www.test.com\",\n \"declaredBrokerEmail\": \"broker@x.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/create-company","description":"

A company is created based on Companies House data, customer preference, and company financial status.

Note, an Application is automatically created alongside a new company.

Request body parameters

companiesHouseNumber string, REQUIRED
The Companies House number of the company you wish to create.

companiesHouseNumber (string): REQUIRED

annualTurnover (number): REQUIRED

desiredAmount (number): REQUIRED.
Minimum value: 10000

tradesWithRestrictedCountries (boolean): OPTIONAL

tradesMostlyAbroad (boolean): OPTIONAL

tradesOutsideUk (boolean): OPTIONAL

isSme (boolean): OPTIONAL

reasonForFunding (string): OPTIONAL.

Default: \"Making a purchase\"

detailedLoanPurpose (string): OPTIONAL

costPreference (string): OPTIONAL.
Allowed values: \"lowestMonthlyRepayment\" and \"lowestTotalRepayment\". Default: \"lowestMonthlyRepayment\"

netProfit (number): OPTIONAL

accountEndDate (date): OPTIONAL.
Format: YYYY-MM-DD

accountDepreciation (number): OPTIONAL

accountAmortisation (number): OPTIONAL

otherAccountOperatingIncome (number): OPTIONAL

tradingAddress (string): OPTIONAL

tradingAddressPostcode (string): OPTIONAL

tradingName (string): OPTIONAL

website (string): OPTIONAL

declaredBrokerEmail (string): OPTIONAL

Response body

companyId (string)
A unique company ID; a large integer, returned as string

\n","urlObject":{"path":["api","v1","origination","create-company"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"8bc5f6f8-1a99-4028-a7ed-f16233afe34c","name":"createCompany - single director","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companiesHouseNumber\": \"11289915\",\n \"annualTurnover\": 1000000,\n \"desiredAmount\": 10000,\n \"tradesWithRestrictedCountries\": false,\n \"tradesMostlyAbroad\": false,\n \"tradesOutsideUk\": false,\n \"isSme\": true,\n \"reasonForFunding\": \"Making a purchase\",\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradingAddress\": \"54-56 High Street, Grays, Essex, United Kingdom\",\n \"tradingAddressPostcode\": \"RM17 6NA\",\n \"tradingName\": \"WS GLOBAL SERVICES LTD\",\n \"website\": \"www.test.com\",\n \"declaredBrokerEmail\": \"broker@x.com\"\n }\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/create-company","host":["{{baseUrl}}"],"path":["api","v1","origination","create-company"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"87"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 11:14:26 GMT"},{"key":"x-amzn-RequestId","value":"b718db31-eb6a-471c-9339-a6b8a935d5fe"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"Bj-ayF9yrPEF0xg="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b1111-5cb907d43389452b04cce024;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b78cc6d01d4e7856002e813febd954e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"CDG50-C1"},{"key":"X-Amz-Cf-Id","value":"CovcZ7jZtznfpbRaki59sVINfH5g1M4ufimJ2Dg4Mpmhz3auiHqigQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"companyId\": \"3055356223458117123\"\n }\n}"},{"id":"96616c93-ca25-4764-abd8-8318c7e53a90","name":"createCompany - two directors","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companiesHouseNumber\": \"07979499\",\n \"annualTurnover\": 1000000,\n \"desiredAmount\": 10000,\n \"tradesWithRestrictedCountries\": false,\n \"tradesMostlyAbroad\": false,\n \"tradesOutsideUk\": false,\n \"isSme\": true,\n \"reasonForFunding\": \"Making a purchase\",\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradingAddress\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"tradingAddressPostcode\": \"S71 2LG\",\n \"tradingName\": \"SAUK UTILITIES LIMITED\",\n \"website\": \"www.test.com\",\n \"declaredBrokerEmail\": \"broker@x.com\"\n }\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/create-company","host":["{{baseUrl}}"],"path":["api","v1","origination","create-company"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"87"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 12:56:42 GMT"},{"key":"x-amzn-RequestId","value":"b5653ad6-ceb7-453a-baab-6d8c48a178bb"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BkNZiFJvrPEFkWA="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b2909-3c8d9af97f23655757fe467d;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b02c5108645d71e94b66c369c35c449a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"iWQJzZ-3C62NBG0_U9cBWgCHYkKOKKUuQqxIJduLS_N7dfnp3TYarg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"companyId\": \"3055407695034058353\"\n }\n}"}],"_postman_id":"50104262-1fc9-4729-8e95-180c80148af8"},{"name":"createUser","event":[{"listen":"test","script":{"id":"16985268-797e-4e79-aaa7-c00f178c62df","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"user_id\", jsonData.result.userId);"],"type":"text/javascript"}}],"id":"d25bf610-ec13-4835-be21-8df9a4ae7a50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"catherine.rybinska+{{client_code}}_customer1@beabel.io\",\n \"phone\": \"09876543234\",\n \"address\": \"65 Havelock Drive, Greenhithe, Kent\",\n \"firstName\": \"Waqas\",\n \"lastName\": \"IQBAL\",\n \"dateOfBirth\": \"1989-09-01\",\n \"companyId\": \"{{company_id}}\",\n \"postcode\": \"DA9 9XU\",\n \"role\": \"director\",\n \"occupation\": \"director\",\n \"ukResidencyAboveTwoYears\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/create-user","description":"

A user must be a director of the company in Companies House. Their first, last name, and year and month of their date of birth must match Companies House data.

If the company has more than one directors, a user will be created for each director. Directors can be listed using the getDirectors call. All users can be updated using updateUser call.

Request body

companyID string, REQUIRED
The Companies House number of the company you wish to create.

email (string): REQUIRED
The email address associated with the user.

phone (string): REQUIRED
The phone number associated with the user.

address (string):
The user's address in the following format: {line_1}, {line_2}, {line_3}, {line_4}, {town_or_city}, {locality}, {county}, {country}. Line 1 and town/city are REQUIRED.

postcode (string): REQUIRED
The postcode associated with the user's address.

firstName (string): REQUIRED
The first name of the director, which must match the Companies House data.

lastName (string): REQUIRED
The last name of the director, which must match the Companies House data.

dateOfBirth (date): REQUIRED
The date of birth of the director, in the format YYYY-MM-DD. The year and month must match the Companies House data.

role (string): OPTIONAL
The role or position of the user in the company.

occupation (string): OPTIONAL
The occupation or job title of the user.

ukResidencyAboveTwoYears (boolean): OPTIONAL
Indicates whether the user has been a UK resident for more than two years.

Response body

userID (string)
A unique identifier for the user; a large integer returned as a string.

\n","urlObject":{"path":["api","v1","origination","create-user"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"62fc79a2-2fb3-47f4-9587-d2342d1b18d5","name":"createUser (GENERAL)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"customer1@beabel.io\",\n \"phone\": \"09876543234\",\n \"address\": \"65 Havelock Drive, Greenhithe, Kent\",\n \"firstName\": \"Waqas\",\n \"lastName\": \"IQBAL\",\n \"dateOfBirth\": \"1989-09-01\",\n \"companyId\": \"3055356223458117123\",\n \"postcode\": \"DA9 9XU\",\n \"role\": \"director\",\n \"occupation\": \"director\",\n \"ukResidencyAboveTwoYears\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/create-user","host":["{{baseUrl}}"],"path":["api","v1","origination","create-user"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"84"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 11:15:07 GMT"},{"key":"x-amzn-RequestId","value":"59791666-2855-435e-8eaa-f6438b68781b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"Bj-hIFo_LPEFl_g="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b113a-1a96a37e14c6c117430a1a71;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b78cc6d01d4e7856002e813febd954e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"CDG50-C1"},{"key":"X-Amz-Cf-Id","value":"l7Xxne_D4uzsgMMHvzULNcVDTiQ-N9xjhilCnabDjF-LY3uPBUFeNw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"userId\": \"3055356561384801803\"\n }\n}"}],"_postman_id":"d25bf610-ec13-4835-be21-8df9a4ae7a50"}],"id":"7ba3c041-19b4-46ea-b288-30dd4e8673f0","description":"

All Abel decisions are based on Companies and Users. You can use any of Abel’s toolkit and modules by simply creating a Company and a User. Alongside the application, they are the primary means to access the range of services availalble in the Abel platform.

\n","_postman_id":"7ba3c041-19b4-46ea-b288-30dd4e8673f0"},{"name":"Quick Offers","item":[{"name":"generateQuickOffers","id":"03a9744c-a0d7-4c8d-a549-0bca1bea2b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\" \n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/generate-quick-offers","description":"

Invoke this API to begin the risk assessment sequence to generate a range of Quick Offers.

This request is asynchronous. You will receive the response code 200 immediately, and then a webhook event of type ACTION_COMPLETED category RISK and detail {\"companyId\": {{companyId}}, \"action\": \"generate_quick_offers\"} when the action is completed.

Request body

companyId (string) REQUIRED

The company ID for whom you wish to generate quick offers.

\n","urlObject":{"path":["api","v1","origination","generate-quick-offers"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"f85628b0-30ba-4d79-a384-cb2a507c11d9","name":"generateQuickOffers","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3050258468087792821\" \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/generate-quick-offers","host":["{{baseUrl}}"],"path":["api","v1","origination","generate-quick-offers"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 Mar 2023 10:51:25 GMT"},{"key":"x-amzn-RequestId","value":"5adc58cc-9157-494c-8e2e-399aa1c8d02d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BM2eMFMkLPEFrKQ="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6401d127-1213b3fc5a3561ed2c8d2860;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a332ecb068a370997b5e7bc811ff54ea.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"RKXGT2a0trFvYSGKTWLekSQxEFr4XAK3RIvSZqvtC1a_gZlz0asWKw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"03a9744c-a0d7-4c8d-a549-0bca1bea2b01"},{"name":"getCustomerStatus","id":"3fe8fe86-6824-4a51-9a89-f6bbedaae0b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/get-customer-status?companyId={{company_id}}","description":"

This endpoint returns the cutomer status mostly for the purpose of generating quick offers.

Developers note: we will be updating this endpoint in the near future to provide a greater range of customer processing statuses, covering a larger number of journeys and processes.

Request query parameters

companyId (string): REQUIRED
The Companies House number of the company you wish to query.

Response body

companyId (string)\nThe Companies House number of the company you queried

status (string)\nThe status of the quick offer generation process. Possible values are included in the table below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
`WAITING_FOR_PARTNER`	Quick offer processing has not yet been initiated by the origination partner (e.g. a broker or sales representative)
`WAITING_FOR_LENDER`	Quick offer processing is in progress.
`WAITING_FOR_CUSTOMER`	Quick offer processing has been completed and quick offers are ready for customers to review.
`REJECTED`	Quick Offer processing has failed; the customer's application was rejected.

","urlObject":{"path":["api","v1","origination","get-customer-status"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"9432a8d0-2cc9-4a7f-9aa3-7d777e888cac","name":"getCustomerStatus","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/get-customer-status?companyId=3050258468087792821","host":["{{baseUrl}}"],"path":["api","v1","origination","get-customer-status"],"query":[{"key":"companyId","value":"3050258468087792821"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"121"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 Mar 2023 14:31:53 GMT"},{"key":"x-amzn-RequestId","value":"534b0044-e3ca-4ff6-b011-63a18cad0396"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BNWxtFHBLPEF1nQ="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640204d7-18b058855ec1b6a70cb9197e;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f9e281a6bf2f092f94317867f8034cf8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"SQ5wJRZrhSYt6E8M-djY6OoijINdMHO5m3syr8bRhAyibfhFj1n6Zw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"companyId\": \"3050258468087792821\",\n \"status\": \"WAITING_FOR_CUSTOMER\"\n }\n}"}],"_postman_id":"3fe8fe86-6824-4a51-9a89-f6bbedaae0b6"},{"name":"getQuickOffers","id":"c406e46c-64ed-4da8-847b-dc179b5d1947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/get-quick-offers?companyId={{company_id}}","description":"

This endpoint is designed to be used in your customer interface. It returns a shortlist of Quick Offers based on customer's affordability, their preferences and your configuration.

There will be a maximum of 3 offers returned, ordered by a priority. One offer will have a priority primary, while the other two secondary.

The list of generated quick offers may be longer, and you will be able to assign priorities yoursef.

If you configure your Quick Offer process accordingly (AUTOMATICALLY_SHOW_QO set to false), otherwise a shortlist will be selected for you.

Request query params

comapnyId (string) REQUIRED
The Company ID of the company you wish to retrieve Quick Offers for.

Response body

Response is an array of quick offers with the following values:

offerId (string)
The ID of the offer.

type (string)
Possible values: \"quickOffer\" and \"firmOffer\". This endpoint will only return quick offers.

productName (string)
Possible values: \"floc\" (flexible line of credit) and \"term-loan\".

priority (string)
Possible values: \"primary\" and \"secondary\".

status (string)
Possible values: \"DRAFT\", \"DRAFT_ACCEPTED\", \"APPROVED\", \"NEEDS_REVIEW\", \"ACTIVE\". This endpoint will only return offers with the status \"DRAFT\".

fundingLimit (number)
The funding limit amount.

term (number)
The term duration in months.

percentageFee (number)
Decimal value specific to flexible line of credit (floc).

apr (number)
Decimal value specific to flexible line of credit (floc).

setupFee (number)
Decimal value specific to term loan.

monthlyInterestRate (number)
Decimal value specific to term loan.

monthlyRepaymentAmount (number)
Decimal value representing the monthly repayment amount.

createdAt (datetime)
The date and time when the offer was created.

updatedAt (datetime)
The date and time when the offer was last updated.

\n","urlObject":{"path":["api","v1","origination","get-quick-offers"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"73797a57-5af4-45c9-baf2-7e50d46a1d8d","name":"getQuickOffers","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/get-quick-offers?companyId=3090844002002404643","host":["{{baseUrl}}"],"path":["api","v1","origination","get-quick-offers"],"query":[{"key":"companyId","value":"3090844002002404643"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1171"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 28 Apr 2023 10:27:39 GMT"},{"key":"x-amzn-RequestId","value":"570aa3ab-8b14-48ff-984c-de50bb3cbb24"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"EFXgGE3qLPEFyYw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-644b9f99-6aceb4500702b68f4e4394a5;Sampled=0;lineage=03f05429:0|f706fc82:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1679d4f06b5f1d02b9d3d9343e40b5cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"-WKiraBJecae6AojwIIinauVkS3LOXaTwb3b3Ssk_VC1TlmwCX5rCg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": [\n {\n \"offerId\": \"3090844480195003781\",\n \"type\": \"quickOffer\",\n \"productName\": \"floc\",\n \"priority\": \"secondary\",\n \"status\": \"DRAFT\",\n \"fundingLimit\": 10000,\n \"term\": 12,\n \"percentageFee\": 0.14,\n \"setupFee\": 0,\n \"monthlyInterestRate\": 0,\n \"apr\": 0.1396,\n \"monthlyRepaymentAmount\": 950,\n \"createdAt\": \"2023-04-28T10:23:16.316986+00:00\",\n \"updatedAt\": \"2023-04-28T10:23:25.467378+00:00\"\n },\n {\n \"offerId\": \"3090844479934956932\",\n \"type\": \"quickOffer\",\n \"productName\": \"floc\",\n \"priority\": \"secondary\",\n \"status\": \"DRAFT\",\n \"fundingLimit\": 10000,\n \"term\": 24,\n \"percentageFee\": 0.235,\n \"setupFee\": 0,\n \"monthlyInterestRate\": 0,\n \"apr\": 0.1175,\n \"monthlyRepaymentAmount\": 514.58,\n \"createdAt\": \"2023-04-28T10:23:16.281919+00:00\",\n \"updatedAt\": \"2023-04-28T10:23:25.467378+00:00\"\n },\n {\n \"offerId\": \"3090844480379553158\",\n \"type\": \"quickOffer\",\n \"productName\": \"term-loan\",\n \"priority\": \"primary\",\n \"status\": \"DRAFT\",\n \"fundingLimit\": 10000,\n \"term\": 24,\n \"percentageFee\": 0,\n \"setupFee\": 0.055,\n \"monthlyInterestRate\": 0.0084,\n \"apr\": 0.0858,\n \"monthlyRepaymentAmount\": 487.22,\n \"createdAt\": \"2023-04-28T10:23:16.338537+00:00\",\n \"updatedAt\": \"2023-04-28T10:23:25.467378+00:00\"\n }\n ]\n}"}],"_postman_id":"c406e46c-64ed-4da8-847b-dc179b5d1947"},{"name":"acceptQuickOffer","id":"fa7d3d25-0c9f-40d9-97ef-b38f411895a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3155310443954701834\",\n \"offerId\": \"3155310943378867816\"\n}\napi/v1/origination/accept-quick-offer\n\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/accept-quick-offer","description":"

Endpoint to be used by your customer to accept quick offers.

When the endpoint is invoked you will receive a webhook event type OFFER_ACCEPTED, category OFFER detail {\"companyId\": {{companyId}}, \"action\": \"accept_quick_offer\"}.

Request body

companyId (string) REQUIRED
The ID of the company accepting the offer.

offerId (string) REQUIRED
The ID of the offer being accepted.

\n","urlObject":{"path":["api","v1","origination","accept-quick-offer"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"c61c6495-8285-449c-a47b-74fc194108a6","name":"acceptQuickOffer","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3050258468087792821\",\n \"offerId\": \"3050271577921815865\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/accept-quick-offer","host":["{{baseUrl}}"],"path":["api","v1","origination","accept-quick-offer"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 Mar 2023 15:51:13 GMT"},{"key":"x-amzn-RequestId","value":"18087e67-4700-4fe1-900e-264976c7db6e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BNiYOG2drPEFphg="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64021767-7da56b3c3af77ac74273d536;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ce4f489a5d83a6513bd3ddac34b38d8c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"PwpI8DxIAKxle8saXXvt81lk1Dm1Yd2cawvoc-axyXyF5jj7quS4FQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"fa7d3d25-0c9f-40d9-97ef-b38f411895a6"},{"name":"getAcceptedQuickOffer","id":"5982018d-c0bd-43f5-b063-436dd14cf5d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/get-accepted-quick-offer?companyId={{company_id}}","description":"

This endpoint returns an accepted quick offer for a given customer.

Request query params

companyId (string) REQUIRED
The ID of the company you wish to retrieve accepted Quick Offers for.

Response body

offerId (string)
The ID of the offer.

type (string)
Possible values: \"quickOffer\" and \"firmOffer\". This endpoint will only return quick offers.

productName (string)
Possible values: \"floc\" (flexible line of credit) and \"term-loan\".

priority (string)
Possible values: \"primary\" and \"secondary\".

status (string)
The status of the offer. The only possible value is \"DRAFT_ACCEPTED\".

fundingLimit (number)
The funding limit amount.

term (number)
The term duration in months.

percentageFee (number)
Decimal value specific to flexible line of credit (floc).

apr (number)
Decimal value specific to flexible line of credit (floc).

setupFee (number)
Decimal value specific to term loan.

monthlyInterestRate (number)
Decimal value specific to term loan.

monthlyRepaymentAmount (number)
Decimal value representing the monthly repayment amount.

createdAt (datetime)
The date and time when the offer was created.

updatedAt (datetime)
The date and time when the offer was last updated.

\n","urlObject":{"path":["api","v1","origination","get-accepted-quick-offer"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"39b82d39-54a9-4a54-9923-38d5fd99727c","name":"getAcceptedQuickOffer","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/get-accepted-quick-offer?companyId=3090844002002404643","host":["{{baseUrl}}"],"path":["api","v1","origination","get-accepted-quick-offer"],"query":[{"key":"companyId","value":"3090844002002404643"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"404"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 16 May 2023 10:29:23 GMT"},{"key":"x-amzn-RequestId","value":"b3fd2694-b133-4ea8-8a94-27d471dd4d80"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"FAsoZEwXLPEFkPQ="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64635b02-05005d9e49431abd4ab0e387;Sampled=0;lineage=03f05429:0|7054fade:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b8a2d5a6ce8c091b497397f77c25cff6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"2_CcEzHTSd_UJXjj_OI7pD_kZ37D4dwYLiHKlM6sdCo8BlhNNNRGrw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"offerId\": \"3103883377967629916\",\n \"type\": \"quickOffer\",\n \"productName\": \"floc\",\n \"priority\": \"secondary\",\n \"status\": \"DRAFT_ACCEPTED\",\n \"fundingLimit\": 10000,\n \"term\": 12,\n \"percentageFee\": 0.14,\n \"setupFee\": 0,\n \"monthlyInterestRate\": 0,\n \"apr\": 0.14,\n \"monthlyRepaymentAmount\": 950,\n \"createdAt\": \"2023-05-16T10:09:14Z\",\n \"updatedAt\": \"2023-05-16T10:12:38Z\"\n }\n}"}],"_postman_id":"5982018d-c0bd-43f5-b063-436dd14cf5d8"},{"name":"releaseQuickOffers","id":"20dae0d9-77e6-4e5b-bd5d-6ac98113f785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/release-quick-offers","description":"

Endpoint to be called when the quick offers were reviewed, and you are ready to show them to the client. After this call you will no longer be able to update them.

Request body

companyId (string) REQUIRED
The ID of the company for whom you wish to release Quick Offers to.

\n","urlObject":{"path":["api","v1","origination","release-quick-offers"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"c6f81ca4-8c53-49ab-a299-9c1b59f93fc4","name":"releaseQuickOffers","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3055407695034058353\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/release-quick-offers","host":["{{baseUrl}}"],"path":["api","v1","origination","release-quick-offers"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 24 Mar 2023 18:35:08 GMT"},{"key":"x-amzn-RequestId","value":"069dc013-310c-4eb6-9372-5a9263797264"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"CTIGSHkqLPEFsbQ="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-641ded5b-36bb48a649a94f5c67160534;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1679d4f06b5f1d02b9d3d9343e40b5cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"sFc9-1tVlVtiXxLGjB3RWoGVtOpd7Y0KNCT54uh91YjX2-YU9Y8CRQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"20dae0d9-77e6-4e5b-bd5d-6ac98113f785"},{"name":"updateQuickOffer","id":"35f5372a-c778-4ba9-9097-ef9d89cef202","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\",\n \"offerId\": \"3065765420054087383\",\n \"fundingLimit\": 30000,\n \"percentageFee\": 0.13,\n \"apr\": 0.13,\n \"priority\": \"primary\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/update-quick-offer","description":"

Endpoint to update quick offers by overwriting key parameters.

Constraints

This endpoint can be called only if the configuration parameter AUTOMATICALLY_SHOW_QO was set to false when a company was created.
There can be only one primary offer.
APR is calculated automatically and cannot be overwritten.

Request body

companyId (string) REQUIRED
The ID of the offer.

productName (string) REQUIRED
Possible values include floc (flexible line of credit), and term-loan

term (number) REQUIRED
Represents the term length of the loan in months.

fundingLimit (number) REQUIRED
Maximimum amount of funding offered.

priority (string or null) REQUIRED
Denotes the ranking of offers. Used to indicate product appropriateness for the customer. Possible values can include primary or secondary.

Product Specific parameters

FLOC (Flexible Line of Credit)

percentageFee (number, decimal) REQUIRED
Indicates the percentage fee assigned to the FLOC product.

Term Loan

monthlyInterestRate (number, decimal) REQUIRED
Indicates the monthly interest rate charged for the product.

setupFee (number, decimal) REQUIRED
Indicates the setup fee charged for the product.

\n","urlObject":{"path":["api","v1","origination","update-quick-offer"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"487155c2-9f12-4fa1-b1be-38829f61ccd7","name":"updateQuickOffer","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3055407695034058353\",\n \"offerId\": \"3065765420054087383\",\n \"fundingLimit\": 30000,\n \"percentageFee\": 0.13,\n \"apr\": 0.13,\n \"priority\": \"primary\"\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/update-quick-offer","host":["{{baseUrl}}"],"path":["api","v1","origination","update-quick-offer"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 24 Mar 2023 21:14:00 GMT"},{"key":"x-amzn-RequestId","value":"f584dfe0-8ef9-480e-9345-67904b1d8729"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"CTfXFH64LPEFxIg="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-641e1293-3939a6d07ecd574e1739277a;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a25f829e86f504a329e71fa3f4d21484.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"8Mr3K9WbVfDhNpV8nzs9EFPYhpUvqwUKCZychYvjIpFOpmk_umDTbg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"35f5372a-c778-4ba9-9097-ef9d89cef202"}],"id":"71c140ca-ab3e-4dde-9709-e6f0d986b1c5","description":"

Quotes, or 'Quick Offers', are provional loan offers. They provide customers with an array of indicative loan offers, based on their funding requests and risk profile, and your configured risk appetite, product catalogue and pricing.

Using advanced data science, in-depth analysis and real-world lending experience Abel provides fast, accurate and compelling quotes. The quotes generated at this stage combine:

Quotes within 50 seconds with limited user-provided data up front to improve conversion
Accurate quotations that are constantly refined by historical trends, live monitoring of loan performance and current market conditionsto to ensure a >85% likelihood of acceptance at firm offer.
A product appropriateness assessment, fulfiling the duty of the lender to make sure that products are suitable and fair. We rank the most suitable borrowing options based on defined client preference and our product suitability hierarchy.

Dependencies for creating a meaningful quick offer are:

Products - pre-configured products and associated pricing information. We have provided two products in the Sandbox for demonstration and testing purposes.
Configured risk parameters per product - you can configure these in the Risk Management section of your Abel console. Defaults have been applied in Sandbox for testing
Customer Data - you must have created a company. We have provided sample data in the Sandbox for testing purposes.

Generating Quick Offers

Follow these steps to generate Quick Offers for your applicant company.

1. Generate Quick Offers

Start the Quick Offer generation process by submitting the Customer ID to the generateQuickOffers endpoint.

2. Await processing confirmation

Quick Offer generation is an asynchronous process. You will receive the response code 200 immediately, and then a webhook event of type ACTION_COMPLETED category RISK and detail {\"companyId\": {{companyId}}, \"action\": \"generate_quick_offers\"} when the action is completed.

3. (OPTIONAL) Review and edit Quick Offers

By setting AUTOMATICALLY_SHOW_QO set to false, quick offers will be not be made available for retrieval until approval has been given.

To do this,

Review draft quick offers via the getOffers endpoint
Make edits to any of the candidate Quick Offers using the updateQuickOffer endpoint.
Once you are happy with the quick offers, you can approve them for release via the releaseQuickOffers endpoint.

By setting AUTOMATICALLY_SHOW_QO set to true, quick offers will be made available for retrieval via the getQuickOffers endpoint.

\n\n

You can retrieve Quick Offers for displaying to your customer or broker using the getQuickOffer endpoint.

5. Accept a Quick Offer

Once a customer has selected the Quick Offer they'd like to progress with, use the acceptQuickOffer. Accepted Quick Offers can be retrieved for other display purposes using the getAcceptedQuickOffer endpoint.

Other features

Adding notes to an application

Notes can be added to an application to document any actions taken by the customer, underwriting or operational teams. You can add and view notes using the various methods in the Notes collection.

View Risk Analysis

Once a Quick Offer has been generated you can review the outcome of the risk models and ruleset evaluation by using the getRiskData API.

\n","_postman_id":"71c140ca-ab3e-4dde-9709-e6f0d986b1c5"},{"name":"Notes","item":[{"name":"getCompanyNotes","id":"08a1803e-40db-4c2c-bbd0-8a4fedd38ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/get-company-notes?companyId={{company_id}}","description":"

Request query parameters

companyId (string) REQUIRED
The ID of the company you wish to retrieve notes from.

Response body

notes (string)
Free text note.

\n","urlObject":{"path":["api","v1","origination","get-company-notes"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"9627ed3e-e8a4-4c8c-8d7b-51d39f9d0b1e","name":"getCompanyNotes","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/get-company-notes?companyId=3055407695034058353","host":["{{baseUrl}}"],"path":["api","v1","origination","get-company-notes"],"query":[{"key":"companyId","value":"3055407695034058353"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"86"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 12 Mar 2023 14:49:27 GMT"},{"key":"x-amzn-RequestId","value":"72101156-6228-48e2-8991-17e6c9a890c8"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BrDyuEMnrPEFrEg="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640de677-3e03caf7475514040465e189;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fc1dbced8ce91560eb48784488ea4384.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"PQxwB-b4nIxN1hJPDSfD4eqBGZCzozGTcE6R8Inlrlen9cpOHZYh6w=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"notes\": \"This is a company note\"\n }\n}"}],"_postman_id":"08a1803e-40db-4c2c-bbd0-8a4fedd38ebb"},{"name":"updateCompanyNotes","id":"6fe63baa-1527-4a3c-ae33-55e4a06a71a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\",\n \"notes\": \"...\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/update-company-notes","description":"

Request body

companyId (string) REQUIRED
The ID of the company you wish to assign a note to.

notes (string) REQUIRED
The free text note you wish to add for this company.

\n","urlObject":{"path":["api","v1","origination","update-company-notes"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"5fdb07d5-2f6d-48af-82da-461abe1aa519","name":"updateCompanyNotes","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3055407695034058353\",\n \"notes\": \"This is a company note\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/update-company-notes","host":["{{baseUrl}}"],"path":["api","v1","origination","update-company-notes"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 12 Mar 2023 14:49:19 GMT"},{"key":"x-amzn-RequestId","value":"4d7f4d1b-32d1-45f4-b373-4a594948cc62"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BrDxaHh6rPEFuqg="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640de66f-2c5cfd9541524a0c499c221e;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fc1dbced8ce91560eb48784488ea4384.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"oGE5_jxw3zJWnS-rjlGld8hCETC01PKUh5N8Ij6uVDdol-NX0ftZRQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"6fe63baa-1527-4a3c-ae33-55e4a06a71a8"},{"name":"getApplicationNotes","id":"35d61c09-27e7-4aab-bb8e-86f45096d080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/get-application-notes?companyId={{company_id}}&applicationId=3049696933443536586","description":"

Request query parameters

companyId (string) REQUIRED
The ID of the company you wish to assign a note to.

applicationId (string) REQUIRED
The ID of the application you wish to assign a note to.

Response body

notes (string)
Free text notes added to the application.

\n","urlObject":{"path":["api","v1","origination","get-application-notes"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"},{"key":"applicationId","value":"3049696933443536586"}],"variable":[]}},"response":[{"id":"0694412a-9e24-4f2b-a104-bfc96aaff8ad","name":"getApplicationNotes","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/get-application-notes?companyId=3055407695034058353&applicationId=3055407695478654581","host":["{{baseUrl}}"],"path":["api","v1","origination","get-application-notes"],"query":[{"key":"companyId","value":"3055407695034058353"},{"key":"applicationId","value":"3055407695478654581"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 12 Mar 2023 14:49:53 GMT"},{"key":"x-amzn-RequestId","value":"21c9a46c-bd31-44c4-b6b3-aa6714c23665"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BrD2tGUJrPEFqcw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640de691-08ce379b3c34e5585a86dfd7;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fc1dbced8ce91560eb48784488ea4384.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"ROhdCAI9AKksrM9xskx6JpWa5E3lSl6d4hf1ccaRsHBCpr3vM11bjg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"notes\": \"This is an application note\"\n }\n}"}],"_postman_id":"35d61c09-27e7-4aab-bb8e-86f45096d080"},{"name":"updateApplicationNotes","id":"3857f922-2e4e-4b17-b6e5-37ad77ecede9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\",\n \"applicationId\": \"3057131806777148500\",\n \"notes\": \"This is an application note\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/origination/update-application-notes","description":"

Request body

companyId (string) REQUIRED
The ID of the company you wish to update a note for.

applicationId (string) REQUIRED
The ID of the application you wish to update a note for.

notes (string) REQUIRED
The free text note you wish to add to the application.

\n","urlObject":{"path":["api","v1","origination","update-application-notes"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"5a7efb00-35e2-4857-9d03-90ef18e11d87","name":"updateApplicationNotes","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3055407695034058353\",\n \"applicationId\": \"3055407695478654581\",\n \"notes\": \"This is an application note\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/origination/update-application-notes","host":["{{baseUrl}}"],"path":["api","v1","origination","update-application-notes"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 12 Mar 2023 14:49:49 GMT"},{"key":"x-amzn-RequestId","value":"4db9e7c3-e48d-4d3f-b978-8479d21d981e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BrD2KEZnrPEFQ4w="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640de68d-56c840f4062432d47c66b79f;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fc1dbced8ce91560eb48784488ea4384.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"yA5WzM3xSUjwnmd5B7VUSMR7mehHHgUPXwvbQgAx8hch3sMcftMbCA=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"3857f922-2e4e-4b17-b6e5-37ad77ecede9"}],"id":"937d24cb-0749-470e-aa2b-578bf53afd8a","description":"

Notes

Store all of the important information about your application in one convienent location.

You can store and retrieve clear text notes about a company and a company application, in a form of a long string, which can be updated. An update will overwrite the previous value of the field.

\n","_postman_id":"937d24cb-0749-470e-aa2b-578bf53afd8a"}],"id":"6654905a-59fd-4d19-96c8-630d29d806e6","description":"

Originate new customers quickly and efficiently. Abel’s origination framework understands the lender with 5 simple questions. Using advanced data science, in-depth analysis and real-world lending experience Abel provides realistic and fast origination offers

Lending profitability starts with originating the right clients for your lending approach

100+ risk parameters that allows you dynamic decision models balance risk, CX and cost
Quotes within 50 seconds with limited questions up front to improve conversion
Accurate quotations that have been proven and are 'tuned' to >85% likelihood of acceptance at full offer
Product recommendation engine that fulfils the duty of the lender to make sure that products are suitable and fair. We rank the most suitable borrowing options

The following APIs allow you to quickly create a quick offer in three steps:

Dependencies for creating a meaningful quick offer are:

Authentication of your API to ensure security
Setup up your Risk parameters in your Abel dashboard - defaults have been applied in Sandbox for testing
Understand the sample data

\n","_postman_id":"6654905a-59fd-4d19-96c8-630d29d806e6"},{"name":"Decisioning","item":[{"name":"Users and Company","item":[{"name":"updateCompany","id":"35031460-4677-4e7b-98dc-9f8c689118fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\",\n \"annualTurnover\": 1000000,\n \"desiredAmount\": 30000,\n \"tradesWithRestrictedCountries\": true,\n \"tradesMostlyAbroad\": false,\n \"tradesOutsideUk\": false,\n \"isSme\": true,\n \"reasonForFunding\": \"Purchase\",\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradingAddress\": \"8 Havelock Drive, Greenhithe, Kent\",\n \"tradingAddressPostcode\": \"DA9 9XU\",\n \"tradingName\": \"Something LTD\",\n \"website\": \"www.test.com\",\n \"declaredBrokerEmail\": \"broker@x.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/update-company","description":"

Endpoint to update provided information for a given company.

Request body

companyId (string): REQUIRED
The Companies House number of the company you wish to create.

annualTurnover (number): OPTIONAL
The annual turnover of the company.

desiredAmount (number): OPTIONAL
The desired funding amount.

tradesWithRestrictedCountries (boolean): OPTIONAL
Indicates whether the company trades with restricted countries.

tradesMostlyAbroad (boolean): OPTIONAL
Indicates whether the company mostly trades abroad.

tradesOutsideUk (boolean): OPTIONAL
Indicates whether the company trades outside the UK.

isSme (boolean): OPTIONAL
Indicates whether the company is an SME (Small and Medium-sized Enterprise).

reasonForFunding (string): OPTIONAL
The reason for funding.

detailedLoanPurpose (string): OPTIONAL
The detailed purpose of the loan.

costPreference (string): OPTIONAL
The customer's repayment preference. Allowed values include: \"lowestMonthlyRepayment\" (default value) and \"lowestTotalRepayment\".

netProfit (number): OPTIONAL
The net profit of the company.

accountEndDate (date): OPTIONAL
The end date of the company's accounting period. Format: YYYY-MM-DD.

accountDepreciation (number): OPTIONAL
The depreciation amount in the company's accounts.

accountAmortisation (number): OPTIONAL
The amortisation amount in the company's accounts.

otherAccountOperatingIncome (number): OPTIONAL
The operating income from other accounts.

tradingAddress (string): OPTIONAL
The trading address of the company.

tradingAddressPostcode (string): OPTIONAL
The postcode of the trading address.

tradingName (string): OPTIONAL
The trading name of the company.

website (string): OPTIONAL
The website URL of the company.

declaredBrokerEmail (string): OPTIONAL
The email address of the declared broker.

\n","urlObject":{"path":["api","v1","decisioning","update-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"e797aad9-32a2-4171-a866-fd007e9a3a54","name":"updateCompany","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3055356223458117123\",\n \"annualTurnover\": 1000000,\n \"desiredAmount\": 30000,\n \"tradesWithRestrictedCountries\": false,\n \"tradesMostlyAbroad\": false,\n \"tradesOutsideUk\": false,\n \"isSme\": true,\n \"reasonForFunding\": \"Purchase\",\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradingAddress\": \"8 Havelock Drive, Greenhithe, Kent\",\n \"tradingAddressPostcode\": \"DA9 9XU\",\n \"tradingName\": \"Something LTD\",\n \"website\": \"www.test.com\",\n \"declaredBrokerEmail\": \"broker@x.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/update-company"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 11:16:35 GMT"},{"key":"x-amzn-RequestId","value":"7e8dd18b-235a-42d6-a188-5add489f5458"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"Bj-u8FapLPEFphg="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b1192-13faa7687161dc6b345f5741;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b78cc6d01d4e7856002e813febd954e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"CDG50-C1"},{"key":"X-Amz-Cf-Id","value":"ECi2Imc5H-oE-DuTA0ms3wC6yk02oqvAn-Rc6sd9W1gHcxWaBVtuQw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"35031460-4677-4e7b-98dc-9f8c689118fd"},{"name":"getCompany","id":"4e001896-f7d7-44ac-8eb1-9b0a2de5cf84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/get-company?companyId={{company_id}}","description":"

Retrieves all data for a given company.

Request query parameters

companyId (string) REQUIRED

The ID of the company.

Response body

companyId (string)
The ID of the company.

name (string)
The name of the company.

companyHouseNo (string)
The Companies House number of the company.

registeredAddress (string)
The registered address of the company.

tradingAddress (string)

The trading address of the company.

website (string)
The website URL of the company.

registeredAddressPostcode (string)

The postcode of the registered address.

tradingAddressPostcode (string)
The postcode of the trading address.

companyStatus (string)

The status of the company.

sicCodes (array)

An array of SIC codes associated with the company.

incorporationDate (string)

The date of incorporation of the company.

tradingName (string)

The trading name of the company.

type (string)

The type of the company.

createdAt (datetime):

The date and time when the company was created in the Abel system.

industry (array)

An array of industries associated with the company.

reasonForFunding (string)

The reason for the funding application.

updatedAt (datetime)
The date and time when the company information was last updated.

desiredAmount (number): The desired funding amount.

tradesWithRestrictedCountries (boolean)

Indicates whether the company trades with restricted countries, as defined in the Risk Management configuration.

tradesMostlyAbroad (boolean)

Indicates whether the company mostly trades abroad.

isSme (boolean)

Indicates whether the company is an SME (Small and Medium-sized Enterprise).

costPreference (string)

The customer's repayment preference.

detailedLoanPurpose (string)

The detailed purpose of the loan.

declaredBrokerEmail (string)

The email address of the declared broker.

annualTurnover (number)

The annual turnover of the company.

primaryUserId (string)

The ID of the primary user associated with the company.

netProfit (number)

The net profit of the company.

accountEndDate (date)

The end date of the company's accounting period. Format: YYYY-MM-DD.

accountDepreciation (number)

The depreciation amount in the company's accounts.

accountAmortisation (number)

The amortisation amount in the company's accounts.

otherAccountOperatingIncome (number)

The operating income from other accounts.

tradesOutsideUk (boolean)

Indicates whether the company trades outside the UK.

\n","urlObject":{"path":["api","v1","decisioning","get-company"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"04abb19c-74c9-40e6-95fa-8b1aaa861cfc","name":"getCompany","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/decisioning/get-company?companyId=3055407695034058353","host":["{{baseUrl}}"],"path":["api","v1","decisioning","get-company"],"query":[{"key":"companyId","value":"3055407695034058353"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1233"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 19:22:04 GMT"},{"key":"x-amzn-RequestId","value":"23c303e9-ad88-426d-aa8e-e4066076d315"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BlF02FTwLPEF14A="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b8351-50a0396f03af4f361c76dd4f;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 38f98563ce0383d146e2eef6f867b714.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"CDG50-C1"},{"key":"X-Amz-Cf-Id","value":"Ro7r0SJZFlZ2epH5_cpEQt9Ls9GQZ5JlsSMAwRRPZuz6qfZ7p3ymiQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"companyId\": \"3055407695034058353\",\n \"name\": \"SAUK UTILITIES LIMITED\",\n \"companiesHouseNumber\": \"07979499\",\n \"registeredAddress\": \"175 Rotherham Road, Barnsley\",\n \"tradingAddress\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"website\": \"www.test.com\",\n \"registeredAddressPostcode\": \"S71 2LG\",\n \"tradingAddressPostcode\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"companyStatus\": \"SIGNUP_INCOMPLETE\",\n \"sicCodes\": [\n \"43999\"\n ],\n \"incorporationDate\": null,\n \"tradingName\": \"SAUK UTILITIES LIMITED\",\n \"type\": \"ltd\",\n \"createdAt\": \"2023-03-10T12:56:42.332Z\",\n \"industry\": [\n \"Other specialised construction activities n.e.c.\"\n ],\n \"reasonForFunding\": \"Making a purchase\",\n \"updatedAt\": \"2023-03-10T12:56:42.332Z\",\n \"desiredAmount\": 10000,\n \"tradesWithRestrictedCountries\": false,\n \"tradesMostlyAbroad\": false,\n \"isSme\": true,\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"detailedLoanPurpose\": \"Car\",\n \"declaredBrokerEmail\": \"broker@x.com\",\n \"annualTurnover\": 1000000,\n \"primaryUserId\": \"3055408741311579773\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradesOutsideUk\": false\n }\n}"}],"_postman_id":"4e001896-f7d7-44ac-8eb1-9b0a2de5cf84"},{"name":"updateUser","id":"07c17391-7ab6-4f6f-8254-41e97f3d7581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"{{user_id}}\",\n \"companyId\": \"{{company_id}}\",\n \"phone\": \"07656789876\",\n \"address\": \"65 Havelock Drive, Greenhithe, Kent\",\n \"postcode\": \"DA9 9XU\",\n \"dateOfBirth\": \"1983-01-02\",\n \"role\": \"director\",\n \"occupation\": \"CTO\",\n \"ukResidencyAboveTwoYears\": false,\n \"requireSoftKycCheck\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/update-user","description":"

Updates the information stored for a given user.

Request body

userId (string) REQUIRED
The ID of the user.

companyId (string): REQUIRED
The ID of the company.

phone (string): OPTIONAL
The phone number associated with the user.

address (string):
The user's address in the following format: {line_1}, {line_2}, {line_3}, {line_4}, {town_or_city}, {locality}, {county}, {country}. Line 1 and town/city are OPTIONAL.

postcode (string): OPTIONAL
The postcode associated with the user's address.

dateOfBirth (date): OPTIONAL
The date of birth of the user, in the format YYYY-MM-DD. The year and month must match the Companies House data of the director.

role (string): OPTIONAL
The role or position of the user.

occupation (string): OPTIONAL
The occupation or job title of the user.

ukResidencyAboveTwoYears (boolean): OPTIONAL
Indicates whether the user has been a UK resident for more than two years.

requireSoftKycCheck (boolean): OPTIONAL
Indicates whether a soft KYC check is required. Note that this parameter does not work for a primary user, as a hard KYC check is mandatory for them.

\n","urlObject":{"path":["api","v1","decisioning","update-user"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b06cfc77-2829-4865-acf4-44c62e9b5394","name":"updateUser","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"3055408746655123073\",\n \"companyId\": \"3055356223458117123\",\n \"phone\": \"07656789876\",\n \"address\": \"65 Havelock Drive, Greenhithe, Kent\",\n \"postcode\": \"DA9 9XU\",\n \"dateOfBirth\": \"1975-08-02\",\n \"role\": \"director\",\n \"occupation\": \"CTO\",\n \"ukResidencyAboveTwoYears\": false,\n \"requireSoftKycCheck\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/update-user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 15:49:56 GMT"},{"key":"x-amzn-RequestId","value":"9cf93e5a-44a5-4bb0-a2f8-07aaa4090d6e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BkmxmEuSLPEFvfw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b51a3-601238141b3f38f8457717af;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0f34c0d3b0e50b8875bcbb7d41684a58.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"AMS54-C1"},{"key":"X-Amz-Cf-Id","value":"eOaBoXdOocLS9XvRwkVVd-vKdM4poDD_j8F5Rp2GLTH3UjElRQqVtQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"07c17391-7ab6-4f6f-8254-41e97f3d7581"},{"name":"getUser","id":"c45deba5-66c2-48be-a463-f10c1bf33446","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/get-user?userId={{user_id}}&companyId={{company_id}}","description":"

Retrieves information on a given user.

Request query params

userId (string) REQUIRED
The ID of the user.

companyId (string) REQUIRED
The ID of the company.

Response body

email (string)
The email address associated with the user.

dateOfBirth (date)
The date of birth of the user, in the format YYYY-MM-DD.

phone (string)
The phone number associated with the user.

address (string)
The user's address.

postcode (string)
The postcode associated with the user's address.

role (string)
The role or position of the user.

occupation (string)
The occupation or job title of the user.

firstName (string)
The first name of the user.

lastName (string)
The last name of the user.

residencyAboveTwoYears (boolean)
Indicates whether the user has been a resident for more than two years.

requireSoftKycCheck (boolean)
Indicates whether a soft KYC check is required.

status (string)
The status of the user.

\n","urlObject":{"path":["api","v1","decisioning","get-user"],"host":["{{baseUrl}}"],"query":[{"key":"userId","value":"{{user_id}}"},{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"d9cafe76-f09a-475c-9ba4-674f117dbb10","name":"getUser","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/decisioning/get-user?userId=3055356561384801803&companyId=3055356223458117123","host":["{{baseUrl}}"],"path":["api","v1","decisioning","get-user"],"query":[{"key":"userId","value":"3055356561384801803"},{"key":"companyId","value":"3055356223458117123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"419"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Mar 2023 11:19:12 GMT"},{"key":"x-amzn-RequestId","value":"2544b961-d4be-42dd-b5ac-aba419e48af0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"Bj_HnF9ILPEFgkA="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640b1230-68db8df03832127a033e4b78;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b78cc6d01d4e7856002e813febd954e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"CDG50-C1"},{"key":"X-Amz-Cf-Id","value":"leied3u95eB-HJCTmf_pzFPX9JA32VGUm8dsyYZiAIm9FcBXPhIHUg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"userId\": \"3055356561384801803\",\n \"email\": \"customer1@beabel.io\",\n \"dateOfBirth\": \"1982-04-02\",\n \"phone\": \"07656789876\",\n \"address\": \"65 Havelock Drive, Greenhithe, Kent\",\n \"role\": \"director\",\n \"occupation\": \"CTO\",\n \"firstName\": \"Waqas\",\n \"lastName\": \"IQBAL\",\n \"postcode\": \"DA9 9XU\",\n \"ukResidencyAboveTwoYears\": false,\n \"requireSoftKycCheck\": false,\n \"status\": \"SIGNUP_INCOMPLETE\"\n }\n}"}],"_postman_id":"c45deba5-66c2-48be-a463-f10c1bf33446"}],"id":"02d60a07-ce3f-4e42-9bd2-44078dd65023","description":"

All Abel decisions are based on Companies and Users. As you progress during your loan decision journey with a customer, you are likely to find out more information about them. Use the updateCompany and updateUser APIs to add to your knowledge of the customer.

You can use any of Abel’s toolkit and modules by simply creating a Company and a User.

\n","_postman_id":"02d60a07-ce3f-4e42-9bd2-44078dd65023"},{"name":"Uploads","item":[{"name":"getUploadUrl","event":[{"listen":"test","script":{"id":"d35dab69-f288-4255-a843-a241a8a6caf4","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"signedUrl\", jsonData.result.uploadUrl);"],"type":"text/javascript"}}],"id":"e378e6d2-8ec0-415f-9412-cdb9288a9c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"bank-statements\",\n \"fileName\": \"2021_May_Statement.pdf\",\n \"companyId\": \"{{company_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/get-upload-url","description":"

Request body

companyId (string) REQUIRED
The ID of the company.

type (string) REQUIRED
The type of the file. Allowed values include \"bank-statements\", \"financial-accounts\", and \"other\".

filename (string) REQUIRED
The name of the file.

Response body

uploadUrl
The URL where the file can be uploaded.

\n","urlObject":{"path":["api","v1","decisioning","get-upload-url"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"baa6ddb1-1ddc-4112-9ddf-0d8816158d13","name":"getUploadUrl","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"bank-statements\",\n \"fileName\": \"2021_May_Statement.pdf\",\n \"companyId\": \"3055356223458117123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/get-upload-url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1549"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 12 Mar 2023 15:06:08 GMT"},{"key":"x-amzn-RequestId","value":"6921e945-75c1-4189-889a-9e6e738c60b2"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BrGNlGc0LPEFZbw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640dea56-679eba523377007b6e3ed70c;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 699b505ca4c2135b52633ef9f9cd2ac0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"HKY2rp3R7g6MCRZ7a9nALc2clVXcqTP91E2hURz-b1SHZ6iHmC1umA=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"uploadUrl\": \"https://dev-company-uploads-90a151a.s3.eu-west-2.amazonaws.com/test982/3055407695034058353/3055407695478654581/bank-statements/2021_May_Statement.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6JLRQTX7JPUUA3A4%2F20230312%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230312T150608Z&X-Amz-Expires=300&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEO%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMiJHMEUCIQD08HlFluBQuT0XAcjz19SIeB6FL7O2Ndfzo95Lmps76wIgAYk4OBVbAoZhgOUMnqQ0ZscgOZe5JY%2FJA49nRs1L%2Fq8qqAMIqP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw5ODIxNzQ5NjUyNDYiDISnin%2B5OPjMdFa2Uyr8AsxBbnxtENyqcCihtFUv5FRn3ISPip%2BgiXvufNWJ0aEQXatlAPXfYrmy5y88JJVPAkfKk21bCkDLYVqe3WqlhAZ%2Bc4luDJX%2FoMBemCk4VAiYK4lCSE%2Fq0MYUZBa1AUFOZ11KTxN%2FUruJ4EOik3L7zYjzy1gagl%2F4Xvr%2B0gKyUEBNr0akVa5P5e9m3VSCeyQ0I4nntK4s0sJLg3cRDQKVYnriDP1x3oA03arpUVHCUotOLlcOUrnhc7U5wVDemsyRr2iRUpkJeizLG1tK%2B9vprEd%2FwhDqxNi4QgBUvLZdBqWXhVTNUgYJFThj%2FKvx0dplSeexb3mr61tuMjZ5DLOwaAIa4wjajV7iEnCUyS%2Fqe%2Fa3JmRY%2BiL2BPHQvmNTMX2xe%2BllnRXltuJKgGOLrUB253xgr%2BVVJ6Q6hYzxq7yq4Ol%2Bs%2FfPtcdMkJKQSsiivnp69hud5qsxIEKV6WY3ontxqwpfwI%2FlzfHy4MkJXZqW5jq2jpf5yLuyfT12lV5TMNzUt6AGOp0BlzwHNIouuL0ZK7fOw%2Bt%2FsbBeIuweG4xVrWDXwl7OrWM45KbWISda8lRk8T2uOf%2F5LYrpnywE0doVt9wUq3sCoyAe9uSi%2BWGJseGLmbGhDLx7L%2BP11%2FI6Mcj3qpWdwe3Iij1%2B8%2FT7fO%2B22aoJoJk1uGv0U3ulhJ8uVOLkb7g02p3bBaLCEPCttLSUec7SRkFENhRZFZx3MlZmrUpg%2Bw%3D%3D&X-Amz-Signature=bfeec45055b032c9506422b599ee3f8f87098785f610a3720944aac4b7197011&X-Amz-SignedHeaders=host\"\n }\n}"}],"_postman_id":"e378e6d2-8ec0-415f-9412-cdb9288a9c51"},{"name":"uploadFile","id":"0da03be0-ff20-47b6-b23b-029c3d151d97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"file","file":{"src":"/Users/rybinska/Downloads/test_accounts.pdf"}},"url":"{{signedUrl}}","description":"

This is a PUT request directly to the AWS S3 API. The URL is returned by the previous endpoint, getUploadUrl. Upload a binary file to this URL.

\n","urlObject":{"host":["{{signedUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0da03be0-ff20-47b6-b23b-029c3d151d97"},{"name":"submitUploadsByType","event":[{"listen":"test","script":{"id":"d35dab69-f288-4255-a843-a241a8a6caf4","exec":[""],"type":"text/javascript"}}],"id":"e85d6110-e436-4792-ac34-f3fed6aa6cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"bank-statements\",\n \"companyId\": \"{{company_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/submit-uploads","description":"

Endpoint to submit uploads by type. Each type needs to be sumbitted separately. After submitting documents you can no longer upload files of a given category.

Submitting documents starts an OCR process. You will receive a webhook request when the process is completed.

Request body

companyId (string) REQUIRED
The ID of the company.

type (string) REQUIRED
The type of the file. Allowed values: \"bank-statements\", \"financial-accounts\", and \"other\".

\n","urlObject":{"path":["api","v1","decisioning","submit-uploads"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"db2f7cbd-764b-4cb7-85d5-520b4117d989","name":"submitUplodsByType","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"financial-accounts\",\n \"companyId\": \"3055356223458117123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/submit-uploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sat, 11 Mar 2023 21:45:39 GMT"},{"key":"x-amzn-RequestId","value":"eaa2be63-b043-4d84-a4fd-a81ee9ffc67e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BotzfF74rPEF4yw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640cf67c-0e90af081ee9bb1242a8c5c4;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 95e5e67fa5d157cb509d06500fad3cc4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"HtObzWO4VPfrvEf6rEqNba7cT2gqR_YmJJAFYY5iDPqC_feOn_jBVg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"e85d6110-e436-4792-ac34-f3fed6aa6cff"},{"name":"getUploadedDocuments","id":"f51fef47-249a-4474-a131-05970a4d68ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/get-uploaded-documents?companyId={{company_id}}","description":"

Endpoint to get a list of uploaded documents.

Request query parameters

companyId (string) REQUIRED
The ID of the company.

Response body

An object of document types, each being an object:

files (array)
An array of file objects.

submitted (datetime)
The date and time when the submission was made.

Each file array contains the following file objects

fileName (string)
The name of the file.

path (string)
The path of the file.

lastModified (datetime)
The date and time when the file was last modified.

downloadUrl (string)
The URL for downloading the file.

submitted (datetime)
The date and time when the submission was made.

\n","urlObject":{"path":["api","v1","decisioning","get-uploaded-documents"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"}],"variable":[]}},"response":[{"id":"8f2d6340-4a13-43ba-933d-04abc708c105","name":"getUploadedDocuments","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/v1/decisioning/get-uploaded-documents?companyId=3055356223458117123","host":["{{baseUrl}}"],"path":["api","v1","decisioning","get-uploaded-documents"],"query":[{"key":"companyId","value":"3055356223458117123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3514"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 12 Mar 2023 22:44:29 GMT"},{"key":"x-amzn-RequestId","value":"f5131e38-cfc8-46d2-8061-83a400122551"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BsJWmF6MLPEFRqw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-640e55c3-218e90a1779dfdfd74bddd92;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a332ecb068a370997b5e7bc811ff54ea.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"c68Pg6YjSBiVu0CglE1_2KmH9P3726vc8HJdUg8yTqbxhDAjPez_IQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"bank-statements\": {\n \"files\": [\n {\n \"fileName\": \"2021_May_Statement.pdf\",\n \"path\": \"test982/3057131806089282640/3057131806777148500/bank-statements/2021_May_Statement.pdf\",\n \"lastModified\": \"2023-03-12T22:03:06.000Z\",\n \"downloadUrl\": \"https://dev-company-uploads-90a151a.s3.eu-west-2.amazonaws.com/test982/3057131806089282640/3057131806777148500/bank-statements/2021_May_Statement.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6JLRQTX7C2WUKBEP%2F20230312%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230312T224429Z&X-Amz-Expires=604800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMiJHMEUCIBaiZRm4N%2FYL3sb5Diu9zI7i9sFDl0zz34S%2FKdXkshktAiEAsfsbNjMAlT3Mc0UK%2FDaSYKit8i6M2jWwIPQnvMdU9o8qngMIsP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw5ODIxNzQ5NjUyNDYiDAi956ukuBxKu6RBmSryAm%2BZuPxr79d1PurpkgucD74dLr5YvrlX384bdTScqji1hZcqrU3nW6lzkcGS03yrTdXZwSY39OnGtZ85z2T3oQDyCUq0tdmtDT4l%2BmFbVNS%2FLBNDs2RsIYnSY3sTmzLCgDcEdmVHRxzQ8DvUzJGjK86kk7M6WMnPlij%2F7Xn3zFe5Wzzdw5uiAYgIopCrXQIjrR4aMuJ7Lbt97qijGVeuvbyjXSBp1%2BNMaUupz7YBxe%2FbQ1ZkOfNKJanRiaz5Bv%2Fh6trt3fErb1S%2BYSpZLsA2XmhHMf5Uz7yTzB%2F6Foyg3gH%2FkRUsXOtkBEHUw0TZFCFNQwsukBAaSAv5YsJ3Mm3Jyqa%2FIh0sxqcJCqKG5vSvgW8139zn0PBcFw8WVJGhBvw37aBQztKMkSAs%2FJBelgoaHENCeGHZR1qKqUKMjiWLLyF9b2oqHuNcNtr1e5d6tlI7v%2FNNP%2BGlNs0Cku5O3e%2Fz4XIr123JUG8L%2FIXqU6RQLKjRCeAwyKu5oAY6nQGO5TlM9%2Bp1Dkwi8ry%2BnTWTVoHytENGWfGlzOi58eoHdYMOICfZr5GlQmt7TpBySTUPNbLMTWXq2r5ukfRD9yNN4lNBDkmhAJQMLIJFCh177o8dIkIyg0wRetw52JQddiYBmCzXj8sJ4ljBkgiOrGqRGmJ%2BArJnGBkEMwR152mVTj7zoNTrviruLNGpdtow%2B%2F6KYwF2bGIm%2BRPhcQJ7&X-Amz-Signature=444af686f4be6816775625487d6d59196920015f38088e27674c90bd01d19a6c&X-Amz-SignedHeaders=host\"\n }\n ],\n \"submitted\": \"2023-03-12T22:24:50.863Z\"\n },\n \"financial-accounts\": {\n \"files\": [\n {\n \"fileName\": \"test_accounts.pdf\",\n \"path\": \"test982/3057131806089282640/3057131806777148500/financial-accounts/test_accounts.pdf\",\n \"lastModified\": \"2023-03-12T22:03:30.000Z\",\n \"downloadUrl\": \"https://dev-company-uploads-90a151a.s3.eu-west-2.amazonaws.com/test982/3057131806089282640/3057131806777148500/financial-accounts/test_accounts.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6JLRQTX7C2WUKBEP%2F20230312%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230312T224429Z&X-Amz-Expires=604800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMiJHMEUCIBaiZRm4N%2FYL3sb5Diu9zI7i9sFDl0zz34S%2FKdXkshktAiEAsfsbNjMAlT3Mc0UK%2FDaSYKit8i6M2jWwIPQnvMdU9o8qngMIsP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw5ODIxNzQ5NjUyNDYiDAi956ukuBxKu6RBmSryAm%2BZuPxr79d1PurpkgucD74dLr5YvrlX384bdTScqji1hZcqrU3nW6lzkcGS03yrTdXZwSY39OnGtZ85z2T3oQDyCUq0tdmtDT4l%2BmFbVNS%2FLBNDs2RsIYnSY3sTmzLCgDcEdmVHRxzQ8DvUzJGjK86kk7M6WMnPlij%2F7Xn3zFe5Wzzdw5uiAYgIopCrXQIjrR4aMuJ7Lbt97qijGVeuvbyjXSBp1%2BNMaUupz7YBxe%2FbQ1ZkOfNKJanRiaz5Bv%2Fh6trt3fErb1S%2BYSpZLsA2XmhHMf5Uz7yTzB%2F6Foyg3gH%2FkRUsXOtkBEHUw0TZFCFNQwsukBAaSAv5YsJ3Mm3Jyqa%2FIh0sxqcJCqKG5vSvgW8139zn0PBcFw8WVJGhBvw37aBQztKMkSAs%2FJBelgoaHENCeGHZR1qKqUKMjiWLLyF9b2oqHuNcNtr1e5d6tlI7v%2FNNP%2BGlNs0Cku5O3e%2Fz4XIr123JUG8L%2FIXqU6RQLKjRCeAwyKu5oAY6nQGO5TlM9%2Bp1Dkwi8ry%2BnTWTVoHytENGWfGlzOi58eoHdYMOICfZr5GlQmt7TpBySTUPNbLMTWXq2r5ukfRD9yNN4lNBDkmhAJQMLIJFCh177o8dIkIyg0wRetw52JQddiYBmCzXj8sJ4ljBkgiOrGqRGmJ%2BArJnGBkEMwR152mVTj7zoNTrviruLNGpdtow%2B%2F6KYwF2bGIm%2BRPhcQJ7&X-Amz-Signature=1d23b4e69e292f8b0b03afce2203ed1c2e82f65cd3cffca10c5ee51c5bfc1f2a&X-Amz-SignedHeaders=host\"\n }\n ],\n \"submitted\": null\n },\n \"other\": {\n \"files\": [],\n \"submitted\": null\n }\n }\n}"}],"_postman_id":"f51fef47-249a-4474-a131-05970a4d68ac"}],"id":"229504bc-4947-4a78-ba65-9349171884b6","description":"

Abel's file upload service can ingest key financial documents, such as financial accounts and bank statments, processing them using OCR technology and feeding into our risk models.

Documents can be uploaded by first retrieving an upload ULR (getUploadURL) and then writing the file to that location in the AWS S3 bucket (uploadFile).

Once all documents of a given type have been uploaded, you can submit these for processing via the submitUploadsByType endpoint.

Note, there is no automated way to upload additional documents once they have been submitted. It is advised that a review is conducted by Operations or the Broking team to ensure the correct documents have been uploaded prior to submission.

Once submitted, the documents will be processed using OCR technology and prepared for further processing. This is an asynchronous process; once complete, a documents-processed event will be triggered, specifying the document type.

The original copy of the documents can also be downloaded for manual underwriting review. They can be accessed by calling the getUploadedDocuments endpoint, and retrieving them from the provided URLs.

Available upload types

financial-accounts
bank-statements
other

\n","_postman_id":"229504bc-4947-4a78-ba65-9349171884b6"},{"name":"Affordability and Risk","item":[{"name":"runAffordabilityProcessing","event":[{"listen":"test","script":{"id":"d35dab69-f288-4255-a843-a241a8a6caf4","exec":[""],"type":"text/javascript"}}],"id":"6a2cc61c-e5bc-4ef6-8e7f-10afa9c4ed6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/run-affordability-processing","description":"

Note, affordability processes can only be run after financial documents have been submitted and processed. Subscribe to the documents-processed event to be notified when all processing has been complete.

Once the customer's financial information has been processed, you can invoke the affordability service by calling the runAffordabilityProcessing endpoint.

This endpoint uses the Abel Affordability models to analyse a customers affordability score, and runs the additional customer information through the risk rulesets to generate the final firm offers.

This process is asynchronous, and you will receive webhook requests for each of the processes

Affordability sheets generation - type ACTION_COMPLETED, category AFFORDABILITY, action generate_affordability_sheets
Firm offer rules - type ACTION_COMPLETED, category RISK, action process_firm_offer_rules

Once the process has completed, you can view the Affordability and rulset results programmatically via the getRiskData endpoint, or download the results in a .csv format via the getAffordabilitySheets endpoint.

Request body

companyId (string): REQUIRED
The Companies House number of the company you wish to create.

\n","urlObject":{"path":["api","v1","decisioning","run-affordability-processing"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"1642426d-7e60-448a-8d98-7a7ac20315b8","name":"runAffordabilityProcessing","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"3055356223458117123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/run-affordability-processing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 14 Mar 2023 13:38:25 GMT"},{"key":"x-amzn-RequestId","value":"ffb2de34-c4e1-4e03-964b-aee54d9b9445"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"BxfQyH60rPEFntQ="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-641078d1-15768a01063ab8a1105fb5e6;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 78a48d8d46b0e5cf69ec8a7f633776e0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"CDG52-P1"},{"key":"X-Amz-Cf-Id","value":"Bd6nluKCVt-4iAfy9FyexssJiRvK1W_xUGif89rwAGE4abdp7zHt0w=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {}\n}"}],"_postman_id":"6a2cc61c-e5bc-4ef6-8e7f-10afa9c4ed6b"},{"name":"getRiskData","id":"729f6c6f-fc38-458f-978e-bfe5701b9fde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"{{baseUrl}}/api/v1/decisioning/get-risk-data?companyId={{company_id}}&offerType=quickOffer","description":"

Endpoint to retrieve the results of the risk rulesets.

Request query parameters

companyId (string) REQUIRED
The ID of the company.

offerType (string) OPTIONAL
The type of offer. Allowed values: \"quickOffer\", \"firmOffer\". Default value: \"quickOffer\".

applicationId (string): OPTIONAL
The ID of the application. If not provided, only the results for the open application will be returned. If there are no open applications, the request will fail.

Response body

If a client doesn't have open application

{\n    \"success\": false,\n    \"message\": \"Open application not found\",\n    \"result\": {}\n}json\n\n

If a Quick Offer is ready to review the enpoint return 2 sections:

Summary section

contains results of 2 base products FastTrack and Standard. The subresults are the same for all products and contains results for all terms 12-60 months.

\n $\"Collapsed%20view%20\"$ \n\n

\n\n

Each term has status ( FAILED or PASSED ) and resuls of the special rules or few rules based on below setings

    summary_elements = {\n        12: [\"Delphi_Cashflow_Score\"],\n        24: [\"Delphi_Cashflow_Score\", \"Minimum_Requested_Amount_24\"],\n        36: [\"Delphi_Cashflow_Score\", \"Minimum_Requested_Amount_36\", \"Max_PD\"],\n        48: [\"Delphi_Cashflow_Score\", \"Minimum_Requested_Amount_48\", \"Max_PD\"],\n        60: [\"Delphi_Cashflow_Score\", \"Minimum_Requested_Amount_60\", \"Max_PD\"],\n    }\n\n

Rules section

Contains results data and base settings for each rule, organised by product variant (e.g. Term) as shown in the image below.

\n\n

Parameters

route (string)
Denotes whether the ruleset relates to standard or fast track approval routes.

value (string)
Declares the results of the rule.

displayName (string)
Name of the rule in human readable format. For use in UI.

ruleName (string)
Name of the rule as declared in the system.

product (string)
Denotes the offer type applicable for this rule object. Valid values include quick_offer and firm_offer

loanPeriod (string)
Denotes the loan periods for which the ruleset is applicable.

passed (boolean)
Declares whether a ruleset criteria has been passed. Valid values are TRUE, if a company has successfully met the rule criteria, or FAILED, if they have not.

ruleType (string)
Denotes the severity of the rule. Valid values include hard or soft.

unitType (string)
Declares the results of the rule.

status (string)
Denotes the status of the rule. Valid values are dependent on rule type. hard rules can have the status PASSED or FAILED; soft rules can have the status PASSED or REFER.

ruleLimit (string)
Denotes the threshold value or setting determining if a rule has passed or failed. Dependent on unitType.

\n\n

More information about details of each ruleset has been described in \"rules\" section in our Risk Documentation.

A full example repsonse is included below:

{\n    \"success\": true,\n    \"message\": \"Success\",\n    \"result\": {\n        \"summary\": {\n            \"FastTrack\": {\n                \"term_12\": {\n                    \"term\": 12,\n                    \"status\": \"PASSED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Delphi Cashflow Score\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        }\n                    ]\n                },\n                \"term_24\": {\n                    \"term\": 24,\n                    \"status\": \"PASSED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Delphi Cashflow Score\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £50.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_24\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                24\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"10000\"\n                        }\n                    ]\n                },\n                \"term_36\": {\n                    \"term\": 36,\n                    \"status\": \"FAILED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Delphi Cashflow Score\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"0.027\",\n                            \"displayName\": \"Probability of Default\",\n                            \"ruleName\": \"Max_PD\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"float\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"0.1\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £100.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_36\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                36\n                            ],\n                            \"passed\": false,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"FAILED\",\n                            \"ruleLimit\": \"100000\"\n                        }\n                    ]\n                },\n                \"term_48\": {\n                    \"term\": 48,\n                    \"status\": \"FAILED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Delphi Cashflow Score\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"0.027\",\n                            \"displayName\": \"Probability of Default\",\n                            \"ruleName\": \"Max_PD\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"float\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"0.1\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £100.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_48\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                48\n                            ],\n                            \"passed\": false,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"FAILED\",\n                            \"ruleLimit\": \"100000\"\n                        }\n                    ]\n                },\n                \"term_60\": {\n                    \"term\": 60,\n                    \"status\": \"FAILED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Delphi Cashflow Score\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"0.027\",\n                            \"displayName\": \"Probability of Default\",\n                            \"ruleName\": \"Max_PD\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12,\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"float\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"0.1\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £100.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_60\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                60\n                            ],\n                            \"passed\": false,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"FAILED\",\n                            \"ruleLimit\": \"100000\"\n                        }\n                    ]\n                }\n            },\n            \"Standard\": {\n                \"term_12\": {\n                    \"term\": 12,\n                    \"status\": \"PASSED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Cashflow score above 8\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                12\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"8\"\n                        }\n                    ]\n                },\n                \"term_24\": {\n                    \"term\": 24,\n                    \"status\": \"PASSED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Cashflow score above 12\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £50.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_24\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                24\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"10000\"\n                        }\n                    ]\n                },\n                \"term_36\": {\n                    \"term\": 36,\n                    \"status\": \"FAILED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Cashflow score above 12\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"0.027\",\n                            \"displayName\": \"PD =< 5%\",\n                            \"ruleName\": \"Max_PD\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"float\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"0.05\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £100.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_36\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                36\n                            ],\n                            \"passed\": false,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"FAILED\",\n                            \"ruleLimit\": \"100000\"\n                        }\n                    ]\n                },\n                \"term_48\": {\n                    \"term\": 48,\n                    \"status\": \"FAILED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Cashflow score above 12\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"0.027\",\n                            \"displayName\": \"PD =< 5%\",\n                            \"ruleName\": \"Max_PD\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"float\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"0.05\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £100.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_48\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                48\n                            ],\n                            \"passed\": false,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"FAILED\",\n                            \"ruleLimit\": \"100000\"\n                        }\n                    ]\n                },\n                \"term_60\": {\n                    \"term\": 60,\n                    \"status\": \"FAILED\",\n                    \"rules\": [\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"56\",\n                            \"displayName\": \"Cashflow score above 12\",\n                            \"ruleName\": \"Delphi_Cashflow_Score\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                24,\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"12\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\"\n                            ],\n                            \"value\": \"0.027\",\n                            \"displayName\": \"PD =< 5%\",\n                            \"ruleName\": \"Max_PD\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                36,\n                                48,\n                                60\n                            ],\n                            \"passed\": true,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"float\",\n                            \"status\": \"PASSED\",\n                            \"ruleLimit\": \"0.05\"\n                        },\n                        {\n                            \"route\": [\n                                \"Standard\",\n                                \"FastTrack\"\n                            ],\n                            \"value\": \"10000.0\",\n                            \"displayName\": \"Minimum loan size £100.000\",\n                            \"ruleName\": \"Minimum_Requested_Amount_60\",\n                            \"product\": \"quick_offer\",\n                            \"loanPeriods\": [\n                                60\n                            ],\n                            \"passed\": false,\n                            \"ruleType\": \"hard\",\n                            \"unitType\": \"number\",\n                            \"status\": \"FAILED\",\n                            \"ruleLimit\": \"100000\"\n                        }\n                    ]\n                }\n            }\n        },\n        \"rules\": [\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Company_Active\",\n                \"unitType\": \"text\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"active\",\n                \"displayName\": \"Company is active\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"active\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Director_Insolvency\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"False\",\n                \"displayName\": \"No directorships linked to insolvent businesses in Last 2yrs\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"No_Phoenix_Company_in_last_2-5_Years\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"False\",\n                \"displayName\": \"No Phoenix Company in last 2-5 Years\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Accounts_filing\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2022-05-04\",\n                \"displayName\": \"Accounts filing in L36M\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"2020-05-05\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Accounts_filing\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2022-05-04\",\n                \"displayName\": \"Accounts filing in L18M'-alert(1)-'\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"2021-11-03\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Director_Insolvency_2_5_Years\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"False\",\n                \"displayName\": \"Director Insolvency 2-5 Years\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Account_filings_counter\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"4\",\n                \"displayName\": \"At least 2 Account filings\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"2\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Legal_Entity_LTD\",\n                \"unitType\": \"text\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"ltd\",\n                \"displayName\": \"Legal Entity LTD\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"ltd\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Ineligible_Company\",\n                \"unitType\": \"text\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"Not listed\",\n                \"displayName\": \"Ineligible Company Type\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"Not listed\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Account_Exists\",\n                \"unitType\": \"text\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"Account exists\",\n                \"displayName\": \"Account exists\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"Account exists\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Dormant_Accounts_L36M\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"False\",\n                \"displayName\": \"No Dormant Accounts L36M\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"No_Phoenix_Company_2_Years\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"False\",\n                \"displayName\": \"No Phoenix Company 2 Years\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Ineligible_Industry_Type\",\n                \"unitType\": \"text\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"Eligible Industry\",\n                \"displayName\": \"Ineligible Industry Type\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"Eligible Industry\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Company_Country\",\n                \"unitType\": \"range\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"11\",\n                \"displayName\": \"UK Registered Business\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"{\\\"FC\\\",\\\"BR\\\",\\\"NI\\\"}\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Incorporation_Date_Check\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2018-04-04\",\n                \"displayName\": \"Incorporation date of the company\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"2021-11-11\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Incorporation_Date_Check\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2018-04-04\",\n                \"displayName\": \"Incorporation date of the company\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    24\n                ],\n                \"ruleLimit\": \"2020-05-05\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Incorporation_Date_Check\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2018-04-04\",\n                \"displayName\": \"Incorporation date of the company\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    36\n                ],\n                \"ruleLimit\": \"2020-05-05\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Incorporation_Date_Check\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2018-04-04\",\n                \"displayName\": \"Incorporation date of the company\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    48\n                ],\n                \"ruleLimit\": \"2020-05-05\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CH_Incorporation_Date_Check\",\n                \"unitType\": \"days\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"2018-04-04\",\n                \"displayName\": \"Incorporation date of the company\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    60\n                ],\n                \"ruleLimit\": \"2020-05-05\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Dormant_Accounts_L18M\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"False\",\n                \"displayName\": \"No Dormant Accounts L18M\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Minimum_Turnover_Declared\",\n                \"unitType\": \"GBP\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"1000000\",\n                \"displayName\": \"Minimum Turnover Declared\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"100000\"\n            },\n            {\n                \"route\": [\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"CCJ_value_in_L24-L12M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CCJ value in L24-L12M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"1000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Minority_Shareholder_Forbidden_Countries\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Minority shareholder is from Unacceptable Risk country\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Minority_Shareholders_is_from_Risk_Country\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Minority Shareholders is from High Medium Risk Country\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"CAIS_Default_value_in_L12M_24M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CAIS Default value in L12M 24M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"1000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Intercompany_Loans_15_50_Procent\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Intercompany loans 15%-50%\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Intercompany_Loans_Over_50_Procent\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Intercompany Loans Over 50%\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"false\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Majority_Shareholders_Are_Residing_In_The_UK_Holding\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Majority Shareholders Are Residing In The UK - Holding Company\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"true\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Current_Worst_CAIS_Status_Hard\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Current Worst CAIS Status Hard\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"CAIS_Default_value_in_L12M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CAIS Default value in L12M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"100\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Current_Worst_CAIS_Status\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Current Worst CAIS Status\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Positive_Net_Current_Assets\",\n                \"unitType\": \"GBP\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Positive Net Current Assets\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"CAIS_Default_value_in_L24M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CAIS Default value in L24M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"100\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"CAIS_Default_in_L48-L12M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CAIS Default in L48-L12M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"0\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Minimum_Turnover_Credit_Experian\",\n                \"unitType\": \"GBP\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Turnover L12M (Asset Proxy)\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"43000000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Holding_Company_Delphi_score\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Holding Company Delphi score\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"35\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Majority_Shareholder_Is_a_UK_Resident\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Majority Shareholder (>=51%) is a UK resident\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"true\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"UK_Registered_Holding_Company\",\n                \"unitType\": \"range\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"UK Registered Business (Holding company)\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"{\\\"FC\\\",\\\"BR\\\",\\\"NI\\\"}\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Number_Employees\",\n                \"unitType\": \"range_number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Employees Number\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"2-250\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Business_Current_Ratio\",\n                \"unitType\": \"float\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Business Current Ratio\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0.9\"\n            },\n            {\n                \"route\": [\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Delphi_Cashflow_Score\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"56\",\n                \"displayName\": \"Delphi Cashflow Score\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"12\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Minimum_Turnover_Cato\",\n                \"unitType\": \"range_number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Turnover L12M (CATO)\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"100000-50000000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Positive_Shareholder_Equity\",\n                \"unitType\": \"GBP\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Positive Shareholder Equity\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"100\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Bounced_Payments_Last_6M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Bounced payments Last 6M (CATO)\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"2\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Value_CCJs_Last12Months\",\n                \"unitType\": \"GBP\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CCJ Value in last 12M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"1000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Commercial_Arrears_In_L12M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"Commercial arrears in last 12 Months\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"2\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Value_CCJs_Last24Months\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CCJ Value in last 24M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"100\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"CCJ_value_in_L24-L12M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CCJ value in L24-L12M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"100\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"CCJ_value_in_L24M\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CCJ value in L24M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"1000\"\n            },\n            {\n                \"route\": [\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Value_CCJs_Last12Months\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"-\",\n                \"displayName\": \"CCJ Value in last 12M\",\n                \"status\": \"NOT_RUN\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"1000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Delphi_Cashflow_Score\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"56\",\n                \"displayName\": \"Cashflow score above 8\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12\n                ],\n                \"ruleLimit\": \"8\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Delphi_Cashflow_Score\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"56\",\n                \"displayName\": \"Cashflow score above 12\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"12\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Commercial_Delphi_Score\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"40\",\n                \"displayName\": \"CAIS Delphi score\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"30\"\n            },\n            {\n                \"route\": [\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Commercial_Delphi_Score\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"40\",\n                \"displayName\": \"CAIS Delphi score\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"17\"\n            },\n            {\n                \"route\": [\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Max_Fast_Track_Amount\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"10000.0\",\n                \"displayName\": \"Max Fast Track Amount\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"100000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Minimum_Requested_Amount_24\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"10000.0\",\n                \"displayName\": \"Minimum loan size £50.000\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    24\n                ],\n                \"ruleLimit\": \"10000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Minimum_Requested_Amount_36\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"10000.0\",\n                \"displayName\": \"Minimum loan size £100.000\",\n                \"status\": \"FAILED\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    36\n                ],\n                \"ruleLimit\": \"100000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Minimum_Requested_Amount_48\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"10000.0\",\n                \"displayName\": \"Minimum loan size £100.000\",\n                \"status\": \"FAILED\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    48\n                ],\n                \"ruleLimit\": \"100000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Minimum_Requested_Amount_60\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"10000.0\",\n                \"displayName\": \"Minimum loan size £100.000\",\n                \"status\": \"FAILED\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    60\n                ],\n                \"ruleLimit\": \"100000\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Application_Data_Net_Profit\",\n                \"unitType\": \"number\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"500000\",\n                \"displayName\": \"Application Data Net Profit\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0\"\n            },\n            {\n                \"route\": [\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"Max_PD\",\n                \"unitType\": \"float\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"0.027\",\n                \"displayName\": \"Probability of Default\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0.1\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Max_PD\",\n                \"unitType\": \"float\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"0.027\",\n                \"displayName\": \"PD =< 5%\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0.05\"\n            },\n            {\n                \"route\": [\n                    \"Standard\"\n                ],\n                \"ruleName\": \"Lead_Scoring_Rule\",\n                \"unitType\": \"float\",\n                \"ruleType\": \"hard\",\n                \"product\": \"quick_offer\",\n                \"value\": \"No Data\",\n                \"displayName\": \"Lead Scoring Rule\",\n                \"status\": \"REFER\",\n                \"passed\": false,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"0.067\"\n            },\n            {\n                \"route\": [\n                    \"Standard\",\n                    \"FastTrack\"\n                ],\n                \"ruleName\": \"All_Directors_UK_Residents\",\n                \"unitType\": \"boolean\",\n                \"ruleType\": \"soft\",\n                \"product\": \"quick_offer\",\n                \"value\": \"True\",\n                \"displayName\": \"All directors are UK residents\",\n                \"status\": \"PASSED\",\n                \"passed\": true,\n                \"loanPeriods\": [\n                    12,\n                    24,\n                    36,\n                    48,\n                    60\n                ],\n                \"ruleLimit\": \"true\"\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"path":["api","v1","decisioning","get-risk-data"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"},{"key":"offerType","value":"quickOffer"}],"variable":[]}},"response":[],"_postman_id":"729f6c6f-fc38-458f-978e-bfe5701b9fde"},{"name":"getAffordabilitySheets","id":"d4a947e7-2da1-424a-b2f2-375b98a269d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"{{baseUrl}}/api/v1/decisioning/get-affordability-sheets?companyId={{company_id}}&versions=true","description":"

An endpoint to retrieve affordability analysis of a given customer in a .csv file format.

Request query parameters

companyId (string) REQUIRED
The ID of the company.

applicationId (string): OPTIONAL
If provided, it will only return the result for this specific application.

versions (boolean): OPTIONAL
If set to true, all versions of the sheets will be returned.

Response body

The response is an object where the keys are applicationIds, and the values are arrays of sheet objects.

A sheet object contains the following properties:

filename (string)
The name of the sheet.

lastModified (datetime)
The date and time when the sheet was last modified.

size (number)
The size of the sheet.

downloadLink (string)
The URL for downloading the sheet.

versions (array)
An array containing versions of the sheet.

\n","urlObject":{"path":["api","v1","decisioning","get-affordability-sheets"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"},{"key":"versions","value":"true"}],"variable":[]}},"response":[{"id":"6f103cfd-9cc2-4f79-a20c-e622d1108ec8","name":"getAffordabilitySheets","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/decisioning/get-affordability-sheets?companyId=3055356223458117123&versions=false&applicationId=3058291873903806406","host":["{{baseUrl}}"],"path":["api","v1","decisioning","get-affordability-sheets"],"query":[{"key":"companyId","value":"3055356223458117123"},{"key":"versions","value":"false"},{"key":"applicationId","value":"3058291873903806406"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4622"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 14 Mar 2023 16:13:27 GMT"},{"key":"x-amzn-RequestId","value":"e30b2168-9978-41d6-b547-6ec8eb183dd5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"Bx1-EFfOrPEFyhw="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64109d26-69ed1a1e66667e4b7fa68244;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a8f77777c0752dad31367fbd24424a90.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"iNY1BFoQoSK8OluepXJbyxAG5BZXn04rGwsLDmVDep9ayRwZuLJfmQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": {\n \"3058291873903806406\": [\n {\n \"filename\": \"AffordabilityfromP&LProposal.xlsx\",\n \"lastModified\": \"2023-03-14T13:38:53+00:00\",\n \"size\": 120341,\n \"downloadLink\": \"https://dev-company-sheets-90a151a.s3.amazonaws.com/test982/3058291873106888642/3058291873903806406/AffordabilityfromP%26LProposal.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6JLRQTX7CP67IXK5%2F20230314%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230314T161327Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECAaCWV1LXdlc3QtMiJHMEUCIQD1a6OqkowhVVlSRvO6j3OwP3YMUFFFkg3Qz5f%2FPvBYJAIgNZWfuJF3wJVvUJBHuN4XWn8uPVaWf2oWeyn4iQGegAAqlgMI2f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw5ODIxNzQ5NjUyNDYiDD0OaDxWWhoIZjcdmirqAvyEmaxHVLwkAsuGG4%2FHMUx1rZgJvbG7r7O4cDZlvBqji9EkCR3gOyIzQnQjvzU21LvCOV3q1htSPnnWaJ3vcFGyQbTS3lN0n6fCcew9vH0zQAkNRbU%2Baw28LYY91jNgVAbheT70qXV9KLjun3Vqq5JsUQVDszwIJNELtI2fJBJIwoNcQMSyNs9ZjeaNTRWRNUGYLWKUE%2FGVovlfvuw5c%2FheQbsQO6Vh806ZBrz%2Fm6HLJQXOcKivN0fYVWi2umklJaED2BOw8CVXKVXNXMJtPNhYAsHnxQP5BveYB1NAyz%2FQ0K0lM8ly%2BaKvwEMz%2BeBk5IT%2BftGmqCMRkK5hWHwczjAJIKeLYvVVd1O%2BCwE9GzIYtklSCQyiB%2By5NxxCR92Ndcs%2BmITfABCUkEc0RRrd4LqMrr41pXuTTY%2BwfXGyQqMRTWfIqCKGEhzi2pNnXS4kJ3gwMoWZYIHa8%2BMAIdAEDrnrPg1Z4wCKT8BOMMumwqAGOp0BjQ5lV2zhZJRwy2%2F0vSQMXZwWtoIyjIrE9iXB4YWTGKHU19x6YhuGgN3P6YghFT5E5v0SXWPhRETM6h9HQx6p2fReWf7IMwmjJqb5MScdPHAFNsckWlVChOyIVexdWSPJTV0Tz7AVBt4NhCSogZd47r0YqjuY8Ig1uaTpVbOvOz0o3y1ynOBoYQXUyqNS%2B8rWQgwirG2WCVYXaYJT5w%3D%3D&X-Amz-Signature=e76d69dbdb192a8e18677b29358a1bb46fc7a4dbac09632855c6ced0db59cb91\",\n \"versions\": []\n },\n {\n \"filename\": \"KYCKYBChecklist.xlsx\",\n \"lastModified\": \"2023-03-14T13:38:55+00:00\",\n \"size\": 93496,\n \"downloadLink\": \"https://dev-company-sheets-90a151a.s3.amazonaws.com/test982/3058291873106888642/3058291873903806406/KYCKYBChecklist.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6JLRQTX7CP67IXK5%2F20230314%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230314T161327Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECAaCWV1LXdlc3QtMiJHMEUCIQD1a6OqkowhVVlSRvO6j3OwP3YMUFFFkg3Qz5f%2FPvBYJAIgNZWfuJF3wJVvUJBHuN4XWn8uPVaWf2oWeyn4iQGegAAqlgMI2f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw5ODIxNzQ5NjUyNDYiDD0OaDxWWhoIZjcdmirqAvyEmaxHVLwkAsuGG4%2FHMUx1rZgJvbG7r7O4cDZlvBqji9EkCR3gOyIzQnQjvzU21LvCOV3q1htSPnnWaJ3vcFGyQbTS3lN0n6fCcew9vH0zQAkNRbU%2Baw28LYY91jNgVAbheT70qXV9KLjun3Vqq5JsUQVDszwIJNELtI2fJBJIwoNcQMSyNs9ZjeaNTRWRNUGYLWKUE%2FGVovlfvuw5c%2FheQbsQO6Vh806ZBrz%2Fm6HLJQXOcKivN0fYVWi2umklJaED2BOw8CVXKVXNXMJtPNhYAsHnxQP5BveYB1NAyz%2FQ0K0lM8ly%2BaKvwEMz%2BeBk5IT%2BftGmqCMRkK5hWHwczjAJIKeLYvVVd1O%2BCwE9GzIYtklSCQyiB%2By5NxxCR92Ndcs%2BmITfABCUkEc0RRrd4LqMrr41pXuTTY%2BwfXGyQqMRTWfIqCKGEhzi2pNnXS4kJ3gwMoWZYIHa8%2BMAIdAEDrnrPg1Z4wCKT8BOMMumwqAGOp0BjQ5lV2zhZJRwy2%2F0vSQMXZwWtoIyjIrE9iXB4YWTGKHU19x6YhuGgN3P6YghFT5E5v0SXWPhRETM6h9HQx6p2fReWf7IMwmjJqb5MScdPHAFNsckWlVChOyIVexdWSPJTV0Tz7AVBt4NhCSogZd47r0YqjuY8Ig1uaTpVbOvOz0o3y1ynOBoYQXUyqNS%2B8rWQgwirG2WCVYXaYJT5w%3D%3D&X-Amz-Signature=c54ebbebf8e3e8dd808ae0aeba4ed6d1c10b584a37c25eadb0a6dee77d57241a\",\n \"versions\": []\n },\n {\n \"filename\": \"UWTemplateNewChecklist.xlsx\",\n \"lastModified\": \"2023-03-14T13:38:57+00:00\",\n \"size\": 81878,\n \"downloadLink\": \"https://dev-company-sheets-90a151a.s3.amazonaws.com/test982/3058291873106888642/3058291873903806406/UWTemplateNewChecklist.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6JLRQTX7CP67IXK5%2F20230314%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230314T161327Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECAaCWV1LXdlc3QtMiJHMEUCIQD1a6OqkowhVVlSRvO6j3OwP3YMUFFFkg3Qz5f%2FPvBYJAIgNZWfuJF3wJVvUJBHuN4XWn8uPVaWf2oWeyn4iQGegAAqlgMI2f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw5ODIxNzQ5NjUyNDYiDD0OaDxWWhoIZjcdmirqAvyEmaxHVLwkAsuGG4%2FHMUx1rZgJvbG7r7O4cDZlvBqji9EkCR3gOyIzQnQjvzU21LvCOV3q1htSPnnWaJ3vcFGyQbTS3lN0n6fCcew9vH0zQAkNRbU%2Baw28LYY91jNgVAbheT70qXV9KLjun3Vqq5JsUQVDszwIJNELtI2fJBJIwoNcQMSyNs9ZjeaNTRWRNUGYLWKUE%2FGVovlfvuw5c%2FheQbsQO6Vh806ZBrz%2Fm6HLJQXOcKivN0fYVWi2umklJaED2BOw8CVXKVXNXMJtPNhYAsHnxQP5BveYB1NAyz%2FQ0K0lM8ly%2BaKvwEMz%2BeBk5IT%2BftGmqCMRkK5hWHwczjAJIKeLYvVVd1O%2BCwE9GzIYtklSCQyiB%2By5NxxCR92Ndcs%2BmITfABCUkEc0RRrd4LqMrr41pXuTTY%2BwfXGyQqMRTWfIqCKGEhzi2pNnXS4kJ3gwMoWZYIHa8%2BMAIdAEDrnrPg1Z4wCKT8BOMMumwqAGOp0BjQ5lV2zhZJRwy2%2F0vSQMXZwWtoIyjIrE9iXB4YWTGKHU19x6YhuGgN3P6YghFT5E5v0SXWPhRETM6h9HQx6p2fReWf7IMwmjJqb5MScdPHAFNsckWlVChOyIVexdWSPJTV0Tz7AVBt4NhCSogZd47r0YqjuY8Ig1uaTpVbOvOz0o3y1ynOBoYQXUyqNS%2B8rWQgwirG2WCVYXaYJT5w%3D%3D&X-Amz-Signature=15e37837ae0b676a21ac23c2f97d60d3ec2289d8c369c8da6c5419078fc439c9\",\n \"versions\": []\n }\n ]\n }\n}"}],"_postman_id":"d4a947e7-2da1-424a-b2f2-375b98a269d4"}],"id":"6cf14f2e-f4af-41f0-8dd2-92d21e36ad06","_postman_id":"6cf14f2e-f4af-41f0-8dd2-92d21e36ad06","description":""},{"name":"Applications","item":[{"name":"getApplications","id":"37129789-8f2c-4c0f-90ff-32735e50bfeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"{{baseUrl}}/api/v1/decisioning/get-applications?companyId={{company_id}}&open=false","description":"

Endpoint to retrieve applications for a given company.

Request query parameters

companyId (string): REQUIRED
The ID of the company.

open (boolean): OPTIONAL
If provided and set to true, it will only return open applications.

Response body

The response is an array of application objects. Each application object contains the following properties:

applicationId (string):
The ID of the application.

tradingAddress (string):
The trading address of the company.

tradingAddressPostcode (string):
The postcode of the trading address.

website (string):
The website URL of the company.

tradingName (string):
The trading name of the company.

tradesOutsideUk (boolean):
Indicates whether the company trades outside the UK.

fasttrackRoutePass (boolean):
Indicates if the application has passed the fast track route.

standardRoutePass (boolean):
Indicates if the application has passed the standard route.

isFasttrackRoute (boolean):
Indicates if the application is eligible for the fast track route.

defaultProbability (number):
The default probability score.

defaultProbabilityBlendedModel (number):
The default probability score from the blended model.

defaultProbabilityExperian (number):
The default probability score from Experian.

closedAt (date):
The date when the application was closed. Format: YYYY-MM-DD.

submittedAt (date):
The date when the application was submitted. Format: YYYY-MM-DD.

createdAt (date):
The date when the application was created. Format: YYYY-MM-DD.

updatedAt (date):
The date when the application was last updated. Format: YYYY-MM-DD.

desiredAmount (number):
The desired funding amount.

declaredBrokerEmail (string):
The email address of the declared broker.

reasonForFunding (string):
The reason for funding.

cashflowScore (number):
The cashflow score.

leadScoringScore (number):
The lead scoring score.

tradesWithRestrictedCountries (boolean):
Indicates whether the company trades with restricted countries.

forwardLookingScalar (number):
The forward-looking scalar.

delphiScore (number):
The Delphi score.

declaredTurnover (number):
The declared turnover of the company.

isSme (boolean):
Indicates whether the company is an SME (Small and Medium-sized Enterprise).

detailedLoanPurpose (string):
The detailed purpose of the loan.

costPreference (string):
The customer's repayment preference.

tradesMostlyAbroad (boolean):
Indicates whether the company mostly trades abroad.

accountEndDate (date):
The end date of the company's accounting period. Format: YYYY-MM-DD.

accountDepreciation (number):
The depreciation amount in the company's accounts.

accountAmortisation (number):
The amortisation amount in the company's accounts.

netProfit (number):
The net profit of the company.

otherAccountOperatingIncome (number):
The operating income from other accounts.

closureReason (string):
The reason for application closure.

turnoverCato (number):
The turnover Cato score.

\n","urlObject":{"path":["api","v1","decisioning","get-applications"],"host":["{{baseUrl}}"],"query":[{"key":"companyId","value":"{{company_id}}"},{"key":"open","value":"false"}],"variable":[]}},"response":[{"id":"6ad5453a-584b-4f83-b7e2-5c2356dda2e8","name":"getApplications","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"jK89BOl6t6tF41roNYcGI6GmLGCACOC54TPlo9Fq","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/decisioning/get-applications?companyId=3055356223458117123","host":["{{baseUrl}}"],"path":["api","v1","decisioning","get-applications"],"query":[{"key":"companyId","value":"3055356223458117123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3452"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sat, 18 Mar 2023 21:12:33 GMT"},{"key":"x-amzn-RequestId","value":"19f320f4-97ce-4df0-9e64-cb31af50881c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"B_thcEZ5LPEFjuQ="},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6416293c-2d9ee638611aacaa49da58d9;Sampled=0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8cbc26e2bd6bdffe912d067e513f8b2c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C5"},{"key":"X-Amz-Cf-Id","value":"y-MeRlH3iKeGKffCeCKj9w11BHTFCu2c6BCL74zYYUHqDLOEAk3vDQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"result\": [\n {\n \"tradingAddress\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"tradingAddressPostcode\": \"S71 2LG\",\n \"website\": \"www.test.com\",\n \"tradingName\": \"SAUK UTILITIES LIMITED\",\n \"tradesOutsideUk\": false,\n \"applicationId\": \"3061411507687392947\",\n \"fasttrackRoutePass\": true,\n \"standardRoutePass\": true,\n \"isFasttrackRoute\": true,\n \"defaultProbability\": 0.0056,\n \"defaultProbabilityBlendedModel\": null,\n \"defaultProbabilityExperian\": 0.0056,\n \"closedAt\": null,\n \"createdAt\": \"2023-03-18T19:45:12.448491\",\n \"updatedAt\": \"2023-03-18T19:46:19.905315\",\n \"desiredAmount\": 30000,\n \"declaredBrokerEmail\": \"broker@x.com\",\n \"reasonForFunding\": \"Purchase\",\n \"closureReason\": \"\",\n \"cashflowScore\": null,\n \"leadScoringScore\": null,\n \"tradesWithRestrictedCountries\": false,\n \"forwardLookingScalar\": null,\n \"delphiScore\": null,\n \"declaredTurnover\": 1000000,\n \"isSme\": true,\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"tradesMostlyAbroad\": false,\n \"turnoverCato\": null,\n \"accountEndDate\": null,\n \"accountDepreciation\": null,\n \"accountAmortisation\": null,\n \"netProfit\": null,\n \"otherAccountOperatingIncome\": null\n },\n {\n \"tradingAddress\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"tradingAddressPostcode\": \"S71 2LG\",\n \"website\": \"www.test.com\",\n \"tradingName\": \"SAUK UTILITIES LIMITED\",\n \"tradesOutsideUk\": false,\n \"applicationId\": \"3061401394759075416\",\n \"fasttrackRoutePass\": true,\n \"standardRoutePass\": true,\n \"isFasttrackRoute\": true,\n \"defaultProbability\": 0.0056,\n \"defaultProbabilityBlendedModel\": null,\n \"defaultProbabilityExperian\": 0.0056,\n \"closedAt\": \"2023-03-18T19:44:57.935991+00:00\",\n \"createdAt\": \"2023-03-18T19:25:07.016578\",\n \"updatedAt\": \"2023-03-18T19:44:57.918636\",\n \"desiredAmount\": 30000,\n \"declaredBrokerEmail\": \"broker@x.com\",\n \"reasonForFunding\": \"Purchase\",\n \"closureReason\": \"Failed KYC\",\n \"cashflowScore\": null,\n \"leadScoringScore\": null,\n \"tradesWithRestrictedCountries\": false,\n \"forwardLookingScalar\": null,\n \"delphiScore\": null,\n \"declaredTurnover\": 1000000,\n \"isSme\": true,\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"tradesMostlyAbroad\": false,\n \"turnoverCato\": null,\n \"accountEndDate\": null,\n \"accountDepreciation\": null,\n \"accountAmortisation\": null,\n \"netProfit\": null,\n \"otherAccountOperatingIncome\": null\n },\n {\n \"tradingAddress\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"tradingAddressPostcode\": \"S71 2LG\",\n \"website\": \"www.test.com\",\n \"tradingName\": \"SAUK UTILITIES LIMITED\",\n \"tradesOutsideUk\": false,\n \"applicationId\": \"3059938312186758778\",\n \"fasttrackRoutePass\": true,\n \"standardRoutePass\": true,\n \"isFasttrackRoute\": true,\n \"defaultProbability\": 0.0056,\n \"defaultProbabilityBlendedModel\": null,\n \"defaultProbabilityExperian\": 0.0056,\n \"closedAt\": \"2023-03-17T12:17:40.079355+00:00\",\n \"createdAt\": \"2023-03-16T18:58:13.986232\",\n \"updatedAt\": \"2023-03-17T12:17:40.079355\",\n \"desiredAmount\": 10000,\n \"declaredBrokerEmail\": \"broker@x.com\",\n \"reasonForFunding\": \"Making a purchase\",\n \"closureReason\": \"\",\n \"cashflowScore\": null,\n \"leadScoringScore\": null,\n \"tradesWithRestrictedCountries\": false,\n \"forwardLookingScalar\": null,\n \"delphiScore\": null,\n \"declaredTurnover\": 1000000,\n \"isSme\": true,\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"tradesMostlyAbroad\": false,\n \"turnoverCato\": null,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"netProfit\": 500000,\n \"otherAccountOperatingIncome\": 100000\n }\n ]\n}"}],"_postman_id":"37129789-8f2c-4c0f-90ff-32735e50bfeb"},{"name":"createApplication","id":"51825528-9f82-4322-b007-9bb970c5289b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"{{company_id}}\",\n \"annualTurnover\": 1000000.0,\n \"desiredAmount\": 30000.0,\n \"tradesWithRestrictedCountries\": false,\n \"tradesMostlyAbroad\": false,\n \"isSme\": true,\n \"reasonForFunding\": \"Purchase\",\n \"detailedLoanPurpose\": \"Car\",\n \"costPreference\": \"lowestMonthlyRepayment\",\n \"netProfit\": 500000,\n \"accountEndDate\": \"2022-04-30\",\n \"accountDepreciation\": 20000,\n \"accountAmortisation\": 20000,\n \"otherAccountOperatingIncome\": 100000,\n \"tradesOutsideUk\": false,\n \"tradingAddress\": \"175 Rotherham Road, Barnsley, South Yorkshire\",\n \"tradingAddressPostcode\": \"S71 2LG\",\n \"tradingName\": \"SAUK UTILITIES LIMITED\",\n \"website\": \"www.test.com\",\n \"declaredBrokerEmail\": \"broker@x.com\"\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1/decisioning/create-application","description":"

An endpoint to create a new application for a given customer.

Note, an application is automatically created when a customer is first created. Use this endpoint when opening a subsequent application for an existing customer.

Request body

companyId (string): REQUIRED
The ID of the company.

annualTurnover (number): REQUIRED
The annual turnover of the company.

desiredAmount (number): REQUIRED
The desired funding amount.

tradesWithRestrictedCountries (boolean): REQUIRED
Indicates whether the company trades with restricted countries.

tradesMostlyAbroad (boolean): REQUIRED
Indicates whether the company mostly trades abroad.

isSme (boolean): REQUIRED
Indicates whether the company is an SME (Small and Medium-sized Enterprise).

reasonForFunding (string): OPTIONAL
The reason for funding.

detailedLoanPurpose (string): OPTIONAL
The detailed purpose of the loan.

costPreference (string): OPTIONAL
The customer's repayment preference.

netProfit (number): OPTIONAL
The net profit of the company.

accountEndDate (date): OPTIONAL
The end date of the company's accounting period.