For all optional fields where you do not plan to pass through data, please include the header and an empty value.
IDs & Details
| Field | Description | Required | Data Type |
|---|---|---|---|
| client_application_id | A unique ID for the application generated by your system. Cannot start with application_ (reserved for Lead-generated application IDs). | Required | string |
| account_holder_type | Type of account holder. | Required | enum:consumercommercial |
| account_holders | IDs of any account holders and co-holders. | Required | JSON: <client_customer_id or entity_id> |
| authorized_signers | A list of authorized signers. These are persons who can access, control and change products and services on the account. | Required with min_size >= 1 if account_holder_type = commercial and status = approved | An array of authorized signer IDs JSON: <client_customer_id or entity_id> |
| currency | Application currency code. 3 letter code, e.g. USD | Required | ISO4217 |
| client_product_name | Name of the product offered by the client | Required | string |
| is_secured | Indicate if the product is a secured credit or secured deposit product - e.g. will have collateral attached. | Required | boolean |
Status & Timing
| Field | Description | Required | Data Type |
|---|---|---|---|
| created_at | Datetime application initiated. | Required | datetime ISO8601 |
| submitted_at | Datetime the application was submitted. | Required | datetime ISO8601 |
| status | See Application Statuses | Required | enum:submittedunder_reviewapproveddeclinedcanceled |
| decided_at | Datetime a final decision (approved, declined, canceled) was made on the application. | Required if status = approved, declined, canceled | datetime ISO8601 |
| decision_reason | The reason for the final status of approved, declined, canceled | Required if status = approved, declined, canceled | String |
& Exception Approval
| Field | Description | Required | Data Type |
|---|---|---|---|
| aan_delivered_at | The datetime the AAN was delivered. | Required if status = declined | datetime ISO8601 |
| aan_reason | Reason an adverse action notice (AAN) was sent to the customer. | Required if status = declined | string |
| aan_delivery_method | AAN delivery method. | Required if status = declined | enum:emailtextother |
| is_exception_approval | true if the application would not have been accepted without some kind of exception, such as a credit limit decision override; false otherwise. | Required | boolean |
| exception_reason | The reason this application was approved as an exception, such as an overridden credit limit decision. | Required if is_exception_approval = true | string |
Compliance
| Field | Description | Required | Data Type |
|---|---|---|---|
| documents | An array of JSON hash of customer-facing documents. The JSON hash should include the name of the document, and client_document_name or document_id that’s been uploaded to Documents folder. This will be defined between the client and Lead bank during setup. | Required | Example ”document_id”: “client_document_123”, “type”:“esign_agreement”,“consented_at”:“2025-12-31T15:38:34.101-06:00”,“version”:“20220202” For documents uploaded via SFTP, please input the full file name as document_id. The suggested naming convention is: <Date>_<ApplicationID>_<FileType>_<Version>.<FileExtension>Note: JSON strings embedded in CSV fields must be enclosed in double quotes, with internal double quotes escaped by doubling them (""). |
Credit Details
| Field | Description | Required | Data Type |
|---|---|---|---|
| is_mla | true if the customer is subject to the Military Lending Act; false otherwise | Required for credit products | boolean |
| underwriting_grade | The grade or score given to the customer based on underwriting. | Required for credit products AND status in (approved, declined) | string |
| credit_limit | The maximum amount the customer can draw. This may be different from the max credit limit the customer has been approved for. | Required for credit products AND status = approved | number currency decimal |
| max_credit_limit | The maximum credit limit the customer has been approved for based on original underwriting and the product. | Required for credit products AND status = approved | number currency decimal |
Credit Bureau Data
| Field | Description | Required | Data Type |
|---|---|---|---|
| credit_pulled_at | The date the credit report is pulled. | Required if your program’s underwriting policy requires credit bureau data on all applications. This will be agreed upon with Lead’s Legal team during implementation. Required if any of credit_score, credit_report_non_score_value, or credit_report_source are present. | datetime ISO8601 |
| credit_score | Credit score given by the credit bureau. Supported range is 300 to 850. Mutually exclusive with credit_report_non_score_value. | Required if your program’s underwriting policy requires credit bureau data on all applications. This will be agreed upon with Lead’s Legal team during implementation Required if credit bureau data is present and credit_report_non_score_value is not provided. | number |
| credit_report_non_score_value | Indicates the state of a credit file when a numeric score is not available. Mutually exclusive with credit_score. | Required if credit bureau data is present and credit_score is not provided. | enum:unestablishedfrozen |
| credit_report_source | The name of the credit bureau. | Required if your program’s underwriting policy requires credit bureau data on all applications. This will be agreed upon with Lead’s Legal team during implementation Required if any of credit_pulled_at, credit_score, or credit_report_non_score_value are present. | enum:equifaxexperiantransunion |