{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"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.\n\nOur 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.\n\nLenders 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.\n\nOur capabilities are broadly broken down into 5 key areas, reflecting the major stages of the credit lifecycle and lending experience.\n\n## Origination\n\nOriginate new lending opportunities quickly, accurately and efficiently.\n\nLending 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.\n\n- Generate lending quotes in <50 seconds, using only customer-provided 5 data points, and with >85% likelihood of acceptance at the final offer phase.\n- Adjust 100+ precise risk parameters that allows you dynamic decision models balance risk, CX and cost\n- Meet and exceed consumer duty requirements, by matching your customer to the most appropriate product based on their preferences, financial situation and funding context.\n- Multi-product offers provide\n    \n\n## Decisioning\n\nMake 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.\n\nOur 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.\n\n- 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.\n- 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.\n- 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.\n    \n\n## Onboarding\n\nOnboard 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.\n\n- A fully paperless onboarding processes, integrateable with leading KYC, KYB and digital documentation applicaitons.\n- Multi-director processing, verifying all directors depending on policy requirements.\n- Anti-fraud measures including automated data validation with Companies House and multi-stage withdrawal approval options.\n- Integrations with GoCardless to setup automated direct debit repayments\n    \n\n## Servicing\n\nIf 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.\n\nIntegrate 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.\n\n- Fully automated loan processing and direct debit set up\n- Embed rich loan detail and interactions into any customer channel.\n- Advanced capabilities, including early loan repayment, payment holiday calculations and arrears management automation available via the Abel LMS.\n    \n\n## Monitoring\n\nAbel'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.\n\nWe'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.\n\n- Complete book visibility to individual loan level\n- Adjust 200+ risk and model parameters in real-time to deliver, granular behavioural segmentation\n- Push granular risk strategy and appetite changes in real-time using our no-code risk configuration dashboard.\n- Insert SME-specific intelligence into your monitoring processes, including sub-sector economic outlook indices, behavioural P(d) scores, and forward-looking affordability scores .\n    \n\n# Getting Started\n\nTo get started with the Abel API\n\n1. Generate and retrieve your API key from the Abel Dashboard. ([Contact our team](mailto:client-support@beabel.io) for access)\n2. Authenticate your API key using the getToken endpoint.\n3. \\[Optional\\] [Contact our team](mailto:client-support@beabel.io) to get access to a sandbox environment with historic company and risk data, and a range of developer tools to speed testing and integration.\n4. Browse our API collections, and read the step-by-step guides to get successfully integrate with Abels services.\n    \n\n# Authentication and Security\n\nThe Abel API uses [API keys](https://stripe.com/docs/keys) to authenticate requests. You can view and manage your API keys in your Abel Dashboard.\n\nYour 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.\n\nAuthentication to the API is performed via [HTTP Basic Auth](http://en.wikipedia.org/wiki/Basic_access_authentication). Provide your API key as the basic auth username value. You do not need to provide a password.\n\nAll requests need to contain the `x-api-key` header.\n\nAll API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\nYou can retrieve a token using the following endpoint: `POST /api/v1/get-token`\n\nRequest:\n\n`{ \"client_id\": \"{{client_id}}\", \"client_secret\": \"{{client_secret}}\" }`\n\nResponse:\n\n`{ \"success\": true, \"message\": \"Success\", \"result\": { \"token\": \"{{TOKEN}}\" } }`\n\n# API Basics\n\n## API Architecture\n\nThe Abel API is organised around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). The API attempts to use predictable, resource-oriented URLs and to use HTTP status codes to indicate errors.\n\n## Request Methods\n\nAbel follows standard RESTful API Method conventions to expose API functionality. These are summarised in the table below.\n\n| Method | Description |\n| --- | --- |\n| GET | The GET method is used to retrieve data from the server.  <br>Use the GET method when you want to read or fetch information.  <br>It is safe and idempotent, meaning that multiple identical requests will produce the same result.  <br>GET requests should not have any side effects on the server or modify the data. |\n| 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.  <br>It is not idempotent, meaning that sending the same request multiple times may result in different outcomes.  <br>POST requests can have side effects, such as creating a new record in the database. |\n| 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.  <br>It is idempotent, meaning that sending the same request multiple times will have the same effect as sending it once.  <br>PUT requests can be used to create a resource if you provide the identifier. |\n| DELETE | Remove a specified resource from the server. Use the DELETE method when you want to remove a specific resource or entity.  <br>It is idempotent, meaning that sending the same request multiple times will have the same effect as sending it once.  <br>DELETE requests should not have any side effects other than removing the resource. |\n\n## Request Headers\n\nAll the requests need to contain the `x-api-key` header and all, execept the getToken endpoint require an authorisation token.\n\n## Response Codes\n\nAbel adheres to the range of [HTTP Status Codes](https://restfulapi.net/http-status-codes/) typical to RESTful APIs.\n\n## Pagination\n\nPagination is not currently supported in this version of the Abel API. We are working to provide support pagination in subsequent versions of this API.\n\n## Rate and usage limits\n\nAPI 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.\n\nEach API response returns the following set of headers to help you identify your use status:\n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. |\n\n### 503 response\n\nAn 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](mailto:client-support@beabel.io).\n\n# Integration Guides\n\n## Step-by-step guides\n\nThe Abel API is organised into five key collections, reflecting the key stages and activities of each stage of the SME lending lifecycle:\n\n- **Origination:** generating 'quick offer' quotes for a customer\n- **Decisioning:** converting those quotes to fully risk underwritten lending decisions.\n- **Onboarding**: activating a customer and loan in the systems and disbursing funds\n- **Servicing:** exposing live loan information, and automating repayment processes\n- **Monitoring**: conducting loan, customer and portfolio-level monitoring activities.\n    \n\nEach 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.\n\n# Support\n\nFor implementation, troubleshooting and best practice support contact our engineering team directly at [client-support@beabel.io](mailto:client-support@beabel.io).\n\n# API Reference","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24900067","team":4285996,"collectionId":"b572c885-365b-4c64-be94-bb319d0aabc0","publishedId":"2s93z6ciGX","public":true,"publicUrl":"https://docs.beabel.io","privateUrl":"https://go.postman.co/documentation/24900067-b572c885-365b-4c64-be94-bb319d0aabc0","customColor":{"top-bar":"FFFFFF","right-sidebar":"021715","highlight":"03966F"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore Abel's API documentation to learn more about our SME lending technology platform, featuring a powerful suite of tools for loan origination, underwriting, servicing, and monitoring."},{"name":"title","value":"Abel | SME Lending API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/263f7b67-263e-419b-8a79-746114151bb9/YWJlbC13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"141414","highlight":"03966F"}},{"name":"light","logo":"https://content.pstmn.io/633ed00e-bce8-466b-90bc-99a012d588fb/YWJlbC1ibGFjay5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"021715","highlight":"03966F"}}]}},"version":"8.11.4","publishDate":"2023-07-14T20:42:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Abel | SME Lending API Documentation","description":"Explore Abel's API documentation to learn more about our SME lending technology platform, featuring a powerful suite of tools for loan origination, underwriting, servicing, and monitoring."},"logos":{"logoLight":"https://content.pstmn.io/633ed00e-bce8-466b-90bc-99a012d588fb/YWJlbC1ibGFjay5wbmc=","logoDark":"https://content.pstmn.io/263f7b67-263e-419b-8a79-746114151bb9/YWJlbC13aGl0ZS5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/bfde364fdcfe582ac31138cd5f32209fb680f813523b7a49b406c4efb15b303f","favicon":"https://beabel.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.beabel.io/view/metadata/2s93z6ciGX"}