LElead
Compliance

Retrieve an application by client application ID

Changed on

Retrieves an application by the client_application_id you assigned, supplied as a query parameter: GET /v0/applications?client_application_id=.... This is the filtered form of the applications collection and is distinct from GET /v0/applications/{id}, which takes the server-generated Application ID (application_*). The response body is identical to GET /v0/applications/{id}.

get/v0/applications

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v0/applications
  • Auth
    HTTP bearer

Query parameters

client_application_idstring required

The client_application_id assigned to the application.

Response

Application object retrieved successfully.

idstring

Unique identifier for the application. Prefixed with application_.

client_application_idstring

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.

created_atstring date-time

Lead server-generated ISO 8601 timestamp when the application was created.

updated_atstring date-time

Lead server-generated ISO 8601 timestamp when the application was last updated.

status'approved' | 'declined' | 'canceled'

Terminal state of the application. Possible values: approved, declined, canceled.

metadataobject

Arbitrary metadata associated with the application

Example response

{
  "id": "application_xyz123",
  "entities": {
    "account_holder_type": "commercial",
    "account_holders": [
      "entity_xyz123"
    ],
    "authorized_signers": [
      "entity_xyz123"
    ]
  },
  "details": {
    "product_name": "Growth Business Credit Line",
    "credit": {
      "underwriting_grade": "99",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}

Changes