curl --request POST \
--url https://api.sandbox.lead.bank/v0/applications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"client_application_id": "APP-2024-001",
"status": "approved",
"entities": {
"account_holder_type": "commercial",
"account_holders": [
"entity_123456789"
],
"authorized_signers": [
"entity_987654321"
]
},
"details": {
"product_name": "Growth Business Credit Line",
"credit": {
"is_secured": true,
"is_mla": false,
"currency": "USD",
"underwriting_grade": "99",
"limit": 5000000,
"max_limit": 10000000,
"report": {
"score": 780,
"pulled_at": "2025-11-15T09:30:00Z",
"source": "experian"
}
}
},
"decision": {
"decided_at": "2025-11-17T14:00:00Z",
"reason": "Approved based on strong cash flow and collateral.",
"exception_approval_reason": "Manual override of automated debt-to-income threshold."
},
"documents": [
{
"document_id": "doc_consent_001",
"type": "credit_pull_consent",
"consented_at": "2025-11-15T09:00:00Z"
}
]
}
'{
"id": "application_xyz123",
"client_application_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "approved",
"entities": {
"account_holder_type": "commercial",
"account_holders": [
"entity_xyz123"
],
"authorized_signers": [
"entity_xyz123"
]
},
"details": {
"product_name": "Growth Business Credit Line",
"credit": {
"is_secured": true,
"is_mla": true,
"currency": "AED",
"underwriting_grade": "99",
"limit": 5000000,
"max_limit": 10000000,
"report": {
"score": 575,
"non_score_value": "unestablished",
"pulled_at": "2023-11-07T05:31:56Z",
"source": "equifax"
}
},
"adverse_action_notice": {
"delivered_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"delivery_method": "email"
}
},
"decision": {
"decided_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"exception_approval_reason": "<string>"
},
"documents": [
{
"document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
"type": "aan",
"displayed_at": "2023-11-07T05:31:56Z",
"consented_at": "2023-11-07T05:31:56Z",
"version": "v1"
}
],
"metadata": {}
}Create an Application
Creates a new credit application in terminal status.
Business Rules
- Applications MUST be created in terminal status (approved, declined, canceled)
- Maximum 20 entities per relationship type
- Credit fields required for all applications
- Adverse action notice required for declined applications
- Authorized signers required for commercial account holders
- client_application_id cannot start with reserved prefix ‘application_’
- credit.limit cannot exceed credit.max_limit
Idempotency
The Idempotency-Key header is required. Reusing a key with a different request body will return a 422 error.
curl --request POST \
--url https://api.sandbox.lead.bank/v0/applications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"client_application_id": "APP-2024-001",
"status": "approved",
"entities": {
"account_holder_type": "commercial",
"account_holders": [
"entity_123456789"
],
"authorized_signers": [
"entity_987654321"
]
},
"details": {
"product_name": "Growth Business Credit Line",
"credit": {
"is_secured": true,
"is_mla": false,
"currency": "USD",
"underwriting_grade": "99",
"limit": 5000000,
"max_limit": 10000000,
"report": {
"score": 780,
"pulled_at": "2025-11-15T09:30:00Z",
"source": "experian"
}
}
},
"decision": {
"decided_at": "2025-11-17T14:00:00Z",
"reason": "Approved based on strong cash flow and collateral.",
"exception_approval_reason": "Manual override of automated debt-to-income threshold."
},
"documents": [
{
"document_id": "doc_consent_001",
"type": "credit_pull_consent",
"consented_at": "2025-11-15T09:00:00Z"
}
]
}
'{
"id": "application_xyz123",
"client_application_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "approved",
"entities": {
"account_holder_type": "commercial",
"account_holders": [
"entity_xyz123"
],
"authorized_signers": [
"entity_xyz123"
]
},
"details": {
"product_name": "Growth Business Credit Line",
"credit": {
"is_secured": true,
"is_mla": true,
"currency": "AED",
"underwriting_grade": "99",
"limit": 5000000,
"max_limit": 10000000,
"report": {
"score": 575,
"non_score_value": "unestablished",
"pulled_at": "2023-11-07T05:31:56Z",
"source": "equifax"
}
},
"adverse_action_notice": {
"delivered_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"delivery_method": "email"
}
},
"decision": {
"decided_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"exception_approval_reason": "<string>"
},
"documents": [
{
"document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
"type": "aan",
"displayed_at": "2023-11-07T05:31:56Z",
"consented_at": "2023-11-07T05:31:56Z",
"version": "v1"
}
],
"metadata": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique key to ensure idempotent requests
255Body
Request body for creating a new application in terminal status
Terminal state of the application. Possible values: approved, declined, canceled.
approved, declined, canceled Entity relationships for the application. Maximum 20 entities per relationship type. Authorized signers required for commercial account holders.
Show child attributes
Show child attributes
Details for creating an application
Show child attributes
Show child attributes
Decision-related information for the application
Show child attributes
Show child attributes
Documents associated with the application
Document reference for creating applications and accounts.
One of displayed_at or consented_at is required depending on document type:
displayed_at: Required for aan, loan_agreement, loc_agreement, truth_in_lending_document, ach_authorization, notice_of_incompleteness, credit_score_notice, offer_summary, personal_guarantee, consumer_credit_auth, partner_privacy_policy, lead_privacy_policy, terms_of_use, fcra_notice, tcpa_consent, patriot_act_notice, mla_notice, pre_approval_terms, eft_authorization, prohibited_industry_certification, decision_maker_document, bo_certification, missed_payments_policy, lead_funds_transfer_agreementconsented_at: Required for esign_agreement, credit_pull_consent, consent_to_link_account, consent_to_link_hsa, negative_option_consent
- Disclosure
- Consent
Show child attributes
Show child attributes
Arbitrary metadata associated with the application
Show child attributes
Show child attributes
Response
Application created successfully.
An application object representing a credit application
Unique identifier for the application. Prefixed with application_.
^application_\w+$"application_xyz123"
Client-provided identifier for the application. Optional: present only for applications created via file upload, and omitted for applications created through the API, which are identified solely by their server-generated ID.
Lead server-generated ISO 8601 timestamp when the application was created.
Lead server-generated ISO 8601 timestamp when the application was last updated.
Terminal state of the application. Possible values: approved, declined, canceled.
approved, declined, canceled Entity relationships associated with the application (response only)
Show child attributes
Show child attributes
Application details (response, all properties optional)
Show child attributes
Show child attributes
Decision-related information (response, all properties optional)
Show child attributes
Show child attributes
Documents associated with the application
Show child attributes
Show child attributes
Arbitrary metadata associated with the application
Show child attributes
Show child attributes
Was this page helpful?