{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","description":"There are three main ways to use Creditbook's lending processes: the **White Label Component Library**, **Embedded Finance (EF) APIs**, and **PartnerBook**. The following documentation will focus on the EF APIs.\n\nThe following APIs constitute our lending infrastructure, offering developers and partners a secure environment to seamlessly test and integrate applications. These APIs are divided into two main sections: the **Sandbox APIs** and the **Integration APIs**.\n\nThe Sandbox APIs include special \"Process\" endpoints, such as **Process KYB** and **Process Loan**, which abstract backend functions typically performed asynchronously by Creditbook. These endpoints allow partners to mimic critical steps quickly in a testing environment, enabling faster testing without waiting for actual asynchronous responses.\n\nOur Integration APIs provide the functionality to assist partners in integrating the lending flow in their applications. For instance, essential getter/setter functions, document uploads, etc.\n\nTo understand our main processes better, following are sequence diagrams that represent generic (but not necessarily hard wired) flows for how integration and lending work.\n\n**Process 1:** Partner Login\n\n<img src=\"https://content.pstmn.io/73d98f72-040d-481a-8b32-2b5f8dc23d66/bWVybWFpZC1kaWFncmFtLTIwMjQtMTEtMjQtMjMyNjE3LnBuZw==\">\n\nEndpoints:\n\n- Partner Login: [https://docs.creditbook.pk/#896b17ad-227c-485f-b34e-d2e49e18b8e3](https://docs.creditbook.pk/#896b17ad-227c-485f-b34e-d2e49e18b8e3)\n    \n\n**Process 2:** Customer Onboarding\n\n<img src=\"https://content.pstmn.io/726562e1-b6fb-4be3-97f0-25268c984af7/U2NyZWVuc2hvdCAyMDI0LTExLTI2IGF0IDEuMDMuNTfigK9QTS5wbmc=\">\n\nIn the above diagram, the container 'alt' describes the difference between our 2 environments: sandbox (dev) and production. Processing a KYB for approval involves 3 steps in the live production flow: compliance approval, risk approval, and contract generation. These are handled by CB's team as soon as possible when a new KYB is submitted. In the sandbox environment, these 3 steps are abstracted away into the 'Process KYB' endpoint so that partners can continue testing the EF APIs without needing to wait for KYB approval from CB.\n\nEndpoints:\n\n- Create Lending User: [https://docs.creditbook.pk/#478180ef-39b5-4ad9-9b2f-66e724eb9155](https://docs.creditbook.pk/#478180ef-39b5-4ad9-9b2f-66e724eb9155)\n    \n- Process KYB: [https://docs.creditbook.pk/#7c82a1b2-8c58-45ae-8d00-cb82b1cf86ef](https://docs.creditbook.pk/#7c82a1b2-8c58-45ae-8d00-cb82b1cf86ef)\n    \n\n**Process 3:** Financing Request\n\n<img src=\"https://content.pstmn.io/67c61f90-735e-45ed-86c6-68042355e915/U2NyZWVuc2hvdCAyMDI0LTExLTI2IGF0IDEuMDUuMjnigK9QTS5wbmc=\">\n\nSimilarly here, the financing flow involves 2 main steps: loan application and loan disbursal. In production environment, the user/partner will submit an application and then it will be processed for approval on CB's end, after which it will be disbursed through one of our payment channels. Once disbursed, daily SMS/email reminders will be sent to the customer about their due amount. The customer/partner will initiate a repayment by creating a repayment transaction with image proof of transaction attached to it. Once the transaction is approved on CB's side, the financing flow completes one disbursement-repayment cycle. Partner webhooks are also called at each step of the process. The difference between the sandbox and production environments in blue and green respectively is the same as described in the Customer Onboarding process.\n\nEndpoints:\n\n- Create Loan: [https://docs.creditbook.pk/#0dbff5be-67c8-4359-b0a1-e99543daeb61](https://docs.creditbook.pk/#0dbff5be-67c8-4359-b0a1-e99543daeb61)\n    \n- Process Loan: [https://docs.creditbook.pk/#1ac9d5b1-8a34-4188-a049-66d9aac62aab](https://docs.creditbook.pk/#1ac9d5b1-8a34-4188-a049-66d9aac62aab)\n    \n- Create Transaction: [https://docs.creditbook.pk/#473b6f38-a048-45b5-a45a-79d79fc62e09](https://docs.creditbook.pk/#473b6f38-a048-45b5-a45a-79d79fc62e09)\n    \n- Process Transaction: [https://docs.creditbook.pk/#028b6ca3-51ec-4bbb-a195-c9aceb7816b2](https://docs.creditbook.pk/#028b6ca3-51ec-4bbb-a195-c9aceb7816b2)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33837024","team":2868813,"collectionId":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","publishedId":"2sAXxS6qMq","public":true,"publicUrl":"https://docs.creditbook.pk","privateUrl":"https://go.postman.co/documentation/33837024-9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-10-11T07:04:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/c2a8d3ee238a0045b35e5e0b41d70d81a12d779b54de7fc24f05ed166622c002","favicon":"https://creditbook.pk/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.creditbook.pk/view/metadata/2sAXxS6qMq"}