Creditbook provides an API suite called the \"Embedded Finance APIs\" for our partners to integrate into their business flows, enabling their customers to avail Creditbook's speedy and reliable financing options.
\nThe following APIs constitute our lending infrastructure, offering developers and partners a secure environment to seamlessly test and integrate applications.
\nTo understand our main processes better, sequence diagrams are attached along with each folder that represent generic (but not necessarily hard wired) flows for how integration and lending work. The folders have been subdivided into \"main\" and \"utils\" to provide clarity on what purpose a specific endpoint serves in the happy flow. Before entering into the documentation, following is a list of terms and their dedintions that are used frequently throughout this document.
\nThe consumer of EF APIs, for whom these docs are intended, is the Partner.
\nUnder this system, a Customer is comprised of 3 constituent parts:
\nAn entity
\nThe entity's compliance(s)
\nThe entity's products
\nEntity: An entity may refer to an individual or a business registered with the system. A business can be owned by multiple individuals and an individual may be linked to multiple businesses. Each individual and business entity have a corresponding compliance. Since a loan application is submitted through a business, the entity referring to a customer above is actually the Business Entity, but the customer registration process involves entering details for both the business and at least one linked individual (or more).
\nCompliance: A compliance is a document which captures an entity's KYC requirements. These may include for example National Document ID, Industry, Average Monthly Revenue, Bank Statement, among others. The exact list of compliance requirements are retrieved from the Get Form Meta API.
\nProduct: A product refers to a financing offering of a specific type, for eg Cash Flow Financing, Invoice Financing etc. The customer may sign agreements for these products to become eligible to apply for financing for them. For example there may have a product called \"Car Financing\" available to partner ABC. Then, a customer on partner ABC's app through the Embedded Finance APIs may register with the Create Entity API, sign an agreement for \"Car Financing\" product, and then can apply for Car Financing through the Create Loan API.
\nA contract to formalize financing processes. Agreements are signed during:
1. The Customer Onboarding Flow - to lay out the terms of a finance offering between a financier and a customer
2. The Financing Flow (optional) - in some cases, loan level agreements are required where a customer will sign an agreement for each financing request they make once it gets approved by the system
\nA service refers to a specific functional capability related to a type of financing. For example, a \"Loan Service\" encompasses the operations to apply for and manage loans, while a \"Savings Service\" would handle savings account functionalities.
\nWhen a customer is eligible for or has chosen a specific Product (e.g., a 'Personal Loan'), it means they can then interact with the associated Service - in this case a Loan.
\nCurrently, our system primarily supports a \"Loan Service.\"
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37253105","collectionId":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","publishedId":"2sB2x8EWPJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-23T11:56:45.000Z"},"item":[{"name":"Partner Login","item":[{"name":"Partner Login","id":"2d462000-b0c5-40d3-b15e-ea1dee8de241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"identifier\": \"66d1b8bad98276e48292ed78\",\n \"password\": \"fnOagC1w5q9OdUoDRvDleZhMBUaFY8UAfIOrjYkhTcDPvU3MlMJxqrNaaHbi\",\n \"platform\": \"partner\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/auth/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.
\nNote: 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
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","auth","login"],"host":["{{base_url_core}}"],"query":[],"variable":[]}},"response":[{"id":"662013c5-54b2-46d3-8f93-d34233ef0447","name":"Partner Login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"identifier\": \"partnerId\",\n \"password\": \"apiKey\",\n \"platform\": \"partner\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"2b1308eb-f631-4ce0-99ec-f615e2429e6c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"428"},{"key":"ETag","value":"W/\"1ac-GAADaOyLZAxoycHfmz6exgswX+o\""},{"key":"Date","value":"Sun, 15 Jun 2025 18:50:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJicm9rZXJJZCI6IjY2YzViMjBmYjU0ZmNkNzZhOGFlNWU0NSIsPnJlZ2lvbklkIjoiNjdiZWQyM2E3NGI5Y2E4YjIyZWFkNTc3IiwicGFydG5lcklkIjoiNjZkMWI4YmFkOTgyNzZlNDgyOTJlZDc4Iiwic3ViIjoiNjZkMWI4YmFkOTgyNzZlNDgyOTJlZDc4IiwiaXNzIjoiY29yZS1hcGkuYXV0aCIsInBheWxvYWRfdmVyc2lvbLI6MSwicGxhdGZvcm0iOiJwYXJ0bmVyIiwiaWF0IjoxNzUwMDEzNDMyLCJleHAiOjE3NTAwMTcwMzJ9.4z5yun7Thk4WtyC6CefHzCzzoBxJ5HEsCWh21_QR1m2\"\n}"},{"id":"6cadbe4e-eb86-4f18-8769-4b5885fec41c","name":"Error - Invalid Platform","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"identifier\": \"partnerId\",\n \"password\": \"apiKey\",\n \"platform\": \"part\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"f0482830-12ad-4375-a2f0-e11b71378f36"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"297"},{"key":"RateLimit-Reset","value":"5"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"136"},{"key":"ETag","value":"W/\"88-5BRUItlcpGixLkKlUrSpnTG+79I\""},{"key":"Date","value":"Tue, 29 Jul 2025 07:12:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"platform must be one of the following values: credr, finance_now, partner, lending_service\",\n \"field\": \"platform\"\n }\n ]\n}"},{"id":"ccac8f01-3459-4a7f-8fea-213c165cc464","name":"Error - Invalid Credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"identifier\": \"partnerId\",\n \"password\": \"apiKey\",\n \"platform\": \"partner\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"50fd8f77-c748-4b52-8306-c04dee77059c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"57"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"ETag","value":"W/\"50-EB/2EfhziFCkeAVGlJ1gmt/tTcc\""},{"key":"Date","value":"Tue, 29 Jul 2025 07:13:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized\",\n \"context\": {\n \"hint\": \"Invalid credentials\"\n }\n }\n ]\n}"}],"_postman_id":"2d462000-b0c5-40d3-b15e-ea1dee8de241"}],"id":"04a5d69e-e955-48e3-9366-6f24d2b4c5a9","description":"This endpoint returns a list of the requirements and their types to be filled into the compliance requirements in the Create Entity API.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","customers","requirements-form-meta"],"host":["{{base_url_core}}"],"query":[],"variable":[]}},"response":[{"id":"1ef8e1c1-01ca-4a69-a53b-9e079ed5b4fa","name":"Region - PK","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/customers/requirements-form-meta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"b66f0d92-2ae8-4356-949d-c34c308bc29f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"45"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6839"},{"key":"ETag","value":"W/\"1ab7-kzfeIuPR1vt6ozcyh80SsWQNwTo\""},{"key":"Date","value":"Sun, 15 Jun 2025 18:58:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"requirements\": [\n {\n \"requirement_name\": \"business_poc\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Business POC\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"Business POC Details\",\n \"section_description\": \"Enter business POC details in this section\"\n },\n \"data_type\": \"string\",\n \"validations\": {\n \"validation_regex\": \"^.*$\",\n \"max_chars\": 100,\n \"enum_values\": []\n }\n },\n {\n \"requirement_name\": \"industry\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Industry\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\",\n \"company\",\n \"individual\",\n \"branch_office\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"data_type\": \"enum\",\n \"validations\": {\n \"enum_values\": [\n \"E-commerce & Online Retail\",\n \"Software & SaaS\",\n \"Digital Marketing & Advertising Services\",\n \"Subscription-based Services\",\n \"F&B (Restaurants & Cafes)\",\n \"Healthcare Services & Clinics\",\n \"Professional Services\",\n \"Education & Training\",\n \"IT Services & Support\",\n \"Logistics & Delivery Services\",\n \"Wholesale Trade\",\n \"Property Management & Maintenance\",\n \"Retail\",\n \"Fitness & Wellness Centers\",\n \"Manufacturing\",\n \"Telecommunications Services\",\n \"Media & Content Production\",\n \"Beauty & Personal Care Services\",\n \"Recruitment & HR Services\",\n \"Business Process Outsourcing\",\n \"Others\"\n ]\n }\n },\n {\n \"requirement_name\": \"currency_requirement\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Currency Requirement\",\n \"is_optional\": true,\n \"is_pii\": false,\n \"description\": \"Dolorum Nam eaque eu\",\n \"business_types\": [\n \"individual\",\n \"company\",\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"\",\n \"section_description\": \"\"\n },\n \"data_type\": \"number\",\n \"validations\": {\n \"enum_values\": [],\n \"min\": 0,\n \"max\": 10000000\n },\n \"unit\": \"currency\"\n },\n {\n \"requirement_name\": \"cnic_front\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"CNIC front\",\n \"is_optional\": false,\n \"is_pii\": true,\n \"description\": \"CNIC Front side\",\n \"max_size\": 10,\n \"accepts_multiple_files\": false,\n \"meta\": {\n \"section_heading\": \"Business Owner Details\",\n \"section_description\": \"Please add business owner details. Add more business owners to add their details\",\n \"section_key\": \"business_owner_details\"\n },\n \"business_types\": [\n \"individual\",\n \"company\",\n \"sole_proprietorship\"\n ],\n \"accepts_formats\": [\n \"jpg\",\n \"png\"\n ]\n },\n {\n \"requirement_name\": \"ntn_certificate\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"NTN Certificate\",\n \"is_optional\": true,\n \"is_pii\": true,\n \"description\": \"\",\n \"max_size\": 10,\n \"meta\": {\n \"section_key\": \"business_documents\",\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"accepts_multiple_files\": false,\n \"accepts_formats\": [\n \"pdf\"\n ],\n \"business_types\": [\n \"sole_proprietorship\"\n ]\n },\n {\n \"requirement_name\": \"bank_statement\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Bank statement for the last 6 months\",\n \"is_optional\": false,\n \"is_pii\": true,\n \"description\": \"Uploading the bank statement for your business makes your application stronge\",\n \"max_size\": 10,\n \"meta\": {\n \"section_key\": \"business_documents\",\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"accepts_multiple_files\": false,\n \"accepts_formats\": [\n \"pdf\"\n ],\n \"business_types\": [\n \"company\"\n ]\n },\n {\n \"requirement_name\": \"cnic_back\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"CNIC back\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"CNIC Back side\",\n \"meta\": {\n \"section_heading\": \"Business Owner Details\",\n \"section_description\": \"Please add business owner details. Add more business owners to add their details\",\n \"section_key\": \"business_owner_details\"\n },\n \"max_size\": 11,\n \"accepts_multiple_files\": false,\n \"business_types\": [\n \"individual\",\n \"company\",\n \"sole_proprietorship\",\n \"partnership\",\n \"branch_office\"\n ],\n \"accepts_formats\": [\n \"jpg\",\n \"png\"\n ]\n },\n {\n \"requirement_name\": \"proprietorship_declaration\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Proprietorship declaration letter\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"Upload a proprietorship declaration letter issued from the bank\",\n \"business_types\": [\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_key\": \"business_documents\",\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"accepts_formats\": [\n \"pdf\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n },\n {\n \"requirement_name\": \"form_ab\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Form AB\",\n \"is_optional\": true,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\",\n \"branch_office\",\n \"individual\",\n \"company\"\n ],\n \"meta\": {\n \"section_heading\": \"Business Documents\",\n \"section_description\": \"Business Documents\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"docx\",\n \"doc\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": true\n }\n },\n {\n \"requirement_name\": \"selfie\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Selfie\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"please provide a selfie\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\",\n \"company\",\n \"individual\",\n \"branch_office\"\n ],\n \"meta\": {\n \"section_heading\": \"Business Owner Details\",\n \"section_description\": \"Details about owner\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\"\n ],\n \"max_size\": 5,\n \"accepts_multiple_files\": false\n }\n }\n ],\n \"businessTypes\": [\n \"individual\",\n \"company\",\n \"sole_proprietorship\",\n \"partnership\",\n \"branch_office\"\n ],\n \"banks\": [\n {\n \"_id\": \"6088347be63016c52e3\",\n \"name\": \"Bank Of Khyber\",\n \"mnemonic\": \"BOK\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-of-khyber.webp\",\n \"external_codes\": {\n \"meezan\": \"061\",\n \"jsbl\": \"41\",\n \"zindigi\": \"627618\",\n \"swich\": \"627618\"\n },\n },\n {\n \"_id\": \"6488347be63016c5\",\n \"name\": \"Faysal Bank Limited\",\n \"mnemonic\": \"FBL\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/faysal-bank.webp\",\n \"external_codes\": {\n \"jsbl\": \"6\",\n \"zindigi\": \"601373\",\n \"swich\": \"601373\"\n },\n },\n {\n \"_id\": \"6488347be63016c52e361cb7\",\n \"name\": \"Meezan Bank Limited\",\n \"mnemonic\": \"MBL\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/meezan-bank.webp\",\n \"external_codes\": {\n \"jsbl\": \"22\",\n \"zindigi\": \"627873\",\n \"swich\": \"627873\"\n },\n }\n ],\n \"validationFormats\": {\n \"individual_national_document_id\": \"^\\\\d{5}-\\\\d{7}-\\\\d$\"\n }\n}"},{"id":"ca2b5ca9-7f6e-40a1-ba81-e47f6821f582","name":"Region - UAE","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/customers/requirements-form-meta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"780236cb-3770-4a3c-b69a-2db4e0e26268"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6927"},{"key":"ETag","value":"W/\"1b0f-l/Bk+PeuN393Ya1901VBWI+BgV0\""},{"key":"Date","value":"Sun, 15 Jun 2025 19:38:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"requirements\": [\n {\n \"requirement_name\": \"industry\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Industry\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validation_regex\": \".*\",\n \"max_chars\": 100,\n \"data_type\": \"enum\",\n \"validations\": {\n \"enum_values\": [\n \"Construction\",\n \"Retail\"\n ]\n }\n },\n {\n \"requirement_name\": \"average_monthly_revenue\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Average Monthly Revenue (AED)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validation_regex\": \"^[0-9]\",\n \"max_chars\": 100,\n \"data_type\": \"number\",\n \"validations\": {\n \"enum_values\": [],\n \"min\": 1,\n \"max\": 99999999\n }\n },\n {\n \"requirement_name\": \"average_monthly_expenses\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Average Monthly Expenses (AED)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validation_regex\": \"^[0-9]\",\n \"max_chars\": 100,\n \"data_type\": \"number\",\n \"validations\": {\n \"enum_values\": [],\n \"min\": 1,\n \"max\": 99999999\n }\n },\n {\n \"requirement_name\": \"financing_amount\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Financing Amount (AED)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"partnership\",\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"Financing Request\",\n \"section_description\": \"Please enter financing information\"\n },\n \"data_type\": \"number\",\n \"validations\": {\n \"enum_values\": [],\n \"min\": 1,\n \"max\": 999999999999\n }\n },\n {\n \"requirement_name\": \"financing_tenor\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Financing Tenor (Days)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Financing Request\",\n \"section_description\": \"Please enter financing information\"\n },\n \"data_type\": \"number\",\n \"validations\": {\n \"enum_values\": [],\n \"min\": 1,\n \"max\": 60\n }\n },\n {\n \"requirement_name\": \"test_req\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"text\",\n \"display_label\": \"Test Req\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"Test Sec\",\n \"section_description\": \"\"\n },\n \"data_type\": \"string\",\n \"validations\": {\n \"validation_regex\": \"*\",\n \"max_chars\": 100,\n \"enum_values\": []\n }\n },\n {\n \"requirement_name\": \"trade_license\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Trade License\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"Trade License\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\",\n \"doc\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"bank_statement\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Bank Statement\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"partnership\",\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"doc\",\n \"xlsx\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"aecb_report\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"AECB report\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"vat_certificate\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"VAT certificate\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\",\n \"doc\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"moa\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Memorandum of Association (MOA)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"poa\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Power of Attorney (POA)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"partnership\",\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"board_resolution\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Board Resolution\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"partnership\",\n \"sole_proprietorship\"\n ],\n \"meta\": {\n \"section_heading\": \"Additional business information\",\n \"section_description\": \"To verify your application, we require some additional details about your business\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\"\n ],\n \"max_size\": 10,\n \"accepts_multiple_files\": false\n }\n },\n {\n \"requirement_name\": \"id_document\",\n \"requirement_type\": \"compliance\",\n \"input_type\": \"document\",\n \"display_label\": \"Proof of ID (Passport, Visa, Emirates ID)\",\n \"is_optional\": false,\n \"is_pii\": false,\n \"description\": \"\",\n \"business_types\": [\n \"sole_proprietorship\",\n \"partnership\"\n ],\n \"meta\": {\n \"section_heading\": \"Business Owner Details\",\n \"section_description\": \"Please add business owner details.\"\n },\n \"validations\": {\n \"accepts_formats\": [\n \"pdf\",\n \"jpg\",\n \"jpeg\",\n \"png\"\n ],\n \"max_size\": 5,\n \"accepts_multiple_files\": false\n }\n }\n ],\n \"businessTypes\": [\n \"sole_proprietorship\",\n \"partnership\",\n \"company\"\n ],\n \"banks\": []\n}"}],"_postman_id":"ce4886cc-f60f-4a5a-ba0b-80427dbf530c"},{"name":"Create Customer","id":"4ae02124-571e-4181-9be4-fca4469cdc05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalDetails\": {\n \"name\": \"John Doe 4\",\n \"contactNumber\": \"+923001234567\",\n \"email\": \"john.doe.6@example.com\",\n \"dob\": \"1990-01-01\",\n \"nationalDocumentId\": \"12345-1234567-1\",\n \"complianceDetails\": [\n {\n \"requirementName\": \"cnic_front\",\n \"values\": [\n \"https://treecouncil.org.uk/wp-content/uploads/2019/10/Tree_Council_Remarkable_Trees.jpg\"\n ]\n },\n {\n \"requirementName\": \"cnic_back\",\n \"values\": [\n \"https://your-bucket.s3.amazonaws.com/documents/cnic_back_123.jpg\"\n ]\n },\n {\n \"requirementName\": \"selfie\",\n \"values\": [\n \"https://your-bucket.s3.amazonaws.com/documents/selfie_123.jpg\"\n ]\n }\n ]\n },\n \"businessDetails\": {\n \"businessName\": \"Doe Enterprises\",\n \"businessType\": \"sole_proprietorship\",\n \"businessAddress\": {\n \"streetAddress\": \"123 Business Street\",\n \"city\": \"Karachi\",\n \"state\": \"Sindh\",\n \"country\": \"Pakistan\",\n \"coordinates\": {\n \"lat\": 24.8607,\n \"long\": 67.0011\n }\n },\n \"nationalDocumentId\": \"12345-1234567-1\",\n \"complianceDetails\": [\n {\n \"requirementName\": \"bank_statement\",\n \"values\": [\n \"https://treecouncil.org.uk/wp-content/uploads/2019/10/Tree_Council_Remarkable_Trees.jpg\"\n ]\n },\n {\n \"requirementName\": \"business_poc\",\n \"values\": [\n \"John Doe\"\n ]\n },\n {\n \"requirementName\": \"industry\",\n \"values\": [\n \"E-commerce & Online Retail\"\n ]\n },\n {\n \"requirementName\": \"currency_requirement\",\n \"values\": [\n \"5000\"\n ]\n },\n {\n \"requirementName\": \"proprietorship_declaration\",\n \"values\": [\n \"https://your-bucket.s3.amazonaws.com/documents/prop_declaration_123.pdf\"\n ]\n },\n {\n \"requirementName\": \"ntn_certificate\",\n \"values\": [\n \"https://your-bucket.s3.amazonaws.com/documents/ntn_cert_123.pdf\"\n ]\n },\n {\n \"requirementName\": \"form_ab\",\n \"values\": [\n \"https://your-bucket.s3.amazonaws.com/documents/form_ab_1.pdf\",\n \"https://your-bucket.s3.amazonaws.com/documents/form_ab_2.pdf\"\n ]\n }\n ]\n },\n \"bankDetails\": {\n \"bankId\": \"6488347be63016c52e361cb7\",\n \"accountTitle\": \"John Doe\",\n \"accountNumber\": \"1234567890\",\n \"iban\": \"PK36MEZN0000123456789012\"\n },\n \"optional\": {\n \"externalUserId\": \"EXT1234\",\n \"otherBusinessOwners\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/customers","description":"Registers a new customer — creates the business entity and individual owner entity in a single call. This is the first step in the lending process.
\nThe required compliance field names are fetched from Get Compliance Requirements.
\npersonalDetails (required) — Primary business owner (individual entity):
name, contactNumber, email, nationalDocumentId (required)
dob (optional) — ISO 8601 date.
complianceDetails (required) — [{ requirementName, values[] }]
businessDetails (required) — Business entity:
businessName, businessType, businessAddress, nationalDocumentId (required)
complianceDetails (required)
bankDetails (optional) — { bankId, accountTitle, accountNumber, iban? }
optional:
productId — Pre-assign a product at registration.
externalUserId — Your own customer reference ID.
otherBusinessOwners — Additional owners/directors (same shape as personalDetails).
language — Language preference for communications.
Returns individualEntity, businessEntity, bankAccount, and otherBusinessOwners.
Updates compliance requirement values (file URLs or field data) for a business or owner entity.
\nSubmitting compliance will move the entity's compliance status back to pending for back-office review.
\nURL Params:
\nstringcomplianceDetails: array (required, min 1 item)
requirementName: string — The requirement identifier (from Get Compliance Requirements).
values: string[] — Array of file URLs or string values.
Retrieves the list of available/supported banks
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","banks"],"host":["{{base_url_core}}"],"query":[],"variable":[]}},"response":[{"id":"559ce22a-a295-424e-abea-7b2e45e76b34","name":"Region - PK","originalRequest":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/banks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"088f13e0-e0d7-480e-8250-f7059ef7a131"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1105"},{"key":"ETag","value":"W/\"451-2su4OB4biU3G1yjcIkP/SJQSzS8\""},{"key":"Date","value":"Sun, 15 Jun 2025 19:07:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"6488347be63016c52e\",\n \"name\": \"Bank Of Khyber\",\n \"mnemonic\": \"BOK\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/bank-of-khyber.webp\",\n \"external_codes\": {\n \"meezan\": \"061\",\n \"jsbl\": \"41\",\n \"zindigi\": \"627618\",\n \"swich\": \"627618\"\n },\n },\n {\n \"_id\": \"6488347be63016c52e3\",\n \"name\": \"Faysal Bank Limited\",\n \"mnemonic\": \"FBL\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/faysal-bank.webp\",\n \"external_codes\": {\n \"jsbl\": \"6\",\n \"zindigi\": \"601373\",\n \"swich\": \"601373\"\n },\n },\n {\n \"_id\": \"6488347be63016c52e36\",\n \"name\": \"Meezan Bank Limited\",\n \"mnemonic\": \"MBL\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/meezan-bank.webp\",\n \"external_codes\": {\n \"jsbl\": \"22\",\n \"zindigi\": \"627873\",\n \"swich\": \"627873\"\n }\n }\n]"},{"id":"ac0eb196-cb66-4da3-a9e1-e8dcbd59b6c4","name":"Region - UAE","originalRequest":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/banks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"5157a71e-6f48-4544-86cb-cc160b6bb4a6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"564"},{"key":"ETag","value":"W/\"234-bdYUcW6g1aRFsh1DZdcQRJUR3FA\""},{"key":"Date","value":"Sun, 15 Jun 2025 19:42:10 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"680f8616f9ec5e5894db63\",\n \"name\": \"Sharjah Islamic Bank\",\n \"mnemonic\": \"SIB\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/dubai-islamic.webp\",\n },\n {\n \"_id\": \"680f8617f9ec5e5894db638d\",\n \"name\": \"United Arab Bank \",\n \"mnemonic\": \"UAB\",\n \"logo\": \"https://banks-logo.s3.ap-southeast-1.amazonaws.com/dubai-islamic.webp\",\n }\n]"}],"_postman_id":"b55f70b4-7746-4855-91b6-14abbafaae7a"},{"name":"Create Bank Account","id":"ee0d78d0-8dcc-45b1-93f3-fad51d78c0e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6488347be63016c52e361cb4\",\n \"accountTitle\": \"John Doe's Savings Account\",\n \"accountNumber\": \"1234567890\",\n \"iban\": \"SA1234567890123456789012\", // optional\n \"owner\": {\n \"id\": \"684f190f83dc3e10951268f7\",\n \"type\": \"entity\" // must be one of Stakeholder enum values\n },\n \"accountOwnership\": \"individual\", // must be one of AccountOwnershipType enum values\n \"isPreferred\": true,\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/customers/:businessEntityId/bank-accounts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","customers",":businessEntityId","bank-accounts"],"host":["{{base_url_core}}"],"query":[],"variable":[{"type":"any","value":"6488347be63016c52e361cb4","key":"businessEntityId"}]}},"response":[{"id":"83b2c4c4-4649-4f13-a0c6-473d4e1a68c6","name":"Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6488347be63016c52e361cb4\",\n \"accountTitle\": \"John Doe's Savings Account\",\n \"accountNumber\": \"1234567890\",\n \"iban\": \"SA1234567890123456789012\", // optional\n \"owner\": {\n \"id\": \"684f190f83dc3e10951268f7\",\n \"type\": \"entity\" // must be one of Stakeholder enum values\n },\n \"accountOwnership\": \"own\", // must be one of AccountOwnershipType enum values\n \"isPreferred\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url_core}}/v2/external/demand/customers/:businessEntityId/bank-accounts","host":["{{base_url_core}}"],"path":["v2","external","demand","customers",":businessEntityId","bank-accounts"],"variable":[{"key":"businessEntityId","value":"6488347be63016c52e361cb4"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"8696a454-95e0-486c-993f-1cbd7accd0a7"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"297"},{"key":"RateLimit-Reset","value":"30"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"510"},{"key":"ETag","value":"W/\"1fe-cveQ6OzeoENMMCjX7O98+PM7Drk\""},{"key":"Date","value":"Sun, 15 Jun 2025 19:09:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"bankAccount\": {\n \"bank_id\": \"6488347be63016c52e361cb4\",\n \"provided_account_title\": \"John Doe's Savings Account\",\n \"account_number\": \"1234567890\",\n \"owner\": {\n \"id\": \"684f190f83dc3e\",\n \"type\": \"entity\"\n },\n \"iban\": \"SA1234567890123456\",\n \"_id\": \"684f1a6c463e4df628\",\n \"currency\": \"PKR\"\n }\n}"},{"id":"b25e9010-0f68-4250-a311-c0e330199c84","name":"Error - Bank Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6488347be63016c52e361cb3\",\n \"accountTitle\": \"John Doe's Savings Account\",\n \"accountNumber\": \"1234567890\",\n \"iban\": \"SA1234567890123456789012\", // optional\n \"owner\": {\n \"id\": \"684f190f83dc3e10951268f7\",\n \"type\": \"entity\" // must be one of Stakeholder enum values\n },\n \"accountOwnership\": \"own\", // must be one of AccountOwnershipType enum values\n \"isPreferred\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url_core}}/v2/external/demand/customers/:businessEntityId/bank-accounts","host":["{{base_url_core}}"],"path":["v2","external","demand","customers",":businessEntityId","bank-accounts"],"variable":[{"key":"businessEntityId","value":"6488347be63016c52e361cb4"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"c84c8f30-9ff9-43e0-9399-63c89ce0b33a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"28"},{"key":"ETag","value":"W/\"1c-6UkEkGhw2FrsD0K4zBAb02ZCcNo\""},{"key":"Date","value":"Tue, 29 Jul 2025 09:40:02 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Bank Not Found\"\n }\n ]\n}"},{"id":"21dd54f7-151e-49d0-a5a9-3909999a0bcd","name":"Error - Invalid Owner Type","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6488347be63016c52e361cb3\",\n \"accountTitle\": \"John Doe's Savings Account\",\n \"accountNumber\": \"1234567890\",\n \"iban\": \"SA1234567890123456789012\", // optional\n \"owner\": {\n \"id\": \"684f190f83dc3e10951268f7\",\n \"type\": \"ent\" // must be one of Stakeholder enum values\n },\n \"accountOwnership\": \"own\", // must be one of AccountOwnershipType enum values\n \"isPreferred\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url_core}}/v2/external/demand/customers/:businessEntityId/bank-accounts","host":["{{base_url_core}}"],"path":["v2","external","demand","customers",":businessEntityId","bank-accounts"],"variable":[{"key":"businessEntityId","value":"6488347be63016c52e361cb4"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"6226a05d-d2a0-4bfd-be59-1ab8463ca9bb"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"139"},{"key":"ETag","value":"W/\"8b-7k6QVy8r5SrT///W5jB/QTGE3dw\""},{"key":"Date","value":"Tue, 29 Jul 2025 09:41:26 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"owner.type must be one of the following values: broker, entity, partner, financier, product\",\n \"field\": \"owner.type\"\n }\n ]\n}"}],"_postman_id":"ee0d78d0-8dcc-45b1-93f3-fad51d78c0e6"},{"name":"Update Bank Account","id":"1d402803-8c45-4239-a92c-8c60eb63701c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"accountTitle\": \"Karl Marx\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/bank-accounts/:bankAccountId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","bank-accounts",":bankAccountId"],"host":["{{base_url_core}}"],"query":[],"variable":[{"type":"any","value":"6091bbc9573566cb28234245","key":"bankAccountId"}]}},"response":[{"id":"0c5d68e6-d845-4ca8-985d-a22ccb1794d9","name":"Response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"accountTitle\": \"Karl Marx\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url_core}}/v2/external/demand/bank-accounts/:bankAccountId","host":["{{base_url_core}}"],"path":["v2","external","demand","bank-accounts",":bankAccountId"],"variable":[{"key":"bankAccountId","value":"6891bbc9573566cb2822b54a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"3388c22d-5be1-4854-8d99-6b4d8091746d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"192"},{"key":"ETag","value":"W/\"c0-4BrJ2pJdNAuigWhe2YsycILjayI\""},{"key":"Date","value":"Wed, 06 Aug 2025 07:05:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"bankAccount\": {\n \"bank_id\": \"683f4f0599b4c115d665f30b\",\n \"account_number\": \"04771007648259\",\n \"iban\": \"PK77MEZN0001270104775019\",\n \"provided_account_title\": \"Karl Marx\",\n \"_id\": \"6891bbc9573566cb2822b54a\"\n }\n}"}],"_postman_id":"1d402803-8c45-4239-a92c-8c60eb63701c"},{"name":"Get Customer Bank Accounts","id":"8d369d7e-bce6-4db7-8114-58b55c66c7ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/customers/:businessEntityId/bank-accounts","description":"Retrieve's a customer's bank accounts
\nQuery Params:
\nownerId: string
nationalDocumentId: string
NOTE: Either one of the query params must be present
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","customers",":businessEntityId","bank-accounts"],"host":["{{base_url_core}}"],"query":[],"variable":[{"description":{"content":"The business entity ID
\n","type":"text/plain"},"type":"any","value":"68361134731c761aa27ca3fd","key":"businessEntityId"}]}},"response":[{"id":"6a7e3bb2-98cd-46fe-a0dc-cd5447dd46c6","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url_core}}/v2/external/demand/customers/:businessEntityId/bank-accounts","host":["{{base_url_core}}"],"path":["v2","external","demand","customers",":businessEntityId","bank-accounts"],"variable":[{"key":"businessEntityId","value":"68361134731c761aa27ca3fd","description":"The business entity ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"496f6d8f-e3ac-4d08-bf14-d5dbe759116f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"190"},{"key":"ETag","value":"W/\"be-GdDJc6AffoT//5aoGjldoDMb62k\""},{"key":"Date","value":"Thu, 19 Jun 2025 09:20:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"bankAccounts\": [\n {\n \"provided_account_title\": \"John Doe\",\n \"bank_id\": \"6488347be63016c52e3\",\n \"iban\": \"PK36MEZN000012345678\",\n \"account_number\": \"1234567890\",\n \"_id\": \"6853d1fb60f7c0197a5\"\n }\n ]\n}"}],"_postman_id":"8d369d7e-bce6-4db7-8114-58b55c66c7ba"},{"name":"Verify Account Title","id":"5a0f6aca-28bc-487d-b24b-637280422e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6488347be63016c52e361cb4\",\n \"accountNumber\": \"1234567890\",\n \"externalCustomerId\": \"your-external-id-here\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/bank-accounts/verify-account-title","description":"Verifies that the bank account title matches the name of the linked individual entity on record. Used to confirm account ownership.
\nbankId: string (required)
accountNumber: string (required)
externalCustomerId: string (required) — Your external customer identifier.
{\n \"name\": \"John Doe\",\n \"verifiedAccountTitle\": \"JOHN DOE\",\n \"isMatch\": true\n}\n\nUsed to update an entity. Unlike compliance, updating an entity will not revert a customer to a pending state.
\nThe following entity fields may be updated through this endpoint:
\n address: object()\n .shape({\n streetAddress: string(),\n city: string(),\n state: string(),\n country: string(),\n coordinates: object()\n .shape({\n lat: number(),\n long: number(),\n }),\n }),\n name: string(),\n contactNumber: string() // only for business owners - individual entity \n\nRetrieves all agreements linked to a business entity — including customer-level and loan-level agreements.
\nbusinessEntityId: string (required) — The business entity ID.The business entity ID
\n","type":"text/plain"},"type":"any","value":"68361134731c761aa27ca3fd","key":"businessEntityId"}]}},"response":[{"id":"7872f6fe-55fd-45d1-bd2b-666c6092759f","name":"Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://dev-credr.creditbookapi.com\n/v2/external/demand/customer/:businessEntityId/agreements","protocol":"https","host":["dev-credr","creditbookapi","com\n"],"path":["v2","external","demand","customer",":businessEntityId","agreements"],"variable":[{"key":"businessEntityId","value":"68361134731c761aa27ca3fd"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"ac72b3e4-bf50-4499-a16d-990e778f7dab"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"755"},{"key":"ETag","value":"W/\"2f3-WjHPWUR1LpEGot23iVsURvaVh5c\""},{"key":"Date","value":"Fri, 20 Jun 2025 09:23:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"agreements\": [\n {\n \"financier\": {\n \"name\": \"CBFS\"\n },\n \"product\": {\n \"id\": \"67c6a9f1e4430552\",\n \"name\": \"Cash Flow Financing\"\n },\n \"meta\": {\n \"envelope_id\": \"684d40788768ae06ea\",\n \"envelope_url\": \"https://st.dash.co/?token=eyJh\"\n },\n \"type\": \"finance_agreement\",\n \"documents\": [],\n \"markup\": 47.714,\n \"credit_limit\": {\n \"amount\": 30000,\n \"currency\": \"PKR\"\n },\n \"status\": {\n \"current\": \"terminated\",\n \"timestamp\": \"2025-06-17T10:07:28.485Z\",\n \"actor\": \"67d181641ad3e3cfb\",\n \"comment\": \"agreement v2 webhook testing\"\n },\n \"_id\": \"684d40772e8d7820ca\"\n }\n ]\n}"},{"id":"4ce68823-edb9-40f5-acca-26cfc29ae173","name":"Error - Invalid businessEntityId","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url_core}}/v2/external/demand/customer/:businessEntityId/agreements","host":["{{base_url_core}}"],"path":["v2","external","demand","customer",":businessEntityId","agreements"],"variable":[{"key":"businessEntityId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"a3fba0e6-74de-48dc-8740-eae488aa8a2e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"57"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"103"},{"key":"ETag","value":"W/\"67-dlRBVGmyCJ6AUFUlrBdvJ6EoJUk\""},{"key":"Date","value":"Tue, 29 Jul 2025 09:43:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"businessEntityId must be a valid MongoDB ObjectId\",\n \"field\": \"businessEntityId\"\n }\n ]\n}"}],"_postman_id":"fab1b112-1d89-4f11-a52c-4ce0a585df7f"},{"name":"Data Sharing","id":"a63d966e-f18f-4f46-8957-a0b82236ae6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/partner/data-sharing?noOfFiles=3","description":"This API allows partners to generate signed URLs for sharing customers transactional data with broker.
\nfiles: string | string[] (optional, max 10) — Specific filenames to generate signed URLs for.
noOfFiles: number (optional, 1–10) — Number of generic signed URLs to generate (without specific filenames).
\n\nUse either
\nfilesornoOfFiles— not both.
Partners can upload individual files or ZIP files using the provided signed URLs
\nSigned URLs expire after 30 minutes
\nThe maximum number of signed URLs that can be generated in a single API call is limited to 10
\n401 Unauthorized: Invalid/Missing API key or partner ID
\n403 Forbidden: Partner not authorized to generate signed URLs
\n500 Internal Server Error: An error occurred on the server
\nRetrieves customer entity records by one or more identifiers. Use this to look up an existing customer.
\nemail: string — Individual owner's email.
businessNationalDocumentId: string — Business national document ID (e.g. NTN, CNIC).
phoneNumber: string — Phone number.
externalUserId: string — Your external customer identifier.
Returns individualEntity, businessEntity, otherBusinessOwners, and bankAccount.
Returns the compliance record for a business, or for an owner when ownerEntityId is set.
When something is rejected, you may also get a reason_code — a short string saying why.
There are two places to look:
\nreason_code is optional. It is usually only present when current is rejected. If the key is missing, ignore it — do not treat it as empty.
Can the customer reapply? See the Can reapply? column on the type pages below. When it is Yes, fix the document/field and resubmit with Update Compliance.
\nThe same status.reason_code also appears on Get Customer (compliance snapshot). Full requirement-level codes appear on Update Compliance and on each owner’s compliance in Get Customer Owners.
Webhooks only send the top-level (status) code. Use this GET if you need codes on individual requirements.
status.reason_coderequirements[].status.reason_code{\n \"id\": \"6978561e333bf361d6b19f70\",\n \"entity\": {\n \"id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"full_name\": \"Doe Enterprises\"\n },\n \"status\": {\n \"current\": \"rejected\",\n \"timestamp\": \"2026-01-27T08:51:59.574Z\",\n \"comment\": \"Application declined\",\n \"reason_code\": \"declined\"\n },\n \"requirements\": [\n {\n \"name\": \"cnic_front\",\n \"input_type\": \"document\",\n \"value\": [\"https://...\"],\n \"status\": {\n \"current\": \"rejected\",\n \"timestamp\": \"2026-01-27T08:50:12.000Z\",\n \"reason_code\": \"unreadable\"\n }\n }\n ]\n}\nThis section outlines the process of Customer Onboarding. The general flow for this includes:
\nGetting Compliance Requirements from Get Form Meta API
\nRegistering the customer using the Create Entity API
\nUpdate Entity (if required)
\nNOTE: The image or pdf files wherever required in the requests are to be publicly accessible URLs
\n","event":[{"listen":"prerequest","script":{"id":"005701f0-71c0-4194-a799-02bf48189758","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c7e515e5-27aa-4071-a37b-34ed04733ef5","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2d098dbf-6dbe-4887-8157-2310d8338529","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Financing","item":[{"name":"Main","item":[{"name":"Get Available Products","id":"a01353da-2fd2-43cb-ac28-79a5bf002025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/products","description":"This returns a list of the Products available to the Partner
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","products"],"host":["{{base_url_core}}"],"query":[],"variable":[]}},"response":[{"id":"104d4aea-9f61-472f-82d1-dd2a0a5527af","name":"Response","originalRequest":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"824e0a9e-5061-429c-95d2-2882a6f31abf"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1133"},{"key":"ETag","value":"W/\"46d-VOb4KfqHYpl9qJD52j296/MB0I4\""},{"key":"Date","value":"Wed, 18 Jun 2025 06:38:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"products\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"tenors\": [\n {\n \"tenor\": {\n \"type\": \"string\",\n \"min\": 0,\n \"max\": 0\n },\n \"conditions\": [\n \"string\"\n ]\n }\n ],\n \"currency\": \"PKR\",\n \"sub_type\": \"string\",\n \"interest_rate\": {\n \"min\": 0,\n \"max\": 0\n },\n \"fee\": 0\n }\n ]\n}"}],"_postman_id":"a01353da-2fd2-43cb-ac28-79a5bf002025"},{"name":"Get Customer Products","id":"0a5423c6-bee0-402f-9f71-81962b999032","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/entities/:businessEntityId/products","description":"Returns a list of products from the Partner's Available Products for which the given customer is eligible to apply for financing
\nURL Params:
\nbusinessEntityId: string (required) — The business entity ID.status: string (optional) — Filter by product status.Each product includes: assigned/available credit limits, tenors, interest rate range (min/max), fee, currency, and current status.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"path":["v2","external","demand","entities",":businessEntityId","products"],"host":["{{base_url_core}}"],"query":[{"disabled":true,"description":{"content":"Status of the customer products (active, inactive)
\n","type":"text/plain"},"key":"status","value":"active"}],"variable":[{"type":"any","value":"68361134731c761aa27ca3fd","key":"businessEntityId"}]}},"response":[{"id":"e81cbf15-e1eb-4f3b-b74a-d74c53271f9a","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url_core}}/v2/external/demand/entities/:businessEntityId/products","host":["{{base_url_core}}"],"path":["v2","external","demand","entities",":businessEntityId","products"],"variable":[{"key":"businessEntityId","value":"68361134731c761aa27ca3fd"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-request-id","value":"cce18c8f-02f8-4a34-b1d2-165570cb50b5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"297"},{"key":"RateLimit-Reset","value":"54"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"395"},{"key":"ETag","value":"W/\"18b-CdfVRlwrbHvACFs1BhKXsmqs5pM\""},{"key":"Date","value":"Sun, 15 Jun 2025 19:28:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"products\": [\n {\n \"product_id\": \"string\",\n \"name\": \"string\",\n \"tenors\": [\n {\n \"tenor\": {\n \"type\": \"string\",\n \"min\": 0,\n \"max\": 0\n },\n \"conditions\": [\n \"string\"\n ]\n }\n ],\n \"assigned_credit_limits\": {\n \"CBFS\": {\n \"amount\": 0,\n \"currency\": \"PKR\"\n },\n \"max\": {\n \"amount\": 0,\n \"currency\": \"PKR\"\n }\n },\n \"available_credit_limits\": {\n \"CBFS\": {\n \"amount\": 0,\n \"currency\": \"PKR\"\n },\n \"max\": {\n \"amount\": 0,\n \"currency\": \"PKR\"\n }\n },\n \"status\": {\n \"current\": \"active\",\n \"timestamp\": \"\"\n },\n \"external_customer_id\": \"string\",\n \"currency\": \"PKR\",\n \"sub_type\": \"string\",\n \"interest_rate\": {\n \"min\": 0,\n \"max\": 0\n },\n \"fee\": 0\n }\n ]\n}"}],"_postman_id":"0a5423c6-bee0-402f-9f71-81962b999032"},{"name":"Create Loan","id":"ec12a1a7-11d9-467d-a789-d52ff993f38f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"invoiceData\": [\n {\n \"name\": \"Invoice_Doc_1\",\n \"resourceURL\": \"https://treecouncil.org.uk/wp-content/uploads/2019/10/Tree_Council_Remarkable_Trees.jpg\"\n }\n ],\n \"requiredFinancing\": 454\n // \"tenor\":\"30\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/services/loans/:productId/create?entityId=6907a5efabb7364598bb2298&","description":"Once a customer has selected a product, a financing request can be created through this endpoint, which generates a loan application. Once the back office approves the request, the application turns into a loan awaiting disbursal.
\nContent-Type: application/json
{\n \"requiredFinancing\": 50000,\n \"invoiceData\": [\n {\n \"fileName\": \"invoice_001.pdf\",\n \"fileUrl\": \"https://example.com/files/invoice_001.pdf\"\n }\n ],\n \"externalId\": \"EXT-REF-12345\",\n \"tenor\": 12,\n \"disbursementAccountDetails\": {\n \"accountNumber\": \"1234567890\",\n \"bankCode\": \"ABC001\"\n \"bankId\": \"ABC001\";\n \"accountTitle\": \"John Doe\";\n \"iban\": \"IBAN\";\n }\n}\n\nReturns a created loan's details
\nstringCreates a repayment transaction
\nstringamount: number
date: Date
type: \"repayment\"
\npaymentMethod:
\nThe customer needs an address (typically a bank account details) for repayments. Therefore, this API basically helps in retrieving the user's virtual account. The account's creation is executed by the broker internally.
stringThis helps the customer predict their balance to repay before applying for a loan.
\nPredicts the loan balance breakdown before a customer applies for financing. Returns estimated fees, markup, and principal.
\n\n\n⚠️ These are estimated values only and may differ from the final approved loan terms.
\n
principalAmount: number (required) — The requested financing amount.
productId: string (required) — The product ID.
disbursementDate: datetime (optional) — Expected disbursement date (ISO 8601).
todayDate: datetime (optional) — Override today's date for simulation/testing purposes.
tenure: number (optional) — Loan tenure value.
entityId: string (optional) — Entity ID for customer-specific rate resolution.
{\n \"fees\": 200,\n \"markup\": 150,\n \"principal\": 20000,\n \"terms\": [...]\n}\n\nrequired except when entityId is provided
\n","type":"text/plain"},"key":"tenure","value":"104"},{"disabled":true,"description":{"content":"optional; for personalized terms only if pre-configured in product
\n","type":"text/plain"},"key":"entityId","value":"6996dbc8654c1470bd09d1d7"}],"variable":[]}},"response":[{"id":"4e907321-f31b-4792-bf28-e72f960cb9c7","name":"Base Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url_core}}/v2/external/demand/services/loans/predict?principalAmount=20000&disbursementDate=2026-01-27T07:31:40.830Z&productId=6837ff3f63e958c9060b85bd&tenure=104","host":["{{base_url_core}}"],"path":["v2","external","demand","services","loans","predict"],"query":[{"key":"principalAmount","value":"20000"},{"key":"disbursementDate","value":"2026-01-27T07:31:40.830Z"},{"key":"productId","value":"6837ff3f63e958c9060b85bd"},{"key":"tenure","value":"104","description":"required except when entityId is provided"},{"key":"entityId","value":"6996dbc8654c1470bd09d1d7","description":"optional; for dynamic pricing/personalized terms only","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Tue, 07 Apr 2026 14:21:46 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"45"},{"key":"x-request-id","value":"24172e91-8ff2-4780-b2b6-80f1c1e8ccb0"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-expose-headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"60"},{"key":"etag","value":"W/\"2d-C72RYzUn3Alia7EtbOnTmq9sX+I\""}],"cookie":[],"responseTime":null,"body":"{\n \"fees\": 1500,\n \"markup\": 4400,\n \"principal\": 20000\n}"},{"id":"c7c28ea3-f9b5-4e60-a9ab-4243fa8739c9","name":"Response with personalized terms","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url_core}}/v2/external/demand/services/loans/predict?principalAmount=20000&disbursementDate=2026-01-27T07:31:40.830Z&productId=6837ff3f63e958c9060b85bd&entityId=6996dbc8654c1470bd09d1d7","host":["{{base_url_core}}"],"path":["v2","external","demand","services","loans","predict"],"query":[{"key":"principalAmount","value":"20000"},{"key":"disbursementDate","value":"2026-01-27T07:31:40.830Z"},{"key":"productId","value":"6837ff3f63e958c9060b85bd"},{"key":"tenure","value":"104","description":"required except when entityId is provided","disabled":true},{"key":"entityId","value":"6996dbc8654c1470bd09d1d7","description":"optional; for dynamic pricing/personalized terms only"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Tue, 07 Apr 2026 14:21:24 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"92"},{"key":"x-request-id","value":"5079eaa7-5d1f-485f-b754-1b7de1d75f28"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-expose-headers","value":"Content-Disposition,X-Request-Id"},{"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-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=31536000; 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":"13"},{"key":"etag","value":"W/\"5c-YFjlkeqcDNjhfWX7Is1hxp877sk\""}],"cookie":[],"responseTime":null,"body":"{\n \"fees\": 1500,\n \"markup\": 9000,\n \"principal\": 20000,\n \"terms\": {\n \"tenor\": 122,\n \"markup\": 45,\n \"apr\": 157.07\n }\n}"}],"_postman_id":"2b1f8680-3802-4341-868d-034d7002798c"}],"id":"d7fc9f55-7bb7-417e-abba-9725b371d8f4","_postman_id":"d7fc9f55-7bb7-417e-abba-9725b371d8f4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Utils","item":[{"name":"Get Loan Transactions","id":"eb2d981a-1946-4b28-8934-b1a554783567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url_core}}/v2/external/demand/services/loans/:loanId/transactions","description":"Retrieves all the transactions linked to a loan
\nURL Params:
\nstringRetrieves all the loans linked to a customer
\nentityId: string
status.current: enum(LoanState)
export const LoanState = {\n // initial states\n IN_PROGRESS: \"in_progress\",\n UNDER_REVIEW: \"under_review\",\n // intermediate \n REVISION_REQUESTED: \"revision_requested\",\n APPROVED: \"approved\",\n READY_TO_DISBURSE: \"ready_to_disburse\",\n DISBURSED: \"disbursed\",\n OVERDUE: \"overdue\",\n // terminal\n REJECTED: \"rejected\",\n COMPLETED: \"completed\",\n} as const;\n\nGenerates a pre-signed S3 URL for uploading or downloading files (compliance documents, invoices, transaction receipts etc.).
\nfileName: string (required) — The target filename (e.g. cnic_front.jpg).
urlType: PreSignedUrlType (optional) — put for upload, get for download.
uploadType: UploadType (optional) — Upload category (e.g. compliance). Required when urlType=put.
Call this endpoint to get a signed URL.
\nUse the URL to PUT your file directly to S3 from the client.
\nUse the returned resource URL in submission payloads.
\nThe APIs in this section outline how a customer applies for financing. The general flow is to:
\nGet the products available to the customer from Get Customer Products
\nCreate a Loan Service request for that product
\nOnce the loan is approved and disbursed, a customer's virtual account details can be retrieveed from Get Repayment Details
\nFinally a customer may make a repayment to the virtual account and create a corresponding transaction through the Create Repayment Transaction API
\nThe broker expects an authentication URL that intakes email and password (dedicated for us) and returns a JWT token. Following is how we expect to invoke this authentication URL on the partner's end 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 username,\n password,\n });\nreturn loginResponse.data.token;\n\nFollowing 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\nProvide a URL for each event you want to receive (same URL is fine for multiple events). Leave a field blank to skip that event.
\n","_postman_id":"a0d8f9af-fb75-42f3-ae88-e1d4a5b8b765","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Webhook Payloads","item":[{"name":"General Event Payload","item":[],"id":"1cad3107-d7cb-4a2c-9ed2-013a949f4cb0","description":"Webhooks tell you what changed, not the customer’s full record.
\nevent_type first.event_data as optional.null.{\n \"event_type\": \"compliance_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {}\n}\nCustomer-related events are documented below. Agreement, service, transaction, and offer payloads have their own pages.
\nevent_type. customer_id (and external_customer_id if present). event_data. Sent when a customer’s business profile or owner details change.
\nEach event contains either profile or relationship — not both.
Only changed profile fields are included.
\nExample — only the address changed:
\n{\n \"event_type\": \"customer_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"partner-customer-001\",\n \"type\": \"business\",\n \"profile\": {\n \"address\": {\n \"street_address\": \"Street 5\",\n \"city\": \"Lahore\",\n \"state\": \"Punjab\",\n \"country\": \"Pakistan\"\n }\n }\n }\n}\nrelationship.id identifies which owner changed. Other relationship fields are included only when present — apply only what you receive.
Example — owner name and phone changed:
\n{\n \"event_type\": \"customer_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"relationship\": {\n \"id\": \"6978561e333bf361d6b19f67\",\n \"full_name\": \"Muhammad Usman\",\n \"phone_number\": \"+923001234567\"\n }\n }\n}\nSent when a customer’s compliance status changes.
\ncompliance is one of two shapes:
overall_status — result for the customer as a whole entity + status — result for a specific business or owner{\n \"event_type\": \"compliance_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"compliance\": {\n \"overall_status\": {\n \"current\": \"approved\",\n \"timestamp\": \"2026-01-27T08:51:59.574Z\"\n }\n }\n }\n}\n{\n \"event_type\": \"compliance_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"compliance\": {\n \"entity\": {\n \"id\": \"6978561e333bf361d6b19f67\",\n \"type\": \"individual\"\n },\n \"status\": {\n \"current\": \"rejected\",\n \"timestamp\": \"2026-01-27T08:51:59.574Z\",\n \"comment\": \"Application declined\",\n \"reason_code\": \"declined\"\n }\n }\n }\n}\nHow to read it
\ncompliance.overall_status exists → update overall compliance state. compliance.entity exists → update that entity’s compliance state. comment / reason_code when they are present.Sent when a customer’s risk status changes for a financing product.
\n{\n \"event_type\": \"risk_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"risk\": {\n \"product_id\": \"67c6a9f1e4430552\",\n \"financier\": \"CBFS\",\n \"status\": {\n \"current\": \"approved\",\n \"timestamp\": \"2026-01-27T08:51:59.574Z\"\n }\n }\n }\n}\nSent when a customer’s credit limits change for a product.
\nYou may receive assigned limits, available limits, or both — depending on what changed.
\nExample — only available limits changed:
\n{\n \"event_type\": \"customer_product_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"product\": {\n \"id\": \"67c6a9f1e4430552\",\n \"available_credit_limits\": {\n \"CBFS\": { \"amount\": 35000, \"currency\": \"PKR\" },\n \"max\": { \"amount\": 35000, \"currency\": \"PKR\" }\n }\n }\n }\n}\nSent when a customer bank account is created or updated.
\n{\n \"event_type\": \"bank_account_update\",\n \"timestamp\": \"2026-01-27T13:51:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"type\": \"business\",\n \"bank_account\": {\n \"id\": \"6978561e333bf361d6b19f69\",\n \"bank_name\": \"HBL\",\n \"provided_account_title\": \"Usman Traders\",\n \"account_number\": \"1234567890\"\n }\n }\n}\nThese are the string values your integration should expect. Webhooks do not send a separate schema — only these strings appear in the payload.
\nevent_data.type is always \"business\" for now.compliance.entity.type can be either value below (which business or person the compliance status applies to).Used in profile.business_type when present.
Used in compliance.overall_status.current and compliance.status.current.
Used in risk.status.current.
Used in reason_code when present (typically with rejected).
Full list (meanings + can reapply): Compliance reason codes (entity-level).
\nRequirement-level codes are not sent on webhooks — see Compliance reason codes (requirement-level) and Get Customer Compliance.
\n","_postman_id":"1286e898-6e4a-181d-64fe-200240c60a2d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Agreement Creation","item":[],"id":"8a3350b1-c18b-4586-ae9b-a9beadedcf01","description":"Fired when a new agreement is created and sent for signing — either a customer-level financing agreement or a loan-level agreement.
\n// event_type: \"agreement_create\"\ninterface IAgreementCreateData extends IEventBaseData {\n id: string;\n type: \"finance_agreement\"; // AgreementType\n status: \"pending\" | \"active\" | \"expired\" | \"terminated\"; // AgreementStatus\n service?: { id: string; type: string }; // present if loan-level agreement\n agreement_url?: string; // DashSign signing URL\n financier: string; // financier name (e.g. \"CBFS\")\n signing_date?: Date;\n expiry_date?: Date;\n documents?: {\n id: string;\n name: string;\n url: string; // pre-signed S3 URL (expires in 1 hour)\n mime: string;\n size: number;\n meta?: { order: number };\n created_at: Date;\n updated_at: Date;\n }[];\n attachments?: object[];\n credit_limit?: { amount: number; currency: string }; \n markup?: number; \n}\n\n{\n \"event_type\": \"agreement_create\",\n \"timestamp\": \"2026-01-27T17:26:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-5b95-40f397669a03\",\n \"id\": \"6978af09333bf361d6b339dc\",\n \"type\": \"finance_agreement\",\n \"status\": \"pending\",\n \"financier\": \"CBFS\",\n \"service\": { \"id\": \"6978af08333bf361d6b339ac\", \"type\": \"loan\" },\n \"agreement_url\": \"https://secure.dashsign.co/?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"documents\": [],\n \"attachments\": [],\n \"credit_limit\": { \"amount\": 25000, \"currency\": \"PKR\" },\n \"markup\": 8\n }\n}\n\n\n\n","_postman_id":"8a3350b1-c18b-4586-ae9b-a9beadedcf01","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Agreement Update","item":[],"id":"8df05f02-1653-46dc-9033-3ede30741f44","description":"\n
agreement_url— A DashSign signing URL. Redirect the customer to this URL to complete the digital signing.
Fired when an agreement's status changes — most commonly when it moves from pending to active after the customer signs.
// event_type: \"agreement_update\"\ninterface IAgreementUpdateData extends IEventBaseData {\n id: string;\n type?: \"finance_agreement\" | \"loan_agreement\" | string;\n status?: \"pending\" | \"active\" | \"expired\" | \"terminated\";\n service?: { id: string; type: string };\n agreement_url?: string;\n financier?: string;\n signing_date?: Date;\n expiry_date?: Date;\n documents?: {\n id: string; name: string; url: string; mime: string; size: number;\n meta?: { order: number }; created_at: Date; updated_at: Date;\n }[];\n attachments?: object[];\n amendments?: {\n id: string;\n status?: string;\n signing_date?: Date;\n credit_limit?: { amount: number; currency: string };\n documents?: object[];\n meta?: { envelope_url?: string };\n }[];\n credit_limit?: { amount: number; currency: string };\n markup?: number;\n}\n\n{\n \"event_type\": \"agreement_update\",\n \"timestamp\": \"2026-02-25T17:14:44.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-0000-00000000\",\n \"id\": \"6978af09333bf361d6b339dc\",\n \"type\": \"finance_agreement\",\n \"status\": \"active\",\n \"signing_date\": \"2026-02-25T12:14:44.722Z\",\n \"expiry_date\": \"2027-02-25T12:14:44.722Z\",\n \"financier\": \"CBFS\",\n \"service\": { \"id\": \"6978af08333bf361d6b339ac\", \"type\": \"loan\" },\n \"agreement_url\": \"https://secure.dashsign.co/?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"credit_limit\": { \"amount\": 25000, \"currency\": \"PKR\" },\n \"markup\": 8,\n \"documents\": [\n {\n \"id\": \"6978af0a39584da3414c3ad8\",\n \"name\": \"ID - Personal Guarantee.pdf\",\n \"url\": \"https://cb-finance-core-api-prod-bucket.s3.me-central-1.amazonaws.com/...\",\n \"mime\": \"application/pdf\",\n \"size\": 101410,\n \"meta\": { \"order\": 0 },\n \"created_at\": \"2026-02-25T12:14:45.411Z\",\n \"updated_at\": \"2026-02-25T12:14:45.411Z\"\n },\n {\n \"id\": \"6978af0a39584da3414c3adb\",\n \"name\": \"ID - Offer Letter.pdf\",\n \"url\": \"https://cb-finance-core-api-prod-bucket.s3.me-central-1.amazonaws.com/...\",\n \"mime\": \"application/pdf\",\n \"size\": 196806,\n \"meta\": { \"order\": 1 },\n \"created_at\": \"2026-02-25T12:14:45.411Z\",\n \"updated_at\": \"2026-02-25T12:14:45.411Z\"\n },\n {\n \"id\": \"6978af0a39584da3414c3ade\",\n \"name\": \"ID - Finance Agreement.pdf\",\n \"url\": \"https://cb-finance-core-api-prod-bucket.s3.me-central-1.amazonaws.com/...\",\n \"mime\": \"application/pdf\",\n \"size\": 187173,\n \"meta\": { \"order\": 2 },\n \"created_at\": \"2026-02-25T12:14:45.411Z\",\n \"updated_at\": \"2026-02-25T12:14:45.411Z\"\n }\n ],\n \"attachments\": [],\n \"amendments\": []\n }\n}\n\n\n\n","_postman_id":"8df05f02-1653-46dc-9033-3ede30741f44","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Service Update","item":[],"id":"e6065a75-bb09-416c-bfb0-3b3d24a5d8d4","description":"\n
documents— Pre-signed S3 URLs for the signed agreement PDFs (Personal Guarantee, Offer Letter, Finance Agreement).
Fired when a loan's status changes. The full loan lifecycle is communicated via this event.
\n// event_type: \"service_update\"\ninterface IServiceUpdateData extends IEventBaseData {\n id: string;\n type: \"loan\" | \"savings\";\n status:\n | \"under_review\"\n | \"approved\"\n | \"disbursed\"\n | \"overdue\"\n | \"completed\"\n | \"rejected\"\n | undefined;\n comment?: string; // present on rejection or approval/disbursal notes\n terms?: IServiceTerms[]; // present on approved / ready_to_disburse / disbursed\n}\ninterface IServiceTerms {\n principal: number;\n markup: number; // percentage rate/amount\n tenor: number; // in days\n balance?: {\n pending: {\n principal: number;\n markup: number;\n fee: number;\n unceiled_fee: number;\n unceiled_markup: number;\n };\n repaid: {\n principal: number;\n markup: number;\n fee: number;\n };\n };\n disbursement_date?: Date;\n due_date?: Date;\n markup_per_day?: number; // percentage rate/amount\n}\n\n{\n \"event_type\": \"service_update\",\n \"timestamp\": \"2026-02-25T17:14:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-5b95-40f397669a03\",\n \"id\": \"6978af08333bf361d6b339ac\",\n \"type\": \"loan\",\n \"status\": \"approved\",\n \"comment\": \"Loan approved automatically as auto-approval enabled and criteria met\",\n \"terms\": [{ \"principal\": 15000, \"markup\": 8, \"tenor\": 84 }]\n }\n}\n\n{\n \"event_type\": \"service_update\",\n \"timestamp\": \"2026-02-25T17:14:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-5b95-40f397669a03\",\n \"id\": \"6978af08333bf361d6b339ac\",\n \"type\": \"loan\",\n \"status\": \"rejected\",\n \"comment\": \"Already overdues pending.\",\n \"terms\": [{ \"principal\": 15000, \"markup\": 8, \"tenor\": 84 }]\n }\n}\n\n{\n \"event_type\": \"service_update\",\n \"timestamp\": \"2026-05-01T00:20:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-0000-00000000\",\n \"id\": \"6978af08333bf361d6b339ac\",\n \"type\": \"loan\",\n \"status\": \"disbursed\",\n \"comment\": \"Auto disbursed via swich\",\n \"terms\": [\n {\n \"principal\": 15000,\n \"markup\": 0,\n \"tenor\": 30,\n \"balance\": {\n \"pending\": {\n \"principal\": 14701,\n \"markup\": 0,\n \"fee\": 0,\n \"unceiled_fee\": 0,\n \"unceiled_markup\": 0\n },\n \"repaid\": {\n \"principal\": 299,\n \"markup\": 0,\n \"fee\": 0\n }\n },\n \"disbursement_date\": \"2026-02-24T19:00:00.000Z\",\n \"due_date\": \"2026-05-19T19:00:00.000Z\",\n \"markup_per_day\": 0\n }\n ]\n }\n}\n\nFired when a new transaction is created against a loan (disbursement, repayment, fee, etc.).
\n// event_type: \"transaction_create\"\ninterface ITransactionCreateData extends IEventBaseData {\n id: string;\n service: { id: string; type: \"loan\"};\n payment_method: \"bank_transfer\" | \"cash\" | \"cheque\" | \"online\" | string;\n type: \"disbursement\" | \"repayment\" | \"marking\" | \"refund\" | \"adjustment\" | \"fee\" | \"write-off\";\n status: \"pending\" | \"completed\" | \"failed\" | \"cancelled\";\n amount: { amount: number; currency: string };\n date: string; // date string in region timezone (YYYY-MM-DD)\n description?: string;\n attachments?: { name: string; url: string; mime: string; size: number }[];\n source_account?: string;\n destination_account?: string; // bank account ID\n}\n\n{\n \"event_type\": \"transaction_create\",\n \"timestamp\": \"2026-02-25T17:14:00.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-0000-00000000\",\n \"id\": \"699ee7b7c5e3548aa0e7c0c7\",\n \"service\": { \"id\": \"6978af08333bf361d6b339ac\", \"type\": \"loan\" },\n \"type\": \"disbursement\",\n \"payment_method\": \"bank_transfer\",\n \"status\": \"pending\",\n \"amount\": { \"amount\": 15000, \"currency\": \"PKR\" },\n \"date\": \"2026-02-25\",\n \"attachments\": [\n {\n \"name\": \"Disbursement Receipt\",\n \"url\": \"https://cb-finance-core-api-prod-bucket.s3.me-central-1.amazonaws.com/...\",\n \"mime\": \"application/pdf\",\n \"size\": 34874\n }\n ],\n \"destination_account\": \"6978561e333bf361d6b19f69\"\n }\n}\n\n\n\n","_postman_id":"b7111b2c-3827-4e96-b033-7791a618ccc4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Transaction Update","item":[],"id":"a89df955-253b-419e-a926-5af8832710fa","description":"Note:
\ntransaction_createis always followed by atransaction_updateevent once the transaction status changes (e.g.pending→completed).
Fired when an existing transaction's status or details change. Always delayed 10 seconds after the originating create event to prevent race conditions.
\n// event_type: \"transaction_update\"\ninterface ITransactionUpdateData extends IEventBaseData {\n id: string;\n service: { id: string; type: \"loan\" };\n payment_method: string;\n type?: \"disbursement\" | \"repayment\" | \"marking\" | \"refund\" | \"adjustment\" | \"fee\" | \"write-off\";\n status?: \"pending\" | \"completed\" | \"failed\" | \"cancelled\";\n amount?: { amount: number; currency: string };\n date?: string;\n description?: string;\n attachments?: { name: string; url: string; mime: string; size: number }[];\n source_account?: string;\n destination_account?: string;\n}\n\n{\n \"event_type\": \"transaction_update\",\n \"timestamp\": \"2026-02-25T17:14:10.000Z\",\n \"event_data\": {\n \"customer_id\": \"6978561e333bf361d6b19f66\",\n \"external_customer_id\": \"00000000-0000-0000-0000-00000000\",\n \"id\": \"699ee7b7c5e3548aa0e7c0c7\",\n \"service\": { \"id\": \"6978af08333bf361d6b339ac\", \"type\": \"loan\" },\n \"type\": \"disbursement\",\n \"payment_method\": \"bank_transfer\",\n \"status\": \"completed\",\n \"amount\": { \"amount\": 15000, \"currency\": \"PKR\" },\n \"date\": \"2026-02-25\",\n \"attachments\": [\n {\n \"name\": \"Disbursement Receipt\",\n \"url\": \"https://cb-finance-core-api-prod-bucket.s3.me-central-1.amazonaws.com/...\",\n \"mime\": \"application/pdf\",\n \"size\": 34874\n }\n ],\n \"destination_account\": \"6978561e333bf361d6b19f69\"\n }\n}\n\nFired when an offer's status or details change, most commonly offer is dispatched to the partner, or when its terminal status changes (e.g. accepted, expired). The event_data is an array, so multiple offers may be delivered in a single event.
// event_type: \"offer_update\"\ninterface IOfferUpdateData {\n id: string;\n values:\n | {\n min: { amount: number; currency: string };\n max: { amount: number; currency: string };\n }\n | undefined;\n status:\n | \"pending\"\n | \"accepted\"\n | \"rejected\"\n | \"expired\"\n | \"suspended\";\n expiry_date: string | undefined; // ISO-8601 timestamp after which the offer is no longer valid\n external_customer_id: string | undefined; // Partner-supplied customer identifier\n}\n\n{\n \"event_type\": \"offer_update\",\n \"timestamp\": \"2026-02-25T17:14:10.000Z\",\n \"event_data\": [\n {\n \"id\": \"699ee7b7c5e3548aa0e7c0c7\",\n \"values\": {\n \"min\": { \"amount\": 5000, \"currency\": \"PKR\" },\n \"max\": { \"amount\": 50000, \"currency\": \"PKR\" }\n },\n \"status\": \"pending\",\n \"expiry_date\": \"2026-03-11T17:14:10.000Z\",\n \"external_customer_id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ]\n}\n\n{\n \"event_type\": \"offer_update\",\n \"timestamp\": \"2026-02-27T09:02:33.000Z\",\n \"event_data\": [\n {\n \"id\": \"699ee7b7c5e3548aa0e7c0c7\",\n \"values\": {\n \"min\": { \"amount\": 5000, \"currency\": \"PKR\" },\n \"max\": { \"amount\": 50000, \"currency\": \"PKR\" }\n },\n \"status\": \"accepted\",\n \"expiry_date\": \"2026-03-11T17:14:10.000Z\",\n \"external_customer_id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ]\n}\n\n{\n \"event_type\": \"offer_update\",\n \"timestamp\": \"2026-02-25T17:14:10.000Z\",\n \"event_data\": [\n {\n \"id\": \"699ee7b7c5e3548aa0e7c0c7\",\n \"values\": {\n \"min\": { \"amount\": 5000, \"currency\": \"PKR\" },\n \"max\": { \"amount\": 50000, \"currency\": \"PKR\" }\n },\n \"status\": \"pending\",\n \"expiry_date\": \"2026-03-11T17:14:10.000Z\",\n \"external_customer_id\": \"00000000-0000-0000-0000-000000000001\"\n },\n {\n \"id\": \"699ee7b7c5e3548aa0e7c0c8\",\n \"values\": {\n \"min\": { \"amount\": 10000, \"currency\": \"PKR\" },\n \"max\": { \"amount\": 75000, \"currency\": \"PKR\" }\n },\n \"status\": \"pending\",\n \"expiry_date\": \"2026-03-11T17:14:10.000Z\",\n \"external_customer_id\": \"00000000-0000-0000-0000-000000000002\"\n }\n ]\n}\n\nDetailed payload schemas and examples for each v2 webhook event type.
\nRead order (customer events): General Event Payload → Customer Update → Compliance Update → Risk Update → Customer Product Update → Bank Account Update → Reference Values.
\nAgreement, Service, Transaction, and Offer pages follow after.
\n","_postman_id":"6e367ce5-c709-41b5-8b21-83abab78d9ea","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}}],"id":"90217eb5-a21e-4c19-a3a0-a2db943d8687","description":"Webhooks are used to communicate to partners about process updates when key events occur — customer compliance changes, loan state transitions, transaction updates, agreement signings, and offer updates.
\nThe broker initiates all webhook calls. Your role is to:
\nExpose an auth URL that returns a JWT token
\nExpose webhook endpoint URLs (one per event type, or a shared URL)
\nReturn 2xx on receipt — the broker retries failed deliveries
See Setting up Webhook Auth for full setup instructions, and Webhook Payloads for detailed payload schemas with real examples.
\n","_postman_id":"90217eb5-a21e-4c19-a3a0-a2db943d8687","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Types","item":[{"name":"Compliance reason codes (entity-level)","id":"cd217711-e8e6-e92d-2137-40ee2be874e8","request":{"method":"GET","header":[],"url":"","description":"Entity-level codes used when a compliance (business or owner) is rejected.
\nCan reapply? See the column below. When it is Yes, the customer can fix and try again. When it is No, do not keep resubmitting the same application. — means not specified.
\nFor requirement-level codes, see Compliance reason codes (requirement-level).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"cd217711-e8e6-e92d-2137-40ee2be874e8"},{"name":"Compliance reason codes (requirement-level)","id":"bf4c4ec8-7013-0a52-8bc4-70c56ff7361b","request":{"method":"GET","header":[],"url":"","description":"Requirement-level codes used when a single requirement (document or text field) is rejected.
\nCan reapply? Yes for all of these — fix that document/field and resubmit with Update Compliance.
\nFor entity-level codes, see Compliance reason codes (entity-level).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bf4c4ec8-7013-0a52-8bc4-70c56ff7361b"}],"id":"54057695-c9e5-4ca2-9e13-1ecccf771022","description":"Shared values used across Embedded Finance APIs, sandbox, and webhooks.
\nOpen a type below for the full list. Other docs link here instead of duplicating tables.
\n","_postman_id":"54057695-c9e5-4ca2-9e13-1ecccf771022","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EF API Auth Token}}"}]},"isInherited":true,"source":{"_postman_id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","id":"1fce6ba2-2c4a-4b18-838d-c76eddb40a79","name":"Embedded Finance APIs","type":"collection"}}},{"name":"Sandbox APIs","item":[{"name":"Reference Values","item":[],"id":"22795423-1a7a-b76a-16b7-91e587766042","description":"Used as overallReasonCode on Process Compliances.
Used as fields[].reasonCode on Process Compliances.
POST /v2/external/demand/sandbox/process-compliance
Approve or reject compliance for one or more entities (business and/or owners).
\n{\n \"compliances\": [\n {\n \"entityId\": \"6978561e333bf361d6b19f66\",\n \"status\": \"approved\"\n }\n ]\n}\nfieldsWhen status is rejected, fields is required (at least one entry).
Each entry can be:
\nname + optional reasonCode { \"name\": \"<string>\", \"reasonCode\": \"invalid\" }{\n \"compliances\": [\n {\n \"entityId\": \"6978561e333bf361d6b19f66\",\n \"status\": \"rejected\",\n \"reason\": \"Documents unclear\",\n \"overallReasonCode\": \"declined\",\n \"fields\": [\n { \"name\": \"cnic_front\", \"reasonCode\": \"unreadable\" },\n \"cnic_back\"\n ]\n }\n ]\n}\nIn this example:
\ncnic_front is rejected with unreadable cnic_back is rejected with invalid (default for string-only entries)200 — { \"message\": \"Compliance updated successfully\" }
POST /v2/external/demand/sandbox/process-agreement
Simulate signing a finance agreement.
\n?businessEntityId=){\n \"productId\": \"67c6a9f1e4430552\",\n \"markup\": 8,\n \"creditLimit\": 50000,\n \"files\": []\n}\n?loanId=)?businessEntityId=): typically after compliance and risk are approved, when the product requires a customer agreement. ?loanId=): after the loan is approved, when the product requires a loan agreement (before disburse).201 — agreement created / signed successfully (exact message from API).
Customer-level (product) agreement
\n","type":"text/plain"},"key":"businessEntityId","value":"6868ea1581b58d8c0be1d43a"},{"disabled":true,"description":{"content":"Loan-level agreement — enable instead of businessEntityId when needed
\n","type":"text/plain"},"key":"loanId","value":""}],"variable":[]}},"response":[{"id":"e9bb5fa6-3f28-46a9-a872-01ddd1cc8dc0","name":"Success Response","originalRequest":{"header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Agreement signed successfully\"\n}"},{"id":"7b4a617a-064e-4e48-99f5-80941117d479","name":"Error - Risk Not Processed","originalRequest":{"header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Risk not processed\"\n }\n ]\n}"}],"_postman_id":"d2b6d8a2-01e6-4704-9a45-7a6db441eaa8"},{"name":"[SANDBOX] Process Risk","id":"f785bfb9-ce8e-4831-8e4e-e93b2f33e83f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"productId\": \"680a10f9ffccf6faf0d002da\",\n \"status\": \"approved\",\n \"creditLimit\": 60000,\n \"creditRating\": \"A\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/sandbox/process-risk?businessEntityId=6868ea1581b58d8c0be1d43a","description":"POST /v2/external/demand/sandbox/process-risk?businessEntityId=<id>
Set risk status for a customer on a product.
\n{\n \"productId\": \"67c6a9f1e4430552\",\n \"status\": \"approved\",\n \"creditLimit\": 50000,\n \"creditRating\": \"A\",\n \"reason\": \"Looks good\"\n}\n200 with a success message.
Business customer ID
\n","type":"text/plain"},"key":"businessEntityId","value":"6868ea1581b58d8c0be1d43a"}],"variable":[]}},"response":[{"id":"a2cb6cc7-a30b-4f81-b35d-8a77499795ea","name":"Success Response","originalRequest":{"header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Risk processed successfully\"\n}"},{"id":"993ab44b-4aba-4ba9-8108-384f8441817f","name":"Error - Product Not Found","originalRequest":{"header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Entity product not found\"\n }\n ]\n}"}],"_postman_id":"f785bfb9-ce8e-4831-8e4e-e93b2f33e83f"},{"name":"[SANDBOX] Process Loan","id":"4d14046f-b7de-43a3-86e6-9b986bc1e634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"approved\",\n \"reason\": \"Auto-approved in sandbox\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/sandbox/process-loan/:loanId","description":"POST /v2/external/demand/sandbox/process-loan/:loanId
Move a loan to approved, disbursed, or rejected.
{\n \"status\": \"approved\",\n \"reason\": \"Auto-approved in sandbox\"\n}\nPOST /v2/external/demand/sandbox/:loanId/transactions/:transactionId/process-transaction
Update a loan transaction’s status.
\n{\n \"status\": \"completed\",\n \"reason\": \"Cleared in sandbox\"\n}\nThese APIs let you simulate broker back-office steps while testing your integration (compliance decisions, risk, agreements, loans, transactions).
\nThey use the same auth as other Embedded Finance APIs.
\nFilter by offer ID.
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"Filter by entity ID.
\n","type":"text/plain"},"key":"entityId","value":""},{"disabled":true,"description":{"content":"Filter by your external customer ID.
\n","type":"text/plain"},"key":"externalCustomerId","value":""},{"disabled":true,"description":{"content":"Filter by customer email.
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"Filter by customer phone number.
\n","type":"text/plain"},"key":"phoneNumber","value":""},{"disabled":true,"description":{"content":"Filter by product ID.
\n","type":"text/plain"},"key":"productId","value":""},{"disabled":true,"description":{"content":"Filter by offer status (OfferStatus enum).
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Filter by offer type (OfferType enum).
\n","type":"text/plain"},"key":"type","value":""}],"variable":[]}},"response":[],"_postman_id":"8cf5b761-2d19-42e1-b406-e13c694955d6"},{"name":"Create Offer","id":"7aabce31-4b44-4e33-8bbb-c839e09f5222","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"onboarding\",\n \"externalCustomerId\": \"your-customer-id\",\n \"productId\": \"67c6a9f1e443055234920000\",\n \"email\": \"customer@example.com\",\n \"phoneNumber\": \"+923001234567\",\n \"inputs\": {\n \"creditLimit\": 50000,\n \"tenure\": 12\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url_core}}/v2/external/demand/offers","description":"Creates a new financing offer for a customer. Offers can be created before the customer has an active product and can be used for pre-approval flows.
\ntype: OfferType (required) — Offer type (e.g. onboarding).
inputs: object (required) — Offer-specific inputs.
externalCustomerId: string (optional) — Your system's customer reference ID.
email: string (optional) — Customer email (used to resolve entity).
phoneNumber: string (optional) — Customer phone number.
productId: string (optional) — Associated product ID.
Updates the status of a pending offer — typically used when a customer accepts or rejects a pre-approved financing offer.
\nofferId: string (required) — The offer ID.status.current: string (required) — Must be accepted or rejected.
status.comment: string (optional) — Reason or note.
pending → accepted | rejected
Manage pre-approved and partner-created financing offers. The Offers API enables pre-approval flows where partners can proactively extend financing offers to eligible customers — independently of the standard loan application process.
\nOffer lifecycle: pending → accepted | rejected | expired