Skip to main content
GET
/
v0
/
applications
/
{id}
Retrieve an application
curl --request GET \
  --url https://api.sandbox.lead.bank/v0/applications/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "application_xyz123",
  "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,
        "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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Server-generated ID (application_*) application ID Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

Response

Application object retrieved successfully.

An application object representing a credit application

id
string

Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

created_at
string<date-time>

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

updated_at
string<date-time>

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

status
enum<string>

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

Available options:
approved,
declined,
canceled
entities
object

Entity relationships associated with the application (response only)

details
object

Application details (response, all properties optional)

decision
object

Decision-related information (response, all properties optional)

documents
object[]

Documents associated with the application

metadata
object

Arbitrary metadata associated with the application