{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","description":"Creditbook provides an API suite called the \"Embedded Finance APIs\" for our partners to integrate into their business flows, enabling their customers to avail Creditbook's speedy and reliable financing options.\n\nThe following APIs constitute our lending infrastructure, offering developers and partners a secure environment to seamlessly test and integrate applications.\n\nTo understand our main processes better, sequence diagrams are attached along with each folder that represent generic (but not necessarily hard wired) flows for how integration and lending work. The folders have been subdivided into \"main\" and \"utils\" to provide clarity on what purpose a specific endpoint serves in the happy flow. Before entering into the documentation, following is a list of terms and their dedintions that are used frequently throughout this document.\n\n### Glossary of Terms:\n\n#### Partner:\n\nThe consumer of EF APIs, for whom these docs are intended, is the Partner.\n\n#### Customer:\n\nUnder this system, a Customer is comprised of 3 constituent parts:\n\n- An entity\n    \n- The entity's compliance(s)\n    \n- The entity's products\n    \n\n**Entity:** An entity may refer to an individual or a business registered with the system. A business can be owned by multiple individuals and an individual may be linked to multiple businesses. Each individual and business entity have a corresponding compliance. Since a loan application is submitted through a business, _the entity referring to a customer above is actually the_ _**Business Entity,**_ _but the customer registration process involves entering details for both the business and at least one linked individual (or more)._\n\n**Compliance:** A compliance is a document which captures an entity's KYC requirements. These may include for example National Document ID, Industry, Average Monthly Revenue, Bank Statement, among others. The exact list of compliance requirements are retrieved from the [Get Form Meta API](https://engineering-cb.postman.co/workspace/Finance-Core~2583cf1c-40e2-4298-911a-4dfadf46b90e/request/37253105-ce4886cc-f60f-4a5a-ba0b-80427dbf530c?action=share&source=copy-link&creator=37253105&active-environment=91a5bc33-0999-43bf-8c4b-374d2ceeb901).\n\n**Product:** A product refers to a financing offering of a specific type, for eg Cash Flow Financing, Invoice Financing etc. The customer may sign agreements for these products to become eligible to apply for financing for them. **For example** there may have a product called \"Car Financing\" available to partner ABC. Then, a customer on partner ABC's app through the Embedded Finance APIs may register with the [Create Entity API](https://engineering-cb.postman.co/workspace/Finance-Core~2583cf1c-40e2-4298-911a-4dfadf46b90e/request/37253105-ec12a1a7-11d9-467d-a789-d52ff993f38f?action=share&source=copy-link&creator=37253105&active-environment=850f669f-e751-470e-9217-209085216e16), sign an agreement for \"Car Financing\" product, and then can apply for Car Financing through the [Create Loan API](https://engineering-cb.postman.co/workspace/Finance-Core~2583cf1c-40e2-4298-911a-4dfadf46b90e/request/37253105-ec12a1a7-11d9-467d-a789-d52ff993f38f?action=share&source=copy-link&creator=37253105&active-environment=91a5bc33-0999-43bf-8c4b-374d2ceeb901).\n\n#### Agreement:\n\nA contract to formalize financing processes. Agreements are signed during:  \n1\\. The Customer Onboarding Flow - to lay out the terms of a finance offering between a financier and a customer\n\n2\\. The Financing Flow (optional) - in some cases, loan level agreements are required where a customer will sign an agreement for each financing request they make once it gets approved by the system\n\n#### Service:\n\nA service refers to a specific functional capability related to a type of financing. For example, a \"Loan Service\" encompasses the operations to apply for and manage loans, while a \"Savings Service\" would handle savings account functionalities.\n\nWhen a customer is eligible for or has chosen a specific Product (e.g., a 'Personal Loan'), it means they can then interact with the associated Service - in this case a Loan.\n\nCurrently, our system primarily supports a \"Loan Service.\"","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37253105","collectionId":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","publishedId":"2sB2x8EWPJ","public":true,"publicUrl":"https://developers.credr.creditbook.pk","privateUrl":"https://go.postman.co/documentation/37253105-1fce6ba2-2c4a-4b18-838d-c76eddb40a79","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The Embedded Finance API suite provides an easy integration for partner companies into their customer facing applications to allow them to avail Creditbook's credit-based financing options. These docs outline the definitions, flows, and endpoints concerned with these EF APIs."},{"name":"title","value":"Creditbook Embedded Finance APIs "}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/45220009-10db-4a29-8159-499789ea49ac/aG9yaXpvbnRhbC13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/04dfc06f-25b9-4417-b2d5-4b1e96ae1f99/aG9yaXpvbnRhbC1ibHVlICgxKS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-06-23T11:56:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Creditbook Embedded Finance APIs ","description":"The Embedded Finance API suite provides an easy integration for partner companies into their customer facing applications to allow them to avail Creditbook's credit-based financing options. These docs outline the definitions, flows, and endpoints concerned with these EF APIs."},"logos":{"logoLight":"https://content.pstmn.io/04dfc06f-25b9-4417-b2d5-4b1e96ae1f99/aG9yaXpvbnRhbC1ibHVlICgxKS5wbmc=","logoDark":"https://content.pstmn.io/45220009-10db-4a29-8159-499789ea49ac/aG9yaXpvbnRhbC13aGl0ZS5wbmc="}},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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://developers.credr.creditbook.pk/view/metadata/2sB2x8EWPJ"}