Sign in
latestOpenAPI 3.0.02026-08-15122834.2 KB

fea4b2a0d73d

Businesses

Get business prequalified status

get/api/platform/v1/prequalified-businesses

Query parameters

platformBusinessIdstring

String or number representing the id of the business

Response

Array containing all the businesses details or Array with the business that was selected successfully

product'INVOICE_FINANCING' | 'TERM_LOAN' | 'MCA' | 'LINE_OF_CREDIT' | 'INTEGRATED_MCA' | 'ACCOUNTS_PAYABLE_FINANCING' nullable required

The product that the business is prequalified for. This will be null if isPrequalified is false. Values can be INVOICE_FINANCING, TERM_LOAN, MCA, LINE_OF_CREDIT, INTEGRATED_MCA.

platformIdstring required

The UUID representing your platform in Kanmon.

businessIdstring nullable required

The UUID representing the business in Kanmon.

platformBusinessIdstring required

Your platform’s unique ID for the business.

isPrequalifiedboolean required

Whether or not the business has been prequalified.

prequalifiedAmountCentsnumber nullable required

Number describing the prequalification amount of the business in cents.

createdAtstring required

Creation UTC ISO 8601 timestamp of the prequalification.

updatedAtstring required

Last updated UTC ISO 8601 timestamp of the prequalification.

Example response

[
  {
    "product": "TERM_LOAN",
    "platformId": "2b5d0f14-9b73-4f44-a82a-2182a9ff77bb",
    "businessId": "2b5d0f14-9b73-4f44-a82a-2182a9ff77bb",
    "platformBusinessId": "2b5d0f14-9b73-4f44-a82a-2182a9ff77bb",
    "prequalifiedAmountCents": 1000000,
    "createdAt": "2022-06-01T03:57:26.115Z",
    "updatedAt": "2022-06-01T03:57:26.115Z"
  }
]