{"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.

The 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.

The 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.

Our 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.

To understand our main processes better, following are sequence diagrams that represent generic (but not necessarily hard wired) flows for how integration and lending work.

Process 1: Partner Login

\n\n

Endpoints:

Partner Login: https://docs.creditbook.pk/#896b17ad-227c-485f-b34e-d2e49e18b8e3

Process 2: Customer Onboarding

\n\n

In 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.

Endpoints:

Create Lending User: https://docs.creditbook.pk/#478180ef-39b5-4ad9-9b2f-66e724eb9155
\n
Process KYB: https://docs.creditbook.pk/#7c82a1b2-8c58-45ae-8d00-cb82b1cf86ef
\n

Process 3: Financing Request

\n\n

Similarly 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.

Endpoints:

Create Loan: https://docs.creditbook.pk/#0dbff5be-67c8-4359-b0a1-e99543daeb61
\n
Process Loan: https://docs.creditbook.pk/#1ac9d5b1-8a34-4188-a049-66d9aac62aab
\n
Create Transaction: https://docs.creditbook.pk/#473b6f38-a048-45b5-a45a-79d79fc62e09
\n
Process Transaction: https://docs.creditbook.pk/#028b6ca3-51ec-4bbb-a195-c9aceb7816b2
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33837024","collectionId":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","publishedId":"2sAXxS6qMq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-11T07:04:48.000Z"},"item":[{"name":"White Label UI Support","item":[],"id":"965a9a68-d545-4a86-95d9-73669f5483de","description":"

For effortless integration of white label UI components into React applications, consider using @creditbook/wlc-react-sdk NPM library, available here. This library offers seamless integration and incorporates all the necessary functionalities of our lending infrastructure, empowering developers to swiftly build and customize user interfaces tailored to their specific needs.

Note - This SDK is strictly React and not supported on native platforms

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6aeff182-45f3-4e8e-98d6-f2233a608bdf","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"cd2cb9aa-595e-4b7a-8aae-6457be2a87fa","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"965a9a68-d545-4a86-95d9-73669f5483de"},{"name":"Sandbox APIs","item":[{"name":"Partner Login","id":"896b17ad-227c-485f-b34e-d2e49e18b8e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"6401e7d0a799b6dcc9e013ef\",\n \"apiKey\": \"********************\"\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.creditbookapi.com/api/v1/auth/partners/login","description":"

The Login endpoint allows external partners to authenticate and obtain access to the CreditBook Lending Service. Partners are required to provide valid credentials to access the system's resources and perform authorized actions. Send the credentials through the API body as shown below and obtain the access token as shown in the response example.

Note: This API should only be invoked from the backend__. We'll have your IP whitelisted at our server which will verify that the request only originates from your backend

This API creates a lending user and therefore, requires all KYB/KYC information to be entered via the API body. Some of the information is mandatory to enter at all times however, some information can be omitted depending on the business_type.

Request Body Parameters

Applicable for All Business Types

external_user_id: string (optional) - field if partner would like to link their user identifier. It is recommended to send this all the time. If exists, must be unique
\n
email: string (optional) - if exists, email address of the user that must be unique
\n
businessType: individual | branchOffice | partnership | company | soleProprietorship
\n
ntn: string - Note: send cnic number in this field if businessType is soleProprietorship or individual and must be unique
\n
fullName: string
\n
contactNumber: string - in format +92xxxxxxxxxx and must be unique
\n
businessName: string
\n
businessAddress: string
\n
pastPurchaseOrders: Array{FileDto} - (optional)
\n
pastInvoices: Array{FileDto} - (optional)
\n
financialStatement: Array{FileDto} - (optional)
\n
otherFiles: Array - (optional) - Any extra files that partner has. name must be present to demonstrate what the file is about.
\n
bankDetails: bankDetailsDto- (optional) - has 3 mandatory fields i.e. accountTitle, accountNumber and bankCode and 1 optional (but recommended) field for iban. Use get-banks api for the bankCode.
\n
selfie - Array{FileDto}- (conditional) - required if selfie is defined in partner configuration, file must be of type: .jpeg, .jpg, .png.
\n

Now, all the fields mentioned below are required if and only if businessType matches as mentioned in the subheadings. Otherwise, we can assume that the fields are optional

Fields if businessType is individual

cnicFront - Array{FileDto} - file must be of type: .jpeg, .jpg, .png.
\n
cnicBack - Array{FileDto}- file must be of type: .jpeg, .jpg, .png.
\n

Fields if businessType is soleProprietership

cnicFront - Array{FileDto}- file must be of type: .jpeg, .jpg, .png.
\n
cnicBack - Array{FileDto}- file must be of type: .jpeg, .jpg, .png.
\n
proprietorshipDeclaration - Array{FileDto} - Proprietorship Declaration Letter from the Bank
\n
ntnCertificate - Array{FileDto}
\n
bankStatement - Array{FileDto} - (optional) - bank statement of 6 months
\n

Fields if businessType is partnerShip

partnerCnic: Array{FileDto} - CNICs of all Partners (Front and Back in Single file)
\n
partnerShipDeed: Array{FileDto} Attested copy of Partnership Deed
\n
authorityLetter: Array{FileDto} - Authority letter from all partners, in original, authorizing the person(s) to operate firm’s account
\n
incorporationCertificate: Array{FileDto} - (optional) - Attested copy of Registration Certificate with Registrar of Firms
\n

Fields if businessType is company

directorsResolution: Array{FileDto} - Certified Copy of Resolution of Board of Directors for opening of account
\n
memorandumArticlesAssociation: Array{FileDto} - Certified Copy of Memorandum and Articles of Association
\n
boardMemberCnic: Array{FileDto} - CNICs of all Board members (Front and Back in Single file)
\n
pocCnic: Array{FileDto} - CNIC of the Person authorized as Point of Contact
\n
beneficialOwnerCnic:Array{FileDto} - CNICs of the beneficial owners (Front and Back)
\n
addendum: Array{FileDto} - (optional) - Form II in case of newly incorporated company and Form A/Form C whichever is applicable; and Form 29 if already incorporated company
\n
formAB: Array{FileDto} - (optional) - Certified copy of Latest Form-A/Form-B
\n

Fields if businessType is branchOffice

permissionLetter - Array{FileDto} - Permission letter from relevant authority i-e Board of Investment
\n
signatoryPassports - Array{FileDto} - Valid passports of all the signatories of account
\n
formIIParticulars - Array{FileDto} - Form II about particulars of directors, Principal Officer etc. in case of newly registered branch or liaison office of a foreign company
\n
principalOfficeAuthorization - Array{FileDto} - A Letter from Principal Office of the entity authorizing the person(s) to open and operate the account
\n

FileDTO Type

Please make sure to send FileDto typed files in the following format. Convert to array of objects where applicable. The resouceURL can either be a downloadable url stored on the partner's bucket or the following CreditBook API can also be used.

type FileDto {\n     resourceURL: string; // This is the link to the image/document. It should be downloadable.\n     name?: string // optional description of the file\n}\n\n

BankDetailsDTO Type

type BankDetailsDto {\n     bankCode: string; // bank code associated with the user's bank (use get-banks api) \n     accountTitle: string // bank account title\n     accountNumber: string //bank account number\n     iban?: string //IBAN of the given bank account number\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v1","external-lending","sme","users"],"host":["{{base_url_lms}}"],"query":[],"variable":[]}},"response":[{"id":"2398bad4-91f9-422a-84b7-11b658c34a0f","name":"success response","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"email\": \"DanteSparta18@gmail.com\",\n \"fullName\": \"MadDante\",\n \"contactNumber\": \"+923361234567\",\n \"businessName\": \"Riot Games\",\n \"businessType\": \"company\",\n \"ntn\": \"111111111\",\n \"businessAddress\": \"123/4 - 11 - Korangi, Karachi\",\n \"directorsResolution\": [\n {\n \"name\": \"picture_1\",\n \"size\": 2048,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n },\n {\n \"name\": \"picture 2\",\n \"size\": 1024,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"memorandumArticlesAssociation\": [\n { \n \"name\": \"picture_3\",\n \"size\": 4096,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pocCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"boardMemberCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"beneficialOwnerCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pastPurchaseOrders\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pastInvoices\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"otherFiles\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 26 Mar 2024 06:49:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2468"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"300;w=60"},{"key":"RateLimit-Limit","value":"300"},{"key":"RateLimit-Remaining","value":"299"},{"key":"RateLimit-Reset","value":"39"},{"key":"ETag","value":"W/\"9a4-nNWreuhR+TsYM0XLhjRH4SaSdbM\""}],"cookie":[],"responseTime":null,"body":"{\n \"kyb\": {\n \"email\": \"DanteSparta18@gmail.com\",\n \"contactNumber\": \"+923361234567\",\n \"fullName\": \"MadDante\",\n \"businessName\": \"Riot Games\",\n \"display_id\": \"OR-K-P5UUTB\",\n \"businessType\": \"company\",\n \"businessAddress\": \"123/4 - 11 - Korangi, Karachi\",\n \"ntn\": \"111111111\",\n \"status\": \"pending\",\n \"statuses\": [\n {\n \"status\": \"pending\",\n \"timestamp\": \"2024-03-26T06:49:36.026Z\",\n \"updated_by\": \"system\",\n \"reason\": \"Update by User\"\n }\n ],\n \"directorsResolution\": [\n {\n \"name\": \"picture_1\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 2048\n },\n {\n \"name\": \"picture 2\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 1024\n }\n ],\n \"memorandumArticlesAssociation\": [\n {\n \"name\": \"picture_3\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 4096\n }\n ],\n \"boardMemberCnic\": [\n {\n \"name\": \"placeholder-name\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 0\n }\n ],\n \"pocCnic\": [\n {\n \"name\": \"placeholder-name\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 0\n }\n ],\n \"beneficialOwnerCnic\": [\n {\n \"name\": \"placeholder-name\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 0\n }\n ],\n \"pastPurchaseOrders\": [\n {\n \"name\": \"placeholder-name\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 0\n }\n ],\n \"pastInvoices\": [\n {\n \"name\": \"placeholder-name\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 0\n }\n ],\n \"otherFiles\": [\n {\n \"name\": \"placeholder-name\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\",\n \"size\": 0\n }\n ],\n \"_id\": \"66027000caaa9d57100817a7\",\n \"facilities\": [],\n \"created_at\": \"2024-03-26T06:49:36.031Z\",\n \"updated_at\": \"2024-03-26T06:49:36.031Z\",\n \"id\": \"66027000caaa9d57100817a7\",\n \"bankAccount\": null\n }\n}"},{"id":"efa40cd0-fcb8-49c3-a87f-9ebc637cd8d9","name":"error response - missing field","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"email\": \"DanteSparta18@gmail.com\",\n \"fullName\": \"MadDante\",\n \"contactNumber\": \"+923361234567\",\n \"businessName\": \"Riot Games\",\n \"businessType\": \"company\",\n \"ntn\": \"111111111\",\n \"businessAddress\": \"123/4 - 11 - Korangi, Karachi\",\n \"directorsResolution\": [\n {\n \"name\": \"picture_1\",\n \"size\": 2048,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n },\n {\n \"name\": \"picture 2\",\n \"size\": 1024,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"memorandumArticlesAssociation\": [\n { \n \"name\": \"picture_3\",\n \"size\": 4096,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pocCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"boardMemberCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"beneficialOwnerCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pastPurchaseOrders\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pastInvoices\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"otherFiles\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"${key} is a required field\" // based on the company type, specific fields are required to create a new lending user as outlined in the API description\n}"},{"id":"afd92a31-ed08-4cb0-b4b7-b34eb00e36d3","name":"error response - user with given key already exists","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"email\": \"DanteSparta18@gmail.com\",\n \"fullName\": \"MadDante\",\n \"contactNumber\": \"+923361234567\",\n \"businessName\": \"Riot Games\",\n \"businessType\": \"company\",\n \"ntn\": \"111111111\",\n \"businessAddress\": \"123/4 - 11 - Korangi, Karachi\",\n \"directorsResolution\": [\n {\n \"name\": \"picture_1\",\n \"size\": 2048,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n },\n {\n \"name\": \"picture 2\",\n \"size\": 1024,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"memorandumArticlesAssociation\": [\n { \n \"name\": \"picture_3\",\n \"size\": 4096,\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pocCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"boardMemberCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"beneficialOwnerCnic\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pastPurchaseOrders\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pastInvoices\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"otherFiles\": [\n {\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/users"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User with {key}={value} already exists\" // the unique fields on which a user is identified are ntn, email, and contactNumber\n}"}],"_postman_id":"478180ef-39b5-4ad9-9b2f-66e724eb9155"},{"name":"Process KYB","id":"7c82a1b2-8c58-45ae-8d00-cb82b1cf86ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"DanteSparta18@gmail.com\",\n \"status\": \"approved\",\n \"contract_details\": {\n \"amount\": 100000,\n \"markup\": 30,\n \"tenure\": 30\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/sandbox/users/process","description":"

Now, since a customer creation is successful, our operations team would like to review the KYB information to check for any malicious data. The results are shown via updating the status of the KYB document.

Since this is an operation executed by CreditBook internally, below API simulates the exact operations on approval/rejection of the KYB. Upon successful verification, a contract is generated for the customer, pending signature before loans can be applied for. This serves as a crucial step in the onboarding process, ensuring compliance with regulatory requirements and establishing the eligibility of customers to access financial services.

Query Parameters

Either one or any combination of these query params can be used to fetch the user's kyb. Alteast one query param needs to exist in the request.

email: string
contactNumber: string - must be in format +92XXXXXXXXXX
ntn: string
external_user_id: string

For backward compatibility we still allow the email of the user, to be sent in the request body. However you are reccomended to send the user search params in the query params of the request.

Note

This is a one time operation for a customer given that they have not updated their KYB information (in which case, they will have to get it approved once again). After this, the user can continue to request finance applications within their credit_limit

Request Body Parameters

status (KYBStatus, required): The result of the KYB verification process.
contract_details (ContractDetailsRequest, required if status = approved): An object containing the specifics of the customer's contract include credit limit, markup and tenure.

Note

Contract information is only included in the response if the KYB is approved.
This operation will be rejected if the KYB is already approved.
The detailed description of request/response data types is given below:

type KYBStatus = \"approved\" | \"rejected\"\ntype ContractDetailsRequest = {\n        amount?: number = 100000;\n        markup?: number = 40; // % per annum \n        tenure?: number = 1; // years\n}\ntype ContractDetailsResponse = {\n        facility_amount_digits: string = 100000;\n        facility_markup: string = 40; // % per annum \n        facility_tenure: string = 1; // years\n}\n\n

Response Object

user_id (string): A unique identifer of the customer.
full_name (string): The full name of the customer.
status (string, [enum KYBStatus]): The status of the KYB verification of the customer.
contract_status (string, See Note 1): The status of the contract of the user.
contract_id (string, See Note 1): A unique identifer of the contract created by the current request.
contract_details (object, [ContractDetailsResponse], See Note 1): An object containing the specifics of the customer's contract include credit limit, markup and tenure.

Once the KYB is approved from CreditBook internally, we can proceed onto the next step which is signing the contract from user's side. Otherwise, if KYB is rejected, the user will have to send the correct information again using the Update User API until the KYB is approved

Gets the contract URL of the latest pending contract of the user whose email , contactNumber, ntn, and/or external_user_id is passed in the query parameters. If latest contract is not pending or is not present, returns message with not found in response.

The link will redirect to our signing service where the user can view the contract documents and sign them digitally. Upon successfully signing the contract, an internal process is automatically triggered after which the user will be able to apply for financing using CreateLoan API.

FYI: Contract URL can also be fetched from get-lending-user API as it is present in the facilities object and is always the envelope_url of the latest facility in the array.

Query Parameters

Either one or any combination of these query params can be used to fetch the user. Alteast one query param needs to exist in the request.

email: string
contactNumber: string - must be in format +92XXXXXXXXXX
ntn: string
external_user_id: string

Response Body

See sample response.

DEPRECATED - This process can now be done by signing the contract via the link in Get Contract URL API. We recommend going through that step as that is what the actual flow would be like.

The Sign Contract endpoint within the Sandbox API facilitates the process of signing a contract, which is a prerequisite for customers to apply for loans and therefore, this process automatically happens right after the user have signed the contract sent to them. However, for accessibility purposes, this endpoint allows partners to simulate digitally sign the contract by providing the contract ID and their email address.

Request Body Parameters

contract_id (string, required): A unique identifier of the contract being signed. This will be taken from the response of Process KYB response object or can be taken by re-getting the user through Get: /user API

Query Parameters

Either one or any combination of these query params can be used to specify the user whose contract needs signing. Alteast one query param needs to exist in the request.

email: string
contactNumber: string - must be in format +92XXXXXXXXXX
ntn: string
external_user_id: string

Response Object

user_id (string): A unique identifer of the customer.
full_name (string): The full name of the customer.
contract_status (string): The status of the contract of the user.
contract_id (string): A unique identifer of the contract created by the current request.
contract_details (object, [ContractDetailsResponse]): An object containing the specifics of the customer's contract include credit limit, markup and tenure.

Note

An expired contract can be forcefully signed through the API. This behaviour is left for convenience but leaves the credit limit and markup with value 0.
The detailed description of request/response data types is given below:

type ContractDetailsResponse = {\n        facility_amount_digits: string = 100000;\n        facility_markup: string = 40; // % per annum \n        facility_tenure: string = 1; // years\n}\n\n

Now, the customer has been assigned with a credit_limit and is eligible for creating applications. Thus, the Create Loan endpoint allows users to submit a request for loan application. Users provide information about the loan, including invoice data, required financing amount, currency, and financing type.

Query Parameters

Either one or any combination of these query params can be used to specify the user whose contract needs signing. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Request Body Parameters

invoice_data (Array{FileDto}, required): Invoice data that needs to be financed for the customer or any proof of financing need
\n
required_financing (number, required): User's required financing amount
\n
trade_financing_type (TRADE_FINANCING_TYPE, optional): type of financing (default to invoice_financing)
\n
currency (CURRENCY, optional): currency in which financing is required (default to pkr)
\n
tenure (number, optional): tenure of the loan in number of days
\n
disbursement_account_details (CreateBankDetailsDto , optional): details of bank account where the financing amount needs to be disbursed. In case of no bank details provided here, finance will choose one of the customers bank or contact in case of no bank present for the customer
\n

enum TRADE_FINANCING_TYPE {\n  PO_FINANCING = 'po_financing',\n  INVOICE_FINANCING = 'invoice_financing',\n  OTHER = 'other',\n}\nenum CURRENCY {\n  USD = 'usd',\n  AED = 'aed',\n  PKR = 'pkr',\n}\nconst CreateBankDetailsDto = {\n  bankCode: string,\n  accountTitle: string,\n  accountNumber: string,\n  iban?: string,\n};\n\n

Response Body

See sample response.

The next step is to approve the finance request application and disburse the loan. These part of the process is done again executed by CreditBook internally however, this API can be invoked twice in the following manner to simulate these two processes.

Send status as approved with approved request details or send status as rejected
Send status as disbursed

Note

Approve, Reject, or Disburse a loan with id = loan_id

Please use the API taking these under consideration

A loan can only be approved/rejected if it is in under_review, or in any previous state. The loan state right after creation is usually under_review. Otherwise, will throw an error
A loan can only be only be disbursed if it is in approved state. Otherwise, will throw an error.

Request Body Parameters

status (approved | rejected | disbursed, required): updated status of the loan.
principal_amount (number, required only when status = approved): The approved amount for the financing.
tenure (number, required only when status = approved): User's required financing amount
reason (string, optional): reason for financing the application
comment (string, optional): any other comment to be added

class ProcessSandboxLoanBodyDto {\n  status: 'approved' | 'rejected' | 'disbursed',\n  comment?: string,\n  reason:? string,\n  principal_amount: number ==> (Required when status='approved' otherwise is optional),\n  tenure: number ==> (Required when status='approved' otherwise is optional),\n}\n\n

Response Body

See sample response.

Now, as the finance application is requested, approved, and disbursed, we now expect the customer to repay the loan. However, the customer needs an address (typically a bank account details) for repayments. Therefore, this API basically helps in generating a dummy virtual account for the user. These details can be viewed at the customer's end using the Get /repayment-details API. This process is again executed by CreditBook internally, which creates a real virtual account for the user to repay but for simulation purposes, this API can be invoked to create the repayment details for the user.

Query Parameters

Either one or any combination of these query params can be used to fetch the user repayment details. Alteast one query param needs to exist in the request.

email: string
contactNumber: string - must be in format +92XXXXXXXXXX
ntn: string
external_user_id: string

Note

This endpoint will throw error with message: Virtual account already exists if an account already exists.

Once the repayment address is provided to the customer, we now expect user to create repayment transactions. This API helps in this operation by creating a loan-transaction in processing state. This doesn't affect the balances of the loan until the transaction is processed through process-transaction API.

Request Parameters

loan_id (string, required): id of loan for which the repayment is created. Can be retrieved from get-all-loans API

Request Body Parameters

user_id (string, required): id of the kyb document of the user
\n
amount (number, required): the amount repayed
\n
type (\"repayment\", required): Always send repayment string in this param
\n
payment_date (DateString, required): date in UTC at which the repayment was made.
\n
method (PaymentMethod, required): method of repayment
\n
transaction_image (string, required): downloadable link to the image/document for proof of repayment
\n

class CreateLoanTransaction {\n  user_id: string\n  amount: number;\n  type: TransactionType;\n  payment_date: Date;\n  method: PaymentMethod;\n  transaction_image?: string; // This is the link to the image/document. It should be downloadable.\n}\nexport enum PaymentMethod {\nBANK_TRANSFER = 'bank_transfer',\nCASH_VIA_FSO = 'cash_via_fso',\nONE_BILL = 'one_bill',\nONLINE_CASH_DEPOSIT = 'online_cash_deposit',\nCLEARING_CHEQUE_DEPOSIT = 'clearing_cheque_deposit',\n}\n\n

Response Body

See sample response.

Now, since a repayment is already created in pending state, our internal team verifies the payment and then either approves or rejects this transaction so that it reflects on the loan balances. with id = tx_id for loan with id = loan_id.

Request Parameters

loan_id (string, required): id of loan for which the repayment is created. Can be retrieved from get-all-loans API
tx_id (string, required): id of the transaction which is being processed. Can be retrieved from get-all-transactions API for the given loan

Request Body Parameters

status (approved | cancelled, required): after process status of the transaction.

Note:

Please use the API taking these under consideration

A transaction can only be processed once.
Approving a transaction that also completes the loan would automatically mark the loan as completed too. This means that this ends the whole financing journey for one application.

Response Body

See sample response.

To embark on your lending journey as a partner, we recommend following the happy flow to acquaint yourself with the entire process. To begin, you'll need to be whitelisted (if not already) for access to the lending sandbox APIs. Being whitelisted implies that you also possess your partner_id and api_key for the login API provided below.

Upon providing this documentation, we will be sharing the partner_id and api_key with you as well. Please contact us if it is not yet provided.

Please call this API to acquire a token, valid for 30 minutes, which should be attached in the header as a Bearer token for authentication purposes.

In this particular documentation, you can add the token in Public Lending API folder authentication and all other APIs would automatically inherit the authentication from this parent folder.

\n","_postman_id":"7ec23dd9-a3c8-4ad1-8d2b-27a33284c345","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"Integration APIs","item":[{"name":"Lending Users","item":[{"name":"Create Lending User","item":[],"id":"a83a6093-d31d-4995-b861-7857594a9d8b","description":"

Refer to this API for creating a lending user.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d0c15a9a-3166-4707-b4f5-0e4c286778ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7f8e4a61-c003-46e4-93c8-49a14e426502","type":"text/javascript","exec":[""]}}],"_postman_id":"a83a6093-d31d-4995-b861-7857594a9d8b"},{"name":"Get Contract URL","item":[],"id":"56470cee-f7c7-4568-a279-8c93108c5bb9","description":"

Refer to this API for fetching latest pending contract URL

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e2ba28a2-dc11-4151-a627-6032c936493c","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"ae8d22e9-e660-4e0a-9169-709bdfa3a941","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"56470cee-f7c7-4568-a279-8c93108c5bb9"},{"name":"get-lending-user","id":"04b3e24e-21dd-4703-abf8-7c042bad4fb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/users?email=DanteSparta18@gmail.com","description":"

Gets information of the user whose email , contactNumber, ntn, and/or external_user_id is passed in the query parameters. If no matching user exists then it returns null.

Query Parameters

Either one or any combination of these query params can be used to fetch the user. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Response Body

Following is the KYB type in the response.

interface response {\n  kyb: IKyb,\n}\ninterface IKyb {\n  _id: ObjectId;\n  fullName: string;\n  email?: string; //will be present if provided for the user at creation\n  contactNumber: string;\n  businessName: string;\n  businessType: KYBBusinessType;\n  businessAddress: string;\n  ntn: string;\n  status: CustomerStatus;\n  city?: string;\n  statuses?: Status[];\n  company_type?: CompanyType;\n  available_credit_limit: number; //will be available if signed contract is present in valid state. Will exclude pending amounts from active loans\n  active_loans: number; // will be present if signed contract is present in valid state and will include loans in Disbursed, Overdue, and Default state\n  display_id: string; \n  credit_limit: number; //will be available if signed contract is present in valid state\n  markup: number; //will be available if signed contract is present in valid state\n  proposed_credit_limit?: number; //will be available if contract is generated but yet to be signed\n  proposed_markup?: number; //will be available if contract is generated but yet to be signed\n  facilities: IFacility[]; //contains all contract details\n  // kyb files\n  industry?: string;\n  product?: string;\n  product_codes?: string | string[];\n  yearsExperienceProduct?: number;\n  partnerCnic?: IFile[];\n  partnershipDeed?: IFile[];\n  incorporationCertificate?: IFile[];\n  authorityLetter?: IFile[];\n  directorsResolution?: IFile[];\n  memorandumArticlesAssociation?: IFile[];\n  boardMemberCnic?: IFile[];\n  pocCnic?: IFile[];\n  beneficialOwnerCnic?: IFile[];\n  cnicFront?: IFile[];\n  cnicBack?: IFile[];\n  proprietorshipDeclaration?: IFile[];\n  ntnCertificate?: IFile[];\n  bankStatement?: IFile[];\n  financialStatement?: IFile[];\n  addendum?: IFile[];\n  formAB?: IFile[];\n  external_user_id?: string; //will be present if provided at the time of creation\n  created_at: Date;\n  updated_at: Date;\n}\nexport enum CustomerStatus {\n  IN_PROGRESS = 'in_progress',\n  APPROVED = 'approved',\n  REJECTED = 'rejected',\n  PENDING = 'pending',\n}\nenum CompanyType {\n  PUBLIC = 'public_limited_company',\n  PRIVATE = 'private_limited_company',\n}\nenum KYBBusinessType {\n  PARTNERSHIP = 'partnership',\n  SOLE_PROPRIETORSHIP = 'soleProprietorship',\n  COMPANY = 'company',\n  INDIVIDUAL = 'individual',\n  BRANCH_OFFICE = 'branchOffice',\n  NONE = 'none',\n}\ninterface Status {\n  status: string;\n  timestamp: Date;\n  updated_by: string;\n  reason?: string;\n  comment?: string;\n}\ninterface IFacility {\n  id: string;\n  envelope_id: string;\n  envelope_url: string;\n  credit_limit: number;\n  markup: number;\n  contract_documents: string[];\n  contract_details: any;\n  signing_date: Date;\n  expiry_date: Date;\n  status: ContractStatus;\n  status_history: Status[];\n}\nenum ContractStatus {\n  CONTRACT_VALID = 'contract_valid',\n  CONTRACT_EXPIRED = 'contract_expired',\n  CONTRACT_PENDING = 'contract_pending',\n}\ninterface IFile {\n  name: string;\n  resourceURL: string;\n  size: number;\n  verified: boolean;\n}\n\n

See sample response (may not contain every property that will be returned due to status)

Note

kyb.credit_limit will depict assigned credit_limit for user.
\n
kyb.status will depict current status of user’s profile (pending, approved or rejected).
\n
The reason for rejection will be present in the kyb.statuses array. Check example:
\n

\"statuses\": [\n  {\n      \"status\": \"under_review\",\n      \"timestamp\": \"2023-10-04T13:22:20.750Z\",\n      \"updated_by\": \"system\"\n  },\n  {\n      \"status\": \"rejected\",\n      \"timestamp\": \"2023-10-04T14:05:38.281Z\",\n      \"updated_by\": \"645264057a20e4d48a6530f0\",\n      \"reason\": \"Documents expired/name not matching\"\n  }\n]\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v1","external-lending","sme","users"],"host":["{{base_url_lms}}"],"query":[{"key":"email","value":"DanteSparta18@gmail.com"}],"variable":[]}},"response":[{"id":"6d7a682a-cd19-4307-99b8-b3c3737e2501","name":"response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url_lms}}/v1/external-lending/sme/users?email=DanteSparta18@gmail.com","host":["{{base_url_lms}}"],"path":["v1","external-lending","sme","users"],"query":[{"key":"email","value":"DanteSparta18@gmail.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 26 Mar 2024 06:50:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5486"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"300;w=60"},{"key":"RateLimit-Limit","value":"300"},{"key":"RateLimit-Remaining","value":"298"},{"key":"RateLimit-Reset","value":"16"},{"key":"ETag","value":"W/\"156e-faL6v270glWzqT9eFfmVRnU60O4\""}],"cookie":[],"responseTime":null,"body":"{\n \"kyb\": {\n \"refund_dispute_amount\": 0,\n \"_id\": \"66027000caaa9d57100817a7\",\n \"email\": \"DanteSparta18@gmail.com\",\n \"contactNumber\": \"+923361234567\",\n \"fullName\": \"MadDante\",\n \"businessName\": \"Riot Games\",\n \"display_id\": \"OR-K-P5UUTB\",\n \"businessType\": \"company\",\n \"businessAddress\": \"123/4 - 11 - Korangi, Karachi\",\n \"ntn\": \"111111111\",\n \"status\": \"pending\",\n \"statuses\": [\n {\n \"status\": \"pending\",\n \"timestamp\": \"2024-03-26T06:49:36.026Z\",\n \"updated_by\": \"system\",\n \"reason\": \"Update by User\"\n }\n ],\n \"directorsResolution\": [\n {\n \"name\": \"picture_1.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/directorsResolution/0-e27c5c04-5ee2-479f-bcd5-2f0433ff075b.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=5aaff0c7e8fa3201f1c363587b5056a14f177db61a4e6f1cc3f5ba9aef321a9b&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n },\n {\n \"name\": \"picture 2.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/directorsResolution/1-c0145e2f-f96d-4e43-ae7d-f28f36a7e772.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=7bc8e2e1e05a98061ff405157eaf1f57eb292d706f96264eb7bd406b9b8acb72&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"memorandumArticlesAssociation\": [\n {\n \"name\": \"picture_3.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/memorandumArticlesAssociation/0-33c30a30-9528-49b8-86a8-e5cf91d8482b.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=ef0c29e27f16be657c8538315474d6ec12169f880ac08e2d6d599f435942ae5a&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"boardMemberCnic\": [\n {\n \"name\": \"placeholder-name.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/boardMemberCnic/0-9ef4d429-a854-483e-8fd3-cea35a511c84.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=98bbaa937c8a2daed184d038457ee0bfe8ba751eb13be5bd8153f5ae5545da2c&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"pocCnic\": [\n {\n \"name\": \"placeholder-name.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/pocCnic/0-24fbc676-cb1e-43dc-a52b-74a94e4444c6.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=ebe062867e427c2819c82319a7adfbd2524425ebd636d4dc2f41efedaa856a40&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"beneficialOwnerCnic\": [\n {\n \"name\": \"placeholder-name.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/beneficialOwnerCnic/0-1e7b862d-8a7c-41e5-9138-179e721363d8.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=a066e82fd60be0fe94adb52e3ec26421440d7a6ae15310b6717637ac1f1734da&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"pastPurchaseOrders\": [\n {\n \"name\": \"placeholder-name.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/pastPurchaseOrders/0-f6839919-2c5d-45d3-8864-27c803e5b3fb.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=d575b8d82d40872428973643698857c3999dfc30228b1c5d54b29ee21054ae15&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"pastInvoices\": [\n {\n \"name\": \"placeholder-name.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/pastInvoices/0-cafc30bf-7eb7-4e34-b689-274375a36c8d.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=7e08dfa28b696dedbdf1b3e7c111b1caa9261a01d6dbf1d138db9ecbaea01ff3&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"otherFiles\": [\n {\n \"name\": \"placeholder-name.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/66027000caaa9d57100817a7/otherFiles/0-90f539b7-0bc9-4aa2-b46b-a3970a42a05f.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GXKNUIQNK%2F20240326%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20240326T065059Z&X-Amz-Expires=3600&X-Amz-Signature=a650fe139be06fe876102abf7cd87ca595b96d217a161a84e40526872f23a2c0&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"size\": 1370168\n }\n ],\n \"facilities\": [\n {\n \"envelope_id\": \"66e82d4092bbb6b303bda7e9\",\n \"envelope_url\": \"https://stag-secure.dashsign.co/?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbnZlbG9wZV9pZCI6IjY2ZTgyZDQwOTJiYmI2YjMwM2JkYTdlOSIsInJlY2lwaWVudF9pZCI6IjY2ZTJjNTMxZDc2MzE2NzU1YzI2YWRlMiIsImlhdCI6MTcyNjQ5MTk2OCwiZXhwIjoxNzI5MDgwMzY4fQ.fGp1cgtsm5lLv4KJQQW3sySp3eeR-HkhlZlBeMCyrPI\",\n \"credit_limit\": 100000,\n \"markup\": 30,\n \"contract_documents\": [\n \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/Contract_document_1_66e2c531d76316755c26ade2_1727184943.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GYZCBJV45%2F20241120%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20241120T064506Z&X-Amz-Expires=3600&X-Amz-Signature=72f88fb31c1cf922c10f2c60ae4839a22c708cc0148b8e408b7b71851a4f58e4&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/Contract_document_2_66e2c531d76316755c26ade2_1727184943.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GYZCBJV45%2F20241120%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20241120T064506Z&X-Amz-Expires=3600&X-Amz-Signature=8ad4c64c19c42a0afa43b8e660dc7826437cf4061bd4aa5f8c8a36dc3bcf5778&X-Amz-SignedHeaders=host&x-id=GetObject\",\n \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/Contract_document_3_66e2c531d76316755c26ade2_1727184943.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GYZCBJV45%2F20241120%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20241120T064506Z&X-Amz-Expires=3600&X-Amz-Signature=67eccb6cda947756645e6e003bc891f015428fcbba1827acb11850392418876c&X-Amz-SignedHeaders=host&x-id=GetObject\"\n ],\n \"signing_date\": \"2024-09-24T13:35:43.579Z\",\n \"expiry_date\": \"2054-09-24T13:35:43.579Z\",\n \"status_history\": [\n {\n \"status\": \"contract_pending\",\n \"timestamp\": \"2024-09-16T13:06:09.000Z\",\n \"updated_by\": \"system\"\n },\n {\n \"status\": \"contract_valid\",\n \"timestamp\": \"2024-09-24T13:35:43.580Z\",\n \"updated_by\": \"system\"\n }\n ],\n \"contract_details\": {\n \"language\": \"en\",\n \"designation\": \"dummy\",\n \"gender\": \"male\",\n \"male_relative\": \"father\",\n \"facility_amount_digits\": \"100000\",\n \"facility_markup\": \"30\",\n \"facility_tenure\": \"30\",\n \"net_worth_digits\": \"1000000\",\n \"loan_purpose\": \"testing\",\n \"cnic_number\": \"111111111\"\n },\n \"status\": \"contract_valid\",\n \"amendments\": []\n }\n ],\n \"available_credit_limit\": 100000,\n \"credit_limit\": 100000,\n \"markup\": 30,\n \"contractual_credit_limit\": 100000,\n \"created_at\": \"2024-03-26T06:49:36.031Z\",\n \"updated_at\": \"2024-03-26T06:49:41.742Z\",\n \"id\": \"66027000caaa9d57100817a7\"\n }\n}"}],"_postman_id":"04b3e24e-21dd-4703-abf8-7c042bad4fb7"},{"name":"update-lending-user","id":"787ade6b-16ff-416e-ba38-48cd7e1d07b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"DanteSparta18@gmail.com\",\n \"fullName\": \"MadDanteNew\",\n \"ntn\": \"12345678\",\n \"businessAddress\": \"Hyderabad, Sindh, Pakistan\",\n \"contactNumber\": \"+923351234567\",\n \"businessName\": \"Riot Games New\",\n \"memorandumArticlesAssociation\": [\n {\n \"name\": \"memorandumAA-New\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"pocCnic\": [\n {\n \"name\": \"pocCnic-New\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/users","description":"

This API updates an existing lending user whose email , contactNumber, ntn, and/or external_user_id is passed in the query parameters. All KYB/KYC information to be changed is entered via the API body. Since this is an update, not all information is mandatory all the time related to the required KYB information based on business_type. Also, once the information is updated, the status of KYB again goes to under_review and the user is blocked from creating any further finance requests until the KYB is approved again from CB. To simulate processing KYB, you can access the Process KYB API.

If the KYB was rejected, subsequent requests for updates may result in an error response. In some cases, a cooldown time may be assigned to KYB applications. Once the cooldown time expires, an update request will be accepted.

Query Parameters

Either one or any combination of these query params can be used to fetch the user that needs to be updated. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Note

Fields to be updated are to be sent in the request body with their corresponding values. All fields are optional.

For backward compatibility we still allow the email of the user, to be sent in the request body. However you are reccomended to send the user search params in the query params of the request.

Request Body Parameters

Applicable for All Business Types

external_user_id: string - (optional) - field if partner would like to link their user identifier. It is recommended to send this all the time.
\n
fullName: string - (optional)
\n
contactNumber: string - (optional) - in format +92xxxxxxxxxx - must be unique
\n
businessName: string - (optional)
\n
businessType: individual | branchOffice | partnership | company | soleProprietorship - (optional)
\n
businessAddress: string - (optional)
\n
pastPurchaseOrders: Array{FileDto} - (optional)
\n
pastInvoices: Array{FileDto} - (optional)
\n
financialStatement: Array{FileDto} - (optional)
\n
otherFiles: Array - (optional) - Any extra files that partner has. name must be present to demonstrate what the file is about.
\n
bankDetails: bankDetailsDto - (optional) - has 3 mandatory fields i.e. accountTitle, accountNumber and bankCode and 1 optional (but recommended) field for iban. Use get-banks api for bankCode.
\n

Fields if businessType is individual

cnicFront - Array{FileDto} - (optional)
\n
cnicBack - Array{FileDto} - (optional)
\n

Fields if businessType is soleProprietership

cnicFront - Array{FileDto} - (optional)
\n
cnicBack - Array{FileDto} - (optional)
\n
proprietorshipDeclaration - Array{FileDto} - (optional) - Proprietorship Declaration Letter from the Bank
\n
ntnCertificate - Array{FileDto} - (optional)
\n
bankStatement - Array{FileDto} - (optional) - bank statement of 6 months
\n

Fields if businessType is partnership

partnerCnic: Array{FileDto} - (optional) - CNICs of all Partners (Front and Back in Single file)
\n
partnershipDeed: Array{FileDto} - (optional) - Attested copy of Partnership Deed
\n
incorporationCertificate: Array{FileDto} - (optional) - Attested copy of Registration Certificate with Registrar of Firms
\n
authorityLetter: Array{FileDto} - (optional) - Authority letter from all partners, in original, authorizing the person(s) to operate firm’s account
\n

Fields if businessType is company

directorsResolution: Array{FileDto} - (optional) - Certified Copy of Resolution of Board of Directors for opening of account
\n
memorandumArticlesAssociation: Array{FileDto} - (optional) - Certified Copy of Memorandum and Articles of Association
\n
boardMemberCnic: Array{FileDto} - (optional) - CNICs of all Board members (Front and Back in Single file)
\n
pocCnic: Array{FileDto} - (optional) - CNIC of the Person authorized as Point of Contact
\n
beneficialOwnerCnic:Array{FileDto} - (optional) - CNICs of the beneficial owners (Front and Back)
\n
addendum: Array{FileDto} - (optional) - Form II in case of newly incorporated company and Form A/Form C whichever is applicable; and Form 29 if already incorporated company
\n
formAB: Array{FileDto} - (optional) - Certified copy of Latest Form-A/Form-B
\n

Fields if businessType is branchOffice

permissionLetter - Array{FileDto} - (optional) - Permission letter from relevant authority i-e Board of Investment
\n
signatoryPassports - Array{FileDto} - (optional) - Valid passports of all the signatories of account
\n
formIIParticulars - Array{FileDto} - (optional) - Form II about particulars of directors, Principal Officer etc. in case of newly registered branch or liaison office of a foreign company
\n
principalOfficeAuthorization - Array{FileDto} - (optional) - A Letter from Principal Office of the entity authorizing the person(s) to open and operate the account
\n

FileDTO Type

Please make sure to send FileDto typed files in the following format. Convert to array of objects where applicable

type FileDto {\n     resourceURL: string; // This is the link to the image/document. It should be downloadable.\n     name?: string // optional description of the file\n}\n\n

BankDetailsDTO Type

type BankDetailsDto {\n     bankCode: string; // bank code associated with the user's bank (use get-banks api) \n     accountTitle: string // bank account title\n     accountNumber: string //bank account number\n     iban?: string //IBAN of the given bank account number\n}\n\n

These APIs focus on performing CRUD operations for lending user-specific data.

\n","_postman_id":"9a91e260-1f61-4bcb-952b-6d24e700db85","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"Loan-Transactions","item":[{"name":"Create Transaction","item":[],"id":"8988b3de-dc06-4114-ba72-24b165adc246","description":"

Refer to this API for creating a loan transaction of a disbursed loan

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"dcda49db-4178-4dff-9ae3-b040e6471810","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b50c19e4-557b-404d-acc8-477e11488f96","type":"text/javascript","exec":[""]}}],"_postman_id":"8988b3de-dc06-4114-ba72-24b165adc246"},{"name":"get-all-transactions","id":"3624c3b9-0791-4a4d-adfd-3be00fd6cf6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/loans/65c62405c5f722d4ad492b8e/transaction","description":"

This API helps in getting all loan transactions of a selected loan. This would also include all the disbursement and repayment transactions

Request Parameters

loan_id (string, required): loan id for which the transactions are to be retrieved

Response Body

See sample response.

This API won't be much useful at the user side however, partners can use it to fetch the transaction with id=transaction_id of loan with id=loan_id of any loan. Please make sure to send correct ids otherwise will throw not found error.

Request Parameters

loan_id (string, required): loan id for which the transaction details is to be retrieved
transaction_id (string, required): transaction id whose details are to be retrieved

Response Body

See sample response.

These APIs focus on performing CRUD operations for loans-transactions

\n","_postman_id":"96060405-53e6-4f81-8999-443c6dbf3f0c","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"Loans","item":[{"name":"Create Loan","item":[],"id":"70096d60-5dfa-4567-a9b0-2ce766240245","description":"

Refer to this API for creating a loan of a user

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"dcda49db-4178-4dff-9ae3-b040e6471810","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b50c19e4-557b-404d-acc8-477e11488f96","type":"text/javascript","exec":[""]}}],"_postman_id":"70096d60-5dfa-4567-a9b0-2ce766240245"},{"name":"get-all-loans","id":"3282dfe7-7d16-4de8-9239-9b983a5493d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/loans?email=DanteSparta20@gmail.com&loanStatuses=under_review, disbursed","description":"

This API helps in getting all of the user whose email, contactNumber, ntn, and/or external_user_id is passed in the query parameters. If no loans exist, returns an empty array. This should typically be used to display all the loans to the user.

Request Query Parameters

email/ntn/external_user_id/contactNumber (string, required): any of the customer's unique identifier for which the loans are to be fetched
\n
loanStatuses (string, optional): comma separated statuses for the loans to be fetched. If not sent in the request then loans of all statuses will be fetched. Following are the possible statuses of loans:
\n

enum FinanceAppState {\n  // Initial Statuses - Can be considered as Under Review\n  IN_PROGRESS = 'in_progress',\n  UNDER_REVIEW = 'under_review',\n  REVISION_REQUESTED = 'revision_requested',\n  AWAITING_LM_APPROVAL = 'awaiting_lm_approval',\n  AWAITING_ADMIN_APPROVAL = 'awaiting_admin_approval',\n  // Active loan statuses\n  APPROVED = 'approved',\n  READY_TO_DISBURSE = 'ready_to_disburse',\n  DISBURSED = 'disbursed',\n  OVERDUE = 'overdue',\n  DEFAULT = 'default',\n  // terminal\n  REJECTED = 'rejected',\n  COMPLETED = 'completed',\n}\n\n

Note

To see how to figure out statuses or reasons for a particular loan, check the Get Loan By ID API. Same logic would apply here.

loan.pending will depict current outstanding amount.
\n
loan.status will depict current status of loan (under_review, approved, disbursed, overdue, completed or rejected).
\n
The reason for rejection will be present in the loan.statuses array. The latest status will have the relevant reason. For example:
\n

\"statuses\": [\n  {\n      \"status\": \"under_review\",\n      \"timestamp\": \"2023-10-04T13:22:20.750Z\",\n      \"updated_by\": \"system\"\n  },\n  {\n      \"status\": \"rejected\",\n      \"timestamp\": \"2023-10-04T14:05:38.281Z\",\n      \"updated_by\": \"645264057a20e4d48a6530f0\",\n      \"reason\": \"Documents expired/name not matching\" <--- Mentioned Reason\n  }\n]\n\n

Query Parameters

Either one or any combination of these query params can be used to fetch the loans of the user. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Optioanl Query Param:

loanStatuses: string - (optional) - comma-separated value for loan statuses (by default will fetch loans with all statuses.

Response Body

Following is the loan type in the response.

interface response {\n  loans: ILoan,\n}\ninterface ILoan {\n  _id: ObjectId;\n  display_id: string;\n  user_id: string;\n  customer_name: string;\n  disbursement_date?: Date;\n  principal_amount?: number;\n  statuses?: StatusObject[];\n  status: FinanceAppState;\n  type: LoanType;\n  tenure?: number;\n  business_type?: BusinessSegmentType;\n  markup?: number;\n  markup_per_day?: number;\n  due_date?: Date;\n  payments?: {\n    principal_repaid: number;\n    late_fees: number;\n    markup_fee: number;\n  };\n  pending?: {\n    principal: number;\n    late_fees: number;\n    markup_fee: number;\n  };\n  disbursement_account_details?: {\n    account_number: string;\n    account_title: string;\n    bank_code: string;\n    iban?: string;\n  };\n  disbursement_account_id?: string; // This will be a bank account id in our bank accounts collection\n  raw?: string;\n  created_at?: Date;\n  updated_at?: Date;\n  external_images?: any;\n  external_user_id?: string;\n}\nenum BusinessSegmentType {\n  SME = 'sme',\n  MSME = 'msme',\n}\nenum LoanType {\n  FIXED = 'fixed',\n  DAILY = 'daily',\n}\nenum FinanceAppState {\n  // Initial Statuses - Can be considered as Under Review\n  IN_PROGRESS = 'in_progress',\n  UNDER_REVIEW = 'under_review',\n  REVISION_REQUESTED = 'revision_requested',\n  AWAITING_LM_APPROVAL = 'awaiting_lm_approval',\n  AWAITING_ADMIN_APPROVAL = 'awaiting_admin_approval',\n  // Active loan statuses\n  APPROVED = 'approved',\n  READY_TO_DISBURSE = 'ready_to_disburse',\n  DISBURSED = 'disbursed',\n  OVERDUE = 'overdue',\n  DEFAULT = 'default',\n  // terminal\n  REJECTED = 'rejected',\n  COMPLETED = 'completed',\n}\ninterface Status {\n  status: string;\n  timestamp: Date;\n  updated_by: string; // user_id of LMS personnel\n  reason?: string;\n  comment?: string;\n}\n\n

See sample response (may not contain every property that will be returned due to status)

This gets the specific loan based on id passed in request parameters. This should not be used by the customer as there is no user validation in this API however, partners can use it for their own ease to get details of certain loans of their users.

Request Parameters

loan_id (string): The unique identifier of the loan.

Response Body

See sample response. (Or see get-all-loans response for one element)

API is used to mark refund in the system.

{\n    \"principal_amount\": 1000, // mandatory\n    \"reason\": \"reason for refund\", // non mandatory \n    \"type\": \"refund\" // type can be refund or dispute\n}\n\n

Note: This endpoint can only be configuratively enabled and wouldn't be available for all partner by default.

This API is to be used at user side for them to get their repayment details and instructions for repaying. If the virtual account isn't created yet, this would return an appropriate message with repayment details as null.

Request Query Parameters

email/ntn/external_user_id/contactNumber (string, required): any of the customer's unique identifier for which the repayment-details are to be fetched

Response Body

See sample response.

This API helps in predicting the balances of the loan at the end of it's tenure given that the full repayment took all of the loan's tenure. This API can be used to gain insights while creating or approving a finance application.

Request Parameters

user_id (string, required): id of the kyb object of the user
\n
disbursement_date (DateString, optional): default to today's date minus the tenure but can be set by sending as well
\n
today_date (DateString, optional): default on today's date. Used to choose which day to simulate balances for.
\n
tenure (number, required): tenure of the loan whose balances are to be predicted
\n
principal_amount (number, required): financing amount of the loan that will be disbursed to the user.
\n

Response Body

See sample response.

Purpose:

API is used to mark refund in the system.

{\n    \"principal_amount\": 1000, // mandatory\n    \"reason\": \"reason for refund\", // non mandatory \n    \"type\": \"refund\" // type can be refund or dispute\n}\n\n

Note: This endpoint can only be configuratively enabled and wouldn't be available for all partner by default.

loan id to refund for

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6e4d86db-0968-47df-ab49-88bd40affa20","name":"response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"invoice_data\": [\n {\n \"name\": \"invoice_doc_new\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/loans/65c5d9e646eac4f838561e8a"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Feb 2024 07:57:30 GMT","uuid":"d1dec587-293f-4de9-8a17-24ed99a39d73"},{"key":"Content-Type","value":"application/json; charset=utf-8","uuid":"1d40d41c-50ad-4c79-b6c4-c5a7a2b19bef"},{"key":"Content-Length","value":"1533","uuid":"20fc2a81-59b7-4a62-af00-383265c790ed"},{"key":"Connection","value":"keep-alive","uuid":"b487692e-20d2-423f-a208-99b5e4895b4d"},{"key":"Access-Control-Allow-Origin","value":"*","uuid":"28e85eb9-98dd-4390-a369-175cb9136d26"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","uuid":"2e0295a9-a211-4c0c-81bd-fdf52d2bd765"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","uuid":"e2c34d62-f262-4af8-bbc5-6854208283f1"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","uuid":"8186a15a-3512-4b3b-a094-44da1a646832"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin","uuid":"1a24c999-5d27-44ba-b502-0a0faf5b6c9d"},{"key":"Origin-Agent-Cluster","value":"?1","uuid":"e4d2e51e-9349-49b3-ac94-af7fa689dfd7"},{"key":"Referrer-Policy","value":"no-referrer","uuid":"2f1e874f-d330-4533-a92f-472d0af9d78b"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains","uuid":"aed2aa42-5eb2-4b4e-a9c2-9c5afebcd80b"},{"key":"X-Content-Type-Options","value":"nosniff","uuid":"9afac39d-139a-4228-ad27-bddb5ea7f14e"},{"key":"X-DNS-Prefetch-Control","value":"off","uuid":"77921d79-d4d1-414b-a182-3df5c991868a"},{"key":"X-Download-Options","value":"noopen","uuid":"e2dbb528-74f2-4c51-8116-fb0ca793b7f6"},{"key":"X-Frame-Options","value":"SAMEORIGIN","uuid":"58adea53-66a9-4fd6-aaf6-e2bc489208ab"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","uuid":"74809883-ca6a-401d-879c-7f758cfb6321"},{"key":"X-XSS-Protection","value":"0","uuid":"1740a9bc-a32f-433d-a034-f2539536d5db"},{"key":"RateLimit-Policy","value":"300;w=60","uuid":"ba63dee1-8140-4a0c-b3e2-57bff79c0b6f"},{"key":"RateLimit-Limit","value":"300","uuid":"a197837c-5329-4f45-863c-c0b0830ed65e"},{"key":"RateLimit-Remaining","value":"299","uuid":"5115381a-2c73-4463-9a14-e3fccdd31766"},{"key":"RateLimit-Reset","value":"4","uuid":"365c5520-c04c-4f30-8dda-ebb54ef309bd"},{"key":"ETag","value":"W/\"5fd-8+xLtRc9bWnPj4XDLUOjuWDhkuE\"","uuid":"f76d708e-058b-4613-a491-e5b97da63f01"}],"cookie":[],"responseTime":null,"body":"{\n \"loan\": {\n \"_id\": \"65c5d9e646eac4f838561e8a\",\n \"invoice_data\": [\n {\n \"name\": \"Invoice_Doc_1.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/65c5d21e055f2cea81524164/invoice_data/0-9f9b1cf8-45f2-45f5-bc2f-5d60b8d9dd3e.png\"\n },\n {\n \"name\": \"Invoice_Doc_2.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/65c5d21e055f2cea81524164/invoice_data/1-d32e60cf-3705-4fe8-9a7d-a0853a9d4dbd.png\"\n },\n {\n \"name\": \"Invoice_Doc_3.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/65c5d21e055f2cea81524164/invoice_data/2-270d8178-8210-46a9-9825-dfe1063f6131.png\"\n },\n {\n \"name\": \"invoice_doc_new.png\",\n \"resourceURL\": \"https://cb-lending-staging.s3.ap-southeast-1.amazonaws.com/65c5d21e055f2cea81524164/invoice_data/3-bbbe4285-70e9-48da-89fa-1cd5ac8bd3ae.png\"\n },\n {\n \"name\": \"invoice_doc_new\",\n \"resourceURL\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Image_created_with_a_mobile_phone.png/1200px-Image_created_with_a_mobile_phone.png\"\n }\n ],\n \"required_financing\": 20000,\n \"user_id\": \"65c5d21e055f2cea81524164\",\n \"customer_name\": \"Riot Games New\",\n \"principal_amount\": 20000,\n \"statuses\": [\n {\n \"status\": \"under_review\",\n \"timestamp\": \"2024-02-09T07:53:10.462Z\",\n \"updated_by\": \"system\"\n },\n {\n \"status\": \"under_review\",\n \"timestamp\": \"2024-02-09T07:55:55.810Z\",\n \"updated_by\": \"system\"\n },\n {\n \"status\": \"under_review\",\n \"timestamp\": \"2024-02-09T07:57:30.357Z\",\n \"updated_by\": \"system\"\n }\n ],\n \"status\": \"under_review\",\n \"type\": \"daily\",\n \"created_at\": \"2024-02-09T07:53:10.502Z\",\n \"updated_at\": \"2024-02-09T07:57:30.357Z\",\n \"id\": \"65c5d9e646eac4f838561e8a\"\n }\n}"}],"_postman_id":"725f0e5b-429c-40c7-b4dd-272bd09b9b6d"}],"id":"5e119281-413a-4387-8afd-07a7fcdf5242","description":"

These APIs focus on performing CRUD operations for loans.

\n","_postman_id":"5e119281-413a-4387-8afd-07a7fcdf5242","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"Banks","item":[{"name":"get-banks","id":"9d9d3874-05ad-4654-b348-8e412eec8d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/banks","description":"

This API can be used to get the available banks that CB support. This can help in identifying the bank_code when submitting bank account details of the user

Response Body

See sample response.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v1","external-lending","sme","banks"],"host":["{{base_url_lms}}"],"query":[],"variable":[]}},"response":[{"id":"a34c444e-fdf7-46d9-8dcc-a15f217d12a3","name":"response","originalRequest":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/banks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 26 Mar 2024 06:55:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6266"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"300;w=60"},{"key":"RateLimit-Limit","value":"300"},{"key":"RateLimit-Remaining","value":"299"},{"key":"RateLimit-Reset","value":"3"},{"key":"ETag","value":"W/\"187a-rK0jlXe0M6JLXO0w+DijXRRCGVg\""}],"cookie":[],"responseTime":null,"body":"{\n \"banks\": [\n {\n \"bank_name\": \"First Women Bank Limited\",\n \"mnemonic\": \"FWBL\",\n \"bank_code\": \"047\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/first-women-bank.webp\",\n \"id\": \"6488347be63016c52e361ca3\"\n },\n {\n \"bank_name\": \"Askari Bank Limited\",\n \"mnemonic\": \"ASCM\",\n \"bank_code\": \"017\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/askari-bank.webp\",\n \"id\": \"6488347be63016c52e361c9b\"\n },\n {\n \"bank_name\": \"Bank Al-Falah Limited\",\n \"mnemonic\": \"BAFL\",\n \"bank_code\": \"053\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-alfalah.webp\",\n \"id\": \"6488347be63016c52e361c9c\"\n },\n {\n \"bank_name\": \"Bank Al-Habib Limited\",\n \"mnemonic\": \"BAHL\",\n \"bank_code\": \"023\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-al-habib.webp\",\n \"id\": \"6488347be63016c52e361c9d\"\n },\n {\n \"bank_name\": \"Albarka Islamic Bank\",\n \"mnemonic\": \"ABPL\",\n \"bank_code\": \"016\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/al-baraka.webp\",\n \"id\": \"6488347be63016c52e361c99\"\n },\n {\n \"bank_name\": \"Bankislami Pakistan Limited\",\n \"mnemonic\": \"BIPL\",\n \"bank_code\": \"021\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-islami.webp\",\n \"id\": \"6488347be63016c52e361c9e\"\n },\n {\n \"bank_name\": \"Allied Bank Limited\",\n \"mnemonic\": \"ABL\",\n \"bank_code\": \"014\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/allied-bank.webp\",\n \"id\": \"6488347be63016c52e361c9a\"\n },\n {\n \"bank_name\": \"NIB Bank Limited\",\n \"mnemonic\": \"NIB\",\n \"bank_code\": \"059\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/nib-bank.webp\",\n \"id\": \"6488347be63016c52e361ca9\"\n },\n {\n \"bank_name\": \"Standard Chartered Bank\",\n \"mnemonic\": \"SCB\",\n \"bank_code\": \"038\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/standard-chartered.webp\",\n \"id\": \"6488347be63016c52e361cae\"\n },\n {\n \"bank_name\": \"Sindh Bank Limited\",\n \"mnemonic\": \"SND\",\n \"bank_code\": \"043\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/sindh-bank.webp\",\n \"id\": \"6488347be63016c52e361cac\"\n },\n {\n \"bank_name\": \"Summit Bank Limited\",\n \"mnemonic\": \"SMBL\",\n \"bank_code\": \"081\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/summit-bank.webp\",\n \"id\": \"6488347be63016c52e361caf\"\n },\n {\n \"bank_name\": \"MCB Islamic Bank\",\n \"mnemonic\": \"MIB\",\n \"bank_code\": \"044\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/mcb-islamic-bank.webp\",\n \"id\": \"6488347be63016c52e361cb1\"\n },\n {\n \"bank_name\": \"Meezan Bank Limited\",\n \"mnemonic\": \"MBL\",\n \"bank_code\": \"\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/meezan-bank.webp\",\n \"id\": \"6488347be63016c52e361cb7\"\n },\n {\n \"bank_name\": \"Burj Bank Limited\",\n \"mnemonic\": \"BBL\",\n \"bank_code\": \"003\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/burj-bank.webp\",\n \"id\": \"6488347be63016c52e361c9f\"\n },\n {\n \"bank_name\": \"Habib Metropolitan Bank Limited\",\n \"mnemonic\": \"HMBL\",\n \"bank_code\": \"064\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/habib-metropolitan-bank.webp\",\n \"id\": \"6488347be63016c52e361ca5\"\n },\n {\n \"bank_name\": \"MCB Bank Limited\",\n \"mnemonic\": \"MCB\",\n \"bank_code\": \"062\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/mcb-bank.webp\",\n \"id\": \"6488347be63016c52e361ca7\"\n },\n {\n \"bank_name\": \"Soneri Bank Limited\",\n \"mnemonic\": \"SME\",\n \"bank_code\": \"085\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/soneri-bank.webp\",\n \"id\": \"6488347be63016c52e361cad\"\n },\n {\n \"bank_name\": \"Jazzcash\",\n \"mnemonic\": \"JC\",\n \"bank_code\": \"094\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/jazz-cash.webp\",\n \"id\": \"6488347be63016c52e361cb6\"\n },\n {\n \"bank_name\": \"Faysal Bank Limited\",\n \"mnemonic\": \"FBL\",\n \"bank_code\": \"060\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/faysal-bank.webp\",\n \"id\": \"6488347be63016c52e361ca2\"\n },\n {\n \"bank_name\": \"NayaPay\",\n \"mnemonic\": \"NP\",\n \"bank_code\": \"010\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/nayapay.webp\",\n \"id\": \"6492c9bf7d1885016ee7fd00\"\n },\n {\n \"bank_name\": \"SadaPay\",\n \"mnemonic\": \"SP\",\n \"bank_code\": \"050\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/sadapay.webp\",\n \"id\": \"6492c9ef7d1885016ee7fd2c\"\n },\n {\n \"bank_name\": \"National Bank Of Pakistan\",\n \"mnemonic\": \"NBP\",\n \"bank_code\": \"070\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/national-bank.webp\",\n \"id\": \"6488347be63016c52e361ca8\"\n },\n {\n \"bank_name\": \"Samba Bank Limited\",\n \"mnemonic\": \"SBL\",\n \"bank_code\": \"028\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/samba-bank.webp\",\n \"id\": \"6488347be63016c52e361caa\"\n },\n {\n \"bank_name\": \"JS Bank Limited\",\n \"mnemonic\": \"JS\",\n \"bank_code\": \"018\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/js-bank.webp\",\n \"id\": \"6488347be63016c52e361ca6\"\n },\n {\n \"bank_name\": \"Apna Microfinance Bank\",\n \"mnemonic\": \"AMB\",\n \"bank_code\": \"093\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/apna-microfinance-bank.webp\",\n \"id\": \"6488347be63016c52e361cb0\"\n },\n {\n \"bank_name\": \"United Bank Limited\",\n \"mnemonic\": \"UBL\",\n \"bank_code\": \"086\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/united-bank.webp\",\n \"id\": \"6488347be63016c52e361cb3\"\n },\n {\n \"bank_name\": \"Easypaisa\",\n \"mnemonic\": \"EP\",\n \"bank_code\": \"027\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/easy-paisa.webp\",\n \"id\": \"6488347be63016c52e361cb5\"\n },\n {\n \"bank_name\": \"Bank Of Khyber\",\n \"mnemonic\": \"BOK\",\n \"bank_code\": \"061\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-of-khyber.webp\",\n \"id\": \"6488347be63016c52e361cb4\"\n },\n {\n \"bank_name\": \"Dubai Islamic Bank\",\n \"mnemonic\": \"DIB\",\n \"bank_code\": \"013\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/dubai-islamic.webp\",\n \"id\": \"6488347be63016c52e361ca1\"\n },\n {\n \"bank_name\": \"Habib Bank Limited\",\n \"mnemonic\": \"HBL\",\n \"bank_code\": \"054\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/habib-bank.webp\",\n \"id\": \"6488347be63016c52e361ca4\"\n },\n {\n \"bank_name\": \"The Bank Of Punjab\",\n \"mnemonic\": \"BOP\",\n \"bank_code\": \"083\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-of-punjab.webp\",\n \"id\": \"6488347be63016c52e361cb2\"\n },\n {\n \"bank_name\": \"Silk Bank Limited\",\n \"mnemonic\": \"SILK\",\n \"bank_code\": \"066\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/silk-bank.webp\",\n \"id\": \"6488347be63016c52e361cab\"\n },\n {\n \"bank_name\": \"Mobilink Microfinance Bank\",\n \"mnemonic\": \"MMBL\",\n \"bank_code\": \"100\",\n \"bank_logo_img\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/mobilink-microfinance-bank.webp\",\n \"id\": \"654389658b20fc432940d20a\"\n }\n ]\n}"}],"_postman_id":"9d9d3874-05ad-4654-b348-8e412eec8d54"}],"id":"be9e12e0-58fa-486d-a551-637db6acb0a0","_postman_id":"be9e12e0-58fa-486d-a551-637db6acb0a0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"Bank-Accounts","item":[{"name":"get-bank-accounts","id":"5be3eb67-56ad-453d-99c9-97b4ddcd1d7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/bank-accounts?ntn=39943-29287285-0","description":"

Gets bank accounts of the user whose email , contactNumber, ntn, and/or external_user_id is passed in the query parameters. If no bank-account exists for the user then it returns empty array.

Query Parameters

Either one or any combination of these query params can be used to fetch the user. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Response Body

Following is the response type and also see sample response

interface response {\n  bankAccounts: Array<IBankAccount>,\n}\ninterface IBankAccount {\n  _id: ObjectId;\n  account_number: string;\n  account_title: string;\n  bank_code: string;\n  iban?: string;\n  mnemonic: BankMnemonic;\n  owner: Owner;\n  created_at: Date;\n  updated_at: Date;\n}\n\n

Creates a bank account detail document of the user whose email , contactNumber, ntn, and/or external_user_id is passed in the query parameters.

Query Parameters

Either one or any combination of these query params can be used to fetch the user. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Body Parameters

iban: <string, optional>
\n
bankCode: <string, required> - must be in format retrieved from get-banks API for the selected bank
\n
accountTitle: <string, required>
\n
accountNumber: <string, required>
\n

Response Body

Following is the response type and also see sample response

interface response {\n  createdBankAccount: IBankAccount,\n}\ninterface IBankAccount {\n  _id: ObjectId;\n  account_number: string;\n  account_title: string;\n  bank_code: string;\n  iban?: string;\n  mnemonic: BankMnemonic;\n  owner: Owner;\n  created_at: Date;\n  updated_at: Date;\n}\n\n

Updates an already existing bank account detail document whose id is sent in the API params, for the user whose email , contactNumber, ntn, and/or external_user_id is passed in the query parameters.

API Param

id: string- _id of the bank-account which needs to be updated

Query Parameters

Either one or any combination of these query params can be used to fetch the user. Alteast one query param needs to exist in the request.

email: string
\n
contactNumber: string - must be in format +92XXXXXXXXXX
\n
ntn: string
\n
external_user_id: string
\n

Body Parameters

iban: <string, optional>
\n
bankCode: <string, required> - must be in format retrieved from get-banks API for the selected bank
\n
accountTitle: <string, required>
\n
accountNumber: <string, required>
\n

Response Body

Following is the response type and also see sample response

interface response {\n  updatedBankAccount: IBankAccount,\n}\ninterface IBankAccount {\n  _id: ObjectId;\n  account_number: string;\n  account_title: string;\n  bank_code: string;\n  iban?: string;\n  mnemonic: BankMnemonic;\n  owner: Owner;\n  created_at: Date;\n  updated_at: Date;\n}\n\n

Upcoming Features

This collection is upcoming. Currently they are not live.

These APIs focus on performing CRUD operations for bank-account details of user

\n","event":[{"listen":"prerequest","script":{"id":"a6f6c876-8c4e-4891-9136-c4b57afdace2","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"25abdf0b-4e69-40dd-b1a4-4fafca158bcc","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"bc116974-c7eb-401d-adb5-1e26589f9009","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"S3","item":[{"name":"get-presigned-url","id":"fa5047c1-d6ef-4bae-b6ed-cc28ea875995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_lms}}/v1/external-lending/sme/s3/presigned-url?file_name=filename.png","description":"

This API helps in generating a presigned url to upload a document.

Request Query Parameters

file_name (string, required): name of the file, it is essential that the file name is appended with a valid extension to ensure the correct configuration of the MIME type.

Response Body

putPresignedURL : URL on which the document needs to be uploaded
\n
resourceURL : URL on which the uploaded document will exist
\n
getPreSignedURL: View-only URL for the document (resourceURL will be private by default)
\n
contentType: Mime Type for the document according to the extension of the file_name query parameter.
\n

The next step after generating the presigned url is to upload a document to this presigned url. Below is sample code for this next step in javascript:

const filePath = 'path/to/file'\nconst { contentType, putPresignedURL } = response; // response of the get-presigned-url API\naxios.put(putPresignedURL, filePath, {\n    headers: {\n        'Content-Type': contentType,\n    },\n});\n\n

This collection is related to file storage and retrieval

\n","_postman_id":"ad1d4edf-bb9f-42eb-b741-9da0893add02","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}},{"name":"Transactional Data Sharing","item":[{"name":"Transactional Data Sharing","id":"39f1f9cb-5d7a-472f-8492-9b7f63a1071b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_lms}}/v1/external-lending/sme/partner/data-sharing?noOfFiles=2","description":"

This API allows partners to generate signed URLs, facilitating the seamless uploading of files. In instances where partners need to upload multiple files, the API offers the capability to obtain multiple signed URLs for each file through a single API call. Additionally, the API supports the zip format when dealing with multiple files.

Note

Partners can upload individual files or ZIP files using the provided signed URLs
\n
Signed URLs expire after 30 minutes
\n
The maximum number of signed URLs that can be generated in a single API call is limited to 10
\n

Type of Errors

401 Unauthorized: Invalid/Missing API key or partner ID
\n
403 Forbidden: Partner not authorized to generate signed URLs
\n
500 Internal Server Error: An error occurred on the server
\n

Request Parameters

noOfFiles (optional, integer): The number of signed URLs to generate (default: 1, maximum: 10).

Response Body

See sample response.

Post-Processing - Uploading File Using Signed URL

Steps

Obtain a Signed URL:
\n
- Use the above API to generate a signed URL for file upload
\n
Prepare the File:
\n
- Ensure the file you intend to upload is ready and accessible
  \n
- Verify the file type
  \n
\n
Construct the Request:
\n
- Choose either a command-line tool (like curl) or any programming language (like Python) to make the request.
\n

Using curl (command-line)

curl -X PUT \\\n  -H \"Content-Type: <file_type>\" \\\n  --upload-file <file_path> \\\n  <signed_url_link>\n\n

Replace placeholders with actual values:

: The MIME type of the file (e.g., application/csv, application/zip)
\n
: The full path to the file on your system
\n
: The obtained signed URL
\n

Using Python

import requests\nurl = <signed_url_link>\nfile_path = <file_path>\nheaders = {\"Content-Type\": <file_type>}\nwith open(file_path, \"rb\") as file:\n    response = requests.put(url, data=file, headers=headers)\nif response.status_code == 200:\n    print(\"File uploaded successfully!\")\nelse:\n    print(f\"Error uploading file: {response.text}\")\n\n

Replace placeholders with actual values as in the curl example

Key Points

Signed URLs are time-sensitive and expire after a set duration.
\n
Ensure you use the correct HTTP method (PUT in this case) and headers.
\n
Specify the accurate file path and type.
\n
Handle potential errors by checking the response status code.
\n

\n","urlObject":{"path":["v1","external-lending","sme","partner","data-sharing"],"host":["{{base_url_lms}}"],"query":[{"key":"noOfFiles","value":"2"}],"variable":[]}},"response":[{"id":"36bfafdb-9adb-47a0-8eaa-618e8808f26d","name":"response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcmdfaWQiOiI2NmM1YjIwZmI1NGZjZDc2YThhZTVlNDUiLCJ1c2VyX2lkIjoiNjZkMWI4YmFkOTgyNzZlNDgyOTJlZDc4Iiwicm9sZSI6InBhcnRuZXIiLCJuYW1lIjoiQ2F0dmlzaW9uIiwiaXNzIjoiY2ItbWFpbi1iYWNrZW5kLmNiZnMtYXV0aCIsInBheWxvYWRfdmVyc2lvbiI6MywicGxhdGZvcm0iOiJwYXJ0bmVyIiwic3ViIjoiNjZkMWI4YmFkOTgyNzZlNDgyOTJlZDc4IiwibWV0YSI6eyJzZWxmaWVfcmVxdWlyZWQiOmZhbHNlLCJtYXR1cml0eSI6eyJ0eXBlIjoiYmFuZHMiLCJtYXgiOjMwLCJtaW4iOjF9fSwiaWF0IjoxNzM2NDA0NzE3LCJleHAiOjE3MzY0MDgzMTd9.qc3P7cQchNTuTSsXwRlobUytqqG5ZzoqcE-er3EnTkk","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url_lms}}/v1/external-lending/sme/partner/data-sharing?noOfFiles=2","host":["{{base_url_lms}}"],"path":["v1","external-lending","sme","partner","data-sharing"],"query":[{"key":"noOfFiles","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"content-type","value":"text/html; charset=utf-8"},{"key":"X-Cloud-Trace-Context","value":"4d4d5ae2cbcc2c1c1f94ef29586fc409;o=1"},{"key":"Date","value":"Fri, 16 Feb 2024 07:56:51 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"918"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": {\n \"signedURL\": [\n \"https://s3.ap-southeast-1.amazonaws.com/S3_TRANSACTIONAL_DATA_BUCKET/66d1b8bad98276e48292ed78/1736404903989-0?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GYZCBJV45%2F20250109%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20250109T064143Z&X-Amz-Expires=3600&X-Amz-Signature=368243fd9d67bfddc53080e279030b4ad62bb31ca3a6fe5749f3e58fd11a4b7c&X-Amz-SignedHeaders=host&x-id=PutObject\",\n \"https://s3.ap-southeast-1.amazonaws.com/S3_TRANSACTIONAL_DATA_BUCKET/66d1b8bad98276e48292ed78/1736404903992-1?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA2HE4366GYZCBJV45%2F20250109%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20250109T064143Z&X-Amz-Expires=3600&X-Amz-Signature=aebe5013e823ce9b8f83cfbff1d0b1ae3e9a8f88c052927776a440c5ef3048b7&X-Amz-SignedHeaders=host&x-id=PutObject\"\n ]\n },\n \"message\": \"success\"\n}"}],"_postman_id":"39f1f9cb-5d7a-472f-8492-9b7f63a1071b"}],"id":"3f740325-bd4c-4e0d-a434-a15f938499f2","description":"

Summary

Must share at least 6 months of transaction history
\n
Data must not be older than 30 days from application date
\n
Share new data every 3 lending cycles for active borrowers
\n
Each transaction must include: unique identifier (matching KYC), business name, date, and amount
\n
Raw data only - no formatting, merged cells, or aggregated data
\n
Maintain consistent format and fields across all data submissions
\n
For API users: use platform's user_id; For Partner Book: use mobile number
\n

Introduction

This guide outlines the requirements and best practices for sharing transactional data effectively and efficiently. At CreditBook We process this data to maintain robust risk assessment standards. By following these guidelines, you'll ensure smooth processing of applications and continued access to financing for your customers.

Why We Need Transactional Data

Our platform leverages advanced analytics to perform swift and accurate risk assessments without requiring lengthy traditional review processes. Transactional data provides vital insights into business performance and creditworthiness, allowing us to:

Make faster lending decisions
\n
Offer more accurate and personalized financing terms
\n
Reduce the documentation burden on your customers
\n
Maintain ongoing monitoring of portfolio health
\n

Data Freshness Requirements

Keeping data current is crucial for accurate risk assessment. We require regular updates based on the following schedule:

For new applications: Data must not be older than 30 days from the application date
\n
For existing borrowers: Updated data must be shared at least every three lending cycles for review purposes
\n
Failure to provide timely updates may result in rejected applications or reviews
\n

Minimum Data Requirements

Historical Depth

All profiles must include a minimum of 6 months of transactional history. Applications with insufficient history will be automatically rejected.

Required Fields

Every transaction record must include:

Unique identifier (matching KYC application)
\n
Business name
\n
Transaction/order date
\n
Transaction amount
\n

Identifier Requirements

API Integration Partners: Use your platform's user_id which can then be shared as external_user_id when creating lending users ({{base_url_lms}}/v1/external-lending/sme/users )
\n
Partner Book Users: Use customer mobile number
\n
The chosen identifier must match exactly with the KYC application information
\n

Data Format Best Practices

File Structure

Provide raw data without formatting or merged cells
\n
Each row must be self-contained with all required information
\n
Avoid aggregated data - provide individual transaction records
\n
Include all identifying information in every row
\n

Date Formatting

Use consistent date format including day, month, and year
\n
Example: \"2024-02-18\" or \"18/02/2024\"
\n
Dates should be in proper date format, not text
\n

Transaction Level Detail

We strongly recommend providing order-level transaction data rather than aggregated summaries because it:

Enables more accurate risk assessment
\n
Provides deeper insights into business patterns
\n
May result in more favorable financing terms
\n
Allows for better monitoring of business health
\n

Consistent Format

Another critical aspect is to maintain a standard data format in each upload, to make sure our data pipelines are able to process the information as fast as possible. Data shared should follow the same fields and naming conventions, change in fields or schema must be avoided.

Common Issues to Avoid

Sending aggregated monthly or weekly data instead of individual transactions
\n
Inconsistent identifier usage across records
\n
Missing transaction dates or using incorrect date formats
\n
Incomplete historical data
\n
Formatted spreadsheets with merged cells or complex formatting
\n
Mismatched identifiers between KYC and transaction data
\n

Data Submission Process

Ensure all data meets the minimum requirements outlined above
\n
Verify that identifiers match KYC application information
\n
Check that the most recent transaction is within the 30-day threshold
\n
Submit data in raw format without any special formatting
\n

Recommended API Implementation

For New Users/Applicants

When implementing programmatic data sharing for new users, timing and completeness are crucial for efficient processing:

The initial data upload should occur immediately after the user completes their KYC application. This ensures seamless processing and prevents delays in application review. Your implementation should:

Trigger the data upload automatically upon KYC completion
\n
Include a minimum of 6 months of historical transaction data
\n
Follow the transaction data format specifications detailed in previous section
\n

For Existing Borrowers

For active borrowers, maintaining regular data updates is essential for ongoing risk assessment:

Frequency Requirements:
\n
- Minimum: Monthly updates
  \n
- Maximum: Every 3 months
  \n
- Set up automated scheduling to ensure consistent delivery within these parameters
  \n
\n
Data Scope:
\n
- Include all transactions since the last data upload
  \n
- Ensure continuity with previously shared data to maintain a complete transaction history
  \n
- Maintain consistent formatting and field names across all submissions
  \n
\n

Implementation Best Practices

When setting up your API integration:

Implement error handling and retry mechanisms
\n
Set up monitoring for failed uploads
\n
Maintain logs of successful data submissions
\n
Include validation checks before sending data:
\n
1. Verify date ranges are complete
  \n
2. Check for required fields
  \n
3. Validate identifier consistency
  \n
4. Confirm data freshness requirements are met
  \n
\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6b1a7e5c-f26c-4085-bf8c-d4a28f9a46df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d185f6cb-ef2f-40d6-b1e7-d3e8f57d6330","type":"text/javascript","exec":[""]}}],"_postman_id":"3f740325-bd4c-4e0d-a434-a15f938499f2"},{"name":"Notification Webhook","item":[{"name":"Setting up Authentication of Webhook URLs","item":[],"id":"206a170c-25bb-4fee-90ac-2351f4dd5310","description":"

For you to integrate a webhook, we would require a standardised authentication setup followed for each of the webhook URL. Therefore, the standard is to provide us with an authentication URL that intakes email and password (dedicated for us) and returns a JWT token. Following is how we expect to have invoke the Authentication API and receive the token where the base_auth_url(Referring from the form: Authentication URL), email, and password (which are provided to us) are sent as below in the request body.

    const loginResponse = await axios.post(base_auth_url, {\n      email,\n      password,\n    });\n    return loginResponse.data.token;\n\n

This token is to be used further in the Authorization header property for every other API. Following is how every webhook will be invoked from our end. Here, you can fill this form to provide us with different (or same) URLs to invoke the webhook that needs to be called for certain events. payload here are specific to the triggered event (discussed in the Payloads for Webhook URLs section)

await axios.post(webhook_url, payload,  {\n        headers: {\n          Authorization: token,\n        },\n      })\n\n

IMPORTANT: Notice here that each of the webhook must be a POST request.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"33a85fe3-d41d-45fb-a339-8f0a18b7b5dc","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"70665aa5-7029-46e3-bb50-b5143032865c","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"206a170c-25bb-4fee-90ac-2351f4dd5310"},{"name":"Payloads for Webhook URLs","item":[{"name":"General Event Payload","item":[],"id":"49b7b8d4-ed45-4436-bf65-b83d2aea445c","description":"

{\n    event_type: IWebhookEventType\n    timestamp: string; // ISO 8601 date format in string\n    event_data: T // generic type dependent on event\n}\nenum IWebhookEventType {\n  CUSTOMER_PROFILE_CREATION = 'customer_profile_creation',\n  CUSTOMER_PROFILE_REJECTION = 'customer_profile_rejection',\n  CUSTOMER_PROFILE_APPROVAL = 'customer_profile_approval',\n  CREDIT_LIMIT_UPDATE = 'credit_limit_update',\n\n  LOAN_CREATION = 'loan_creation',\n  LOAN_REJECTION = 'loan_rejection',\n  LOAN_APPROVED = 'loan_approved',\n  LOAN_DISBURSED = 'loan_disbursed',\n  LOAN_COMPLETED = 'loan_completed',\n  LOAN_MARKED_OVERDUE = 'loan_marked_overdue',\n\n  LOAN_TRANSACTION_CREATION = 'loan_transaction_creation',\n  LOAN_TRANSACTION_APPROVED = 'loan_transaction_approved',\n  LOAN_TRANSACTION_CANCELLED = 'loan_transaction_cancelled',\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"311401fd-5a04-4fdd-abbf-36d959410a2e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"72a8c96c-3735-48f8-aa52-36163ab129d3","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"49b7b8d4-ed45-4436-bf65-b83d2aea445c"},{"name":"Customer Profile Created","item":[],"id":"d0dc1b29-2f00-44c1-8147-244f9d708b56","description":"

Referring from the form: Customer Profile Created URL

{\n    event_type: 'customer_profile_creation'\n    timestamp: string // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        status: 'pending'\n    }\n}\n\n

\n","_postman_id":"d0dc1b29-2f00-44c1-8147-244f9d708b56","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","name":"Payloads for Webhook URLs","type":"folder"}}},{"name":"Customer Profile Rejected Payload","item":[],"id":"0cc88009-72ac-4443-a8ac-78e0fc6ce7fd","description":"

Referring from the form: Customer Profile Rejected URL

{\n    event_type: 'customer_profile_rejection'\n    timestamp: string // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        status: 'rejected' | 'need_more_info'\n        reason: string\n        comment?: string\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b3178ee4-5729-4b3f-806d-c3813c049774","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"2d543801-d31d-45e4-80f7-e2398c324ecf","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"0cc88009-72ac-4443-a8ac-78e0fc6ce7fd"},{"name":"Customer Profile Approved - Contract Pending","item":[],"id":"d673988a-51f7-4373-b13f-9ebf6d1ca2d9","description":"

Referring from the form: Customer Profile Approved URL

{\n    event_type: 'customer_profile_approval'\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        status: 'approved'\n        contract_status: \"contract_pending\";\n        facilities?: IFacility[];\n        contract_url?: string;\n        credit_limit?: number;\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7fcb11cb-73c4-4996-a720-711d510fe448","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"5c3a7a1b-9c13-4139-8e86-65f2108f371d","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"d673988a-51f7-4373-b13f-9ebf6d1ca2d9"},{"name":"Loan Created","item":[],"id":"14dab959-3769-4107-af6a-95f9efe6ee9d","description":"

Referring from the form: Loan Created URL

{\n    event_type: 'loan_creation'\n    timestamp: string // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        status: 'under_review'\n    }\n}\n\n

\n","_postman_id":"14dab959-3769-4107-af6a-95f9efe6ee9d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","name":"Payloads for Webhook URLs","type":"folder"}}},{"name":"Loan Rejection","item":[],"id":"5fb83cd9-ac30-42df-894f-ef3600bc9b09","description":"

Referring from the form: Loan Rejected URL

    event_type: 'loan_rejection'\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        loan_id: string;\n        status: 'rejected' | 'need_more_info'\n        reason: string;\n        comment?: string;\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f4dda37a-7a0e-4004-a023-ebaf7f77f6b6","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"053436f3-c4ed-43fe-89b1-317ef8ef040d","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"5fb83cd9-ac30-42df-894f-ef3600bc9b09"},{"name":"Loan Approved","item":[],"id":"2fe0dac0-8a78-4639-9d52-5de10db9c98f","description":"

Referring from the form: Loan Approved URL

{\n    event_type: 'loan_approved'\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        loan_id: string;\n        status: 'approved' \n        principal_amount: number;\n        markup: number; // markup in percentage\n        tenure: number; // tenure in days\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"045eef36-042b-4a82-a7bf-a7d3fd5ba025","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"157f316e-9fc7-4843-a0f0-fe087e7c5788","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2fe0dac0-8a78-4639-9d52-5de10db9c98f"},{"name":"Loan Disbursed","item":[],"id":"d5ded30a-c4df-45b8-b135-106516db3a49","description":"

Referring from the form: Loan Disbursed URL

{\n    event_type: 'loan_disbursed';\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        loan_id: string;\n        status: 'disbursed';\n        disbursed_amount: number;\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"fd91f30d-ba50-4c6a-be9d-f329a293c4de","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b3819272-82c7-46f8-a4c1-2a7fc926f3ef","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"d5ded30a-c4df-45b8-b135-106516db3a49"},{"name":"Loan Completed","item":[],"id":"9df0fa12-ebba-4204-a850-5dbfeff16e2c","description":"

Referring from the form: Loan Completed URL

{\n    event_type: 'loan_completed';\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        loan_id: string;\n        status: 'completed';\n        payments: {\n            principal_repaid: number;\n          markup_fee: number;\n            late_fees: number;\n        }\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6b602f86-0937-4004-904e-ac9733e3b774","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"8380586e-da04-43ff-bc81-16781e9d1173","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"9df0fa12-ebba-4204-a850-5dbfeff16e2c"},{"name":"Loan Marked Overdue","item":[],"id":"2a262a01-0df8-4794-865e-2a1b847564b3","description":"

Referring from the form: Loan Marked Overdue URL

{\n    event_type: 'loan_marked_overdue';\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        loan_id: string;\n        status: 'overdue';\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7ceeca7b-a4ab-4a86-98a2-f29e1e5162b4","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"dc825de2-64ed-40d9-a2c3-8e3ea0ea27b5","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2a262a01-0df8-4794-865e-2a1b847564b3"},{"name":"Loan Transaction Creation","item":[],"id":"d2a88999-959e-4fe5-a610-5b451d823aec","description":"

Referring from the form: Loan Transaction Created URL

{\n    event_type: 'loan_transaction_creation';\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string;\n        loan_id: string;\n        loan_transaction_id: string;\n        amount: number;\n        payment_date: string; // ISO 8601 date format in string,\n        type: LoanTransactionType;\n        status: 'processing';\n    }\n}\nenum TransactionType {\n  DISBURSEMENT = 'disbursement',\n  REPAYMENT = 'repayment',\n  ADJUSTMENT = 'adjustment', // for adjusting the loan amount\n  REFUND = 'refund', // for refunding the loan repayments\n}\n\n

\n","_postman_id":"d2a88999-959e-4fe5-a610-5b451d823aec","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","name":"Payloads for Webhook URLs","type":"folder"}}},{"name":"Loan Transaction Approved","item":[],"id":"057dc367-d065-472e-b927-4a71fe58bc4e","description":"

Referring from the form: Loan Transaction Approved URL

{\n    event_type: 'loan_transaction_approved';\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        external_user_id?: string;\n        user_id: string;\n        loan_id: string;\n        loan_transaction_id: string;\n        status: 'approved';\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c7781a89-e80a-4594-867c-bbeb902511aa","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"02a98769-90dd-425c-9e3a-8b8cbb7e2658","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"057dc367-d065-472e-b927-4a71fe58bc4e"},{"name":"Loan Transaction Cancelled","item":[],"id":"0ede4dab-9e2b-413c-9c5f-b872266b5d5a","description":"

Referring from the form: Loan Transaction Cancelled URL

{\n    event_type: 'loan_transaction_cancelled';\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        external_user_id?: string;\n        user_id: string\n        loan_id: string\n        loan_transaction_id: string;\n        status: 'cancelled';\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ee85da29-b600-4be0-8134-701c798698f2","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"625c0ed4-8f60-4e21-9513-2bdb03dd9513","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"0ede4dab-9e2b-413c-9c5f-b872266b5d5a"},{"name":"Credit Limit Updated - Contract Signed","item":[],"id":"d83da79b-fe3d-48b3-9e18-59844d8f18c3","description":"

Referring from the form: Credit Limit Updated URL

{\n    event_type: 'credit_limit_update'\n    timestamp: string; // ISO 8601 date format in string\n    event_data: {\n        user_id: string;\n        external_user_id?: string\n        status: 'approved'\n        contract_status: 'contract_valid';\n    }\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"57eb2a68-e71c-400d-859d-6366efe64a52","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d88f745f-1cf3-45dd-abcf-67157d2212ca","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"d83da79b-fe3d-48b3-9e18-59844d8f18c3"}],"id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7","description":"

Following are the event payloads respective to each event.

Note:

To accommodate future updates, ensure that your DTO does not enforce strict validations that would block new properties in the event payload. This flexibility will allow the webhook request payload to include any additional properties that may be introduced over time without immediate changes at your end.
Partners are also requested to handle webhook calls in an idempotent way. In case of repeat calls of the same payload, change should only be effected once.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"0740fadc-0da9-4b28-b3ce-d9244035ffe0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c4792bdc-3694-4fca-8084-e511bf7e0f0a","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2d3d730c-8259-4e9e-8e1b-1eabcae071e7"}],"id":"84d43685-eb8e-4f7d-897f-c0f310d7539d","description":"

Partners can provide a webhook to get notified for status updates to profiles, loans, loan-transactions.

The partner can alternatively fetch the specified record to see the current status if real-time notifications are not important by calling the above integration APIs

Note:

After finalising the webhooks, kindly fill out this form to inform us about the properties related to configuring webhook invocation on our end.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"935040ac-9621-4a80-b56f-d701ee63d3c5","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"85df6fdb-50f5-4544-bd86-ada6809e8bf8","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"84d43685-eb8e-4f7d-897f-c0f310d7539d"}],"id":"349a8830-1562-4396-910d-7afbc727b789","description":"

Once done with the happy flow, we also recommend to get acquainted with these Utility APIs which would help in configuring the whole flow for users. These includes getting or updating information when in process of creating a financial request.

\n","_postman_id":"349a8830-1562-4396-910d-7afbc727b789","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","id":"9bd876f8-1ffa-4657-9dc3-fc4b819f0c8a","name":"CreditBook Embedded Finance APIs","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"e2701cc7-cce0-4722-94e6-5beb2c7ea73f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aef5386f-ce0c-43bd-8639-bf311a3a8f0f","type":"text/javascript","exec":[""]}}]}