LElead
Application

Update an application

Changed on

Update the product name, details, decision, documents, or metadata on an Application. See Create and update for how PATCH handles each field.

patch/v2/applications/{id}

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/applications/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for the application. Prefixed with application_.

Example:application_xyz123

Application ID, prefixed application_.

Headers

Idempotency-Keystring required

A unique key for this request, up to 255 characters. Retrying with the same key and body returns the original response without applying the update twice. See Idempotency.

Request body

status'approved' | 'declined' | 'canceled' | 'submitted' | 'under_review'

The application's status. Applications created through the API are always approved, declined, or canceled, the statuses POST accepts.

submitted and under_review appear only on applications you reported in an Application file before a decision was made. They are read only: POST does not accept them, and a PATCH that includes status leaves it unchanged.

product_namestring

Your internal product name.

metadataobject

Key-value pairs for your own use.

Example request

{
  "status": "approved",
  "product_name": "Growth Business Credit Line",
  "details": {
    "underwriting": {
      "underwriting_grade": "A2",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "file_id": "file_7RwQ2mK9pL4xT1vN8jS5",
      "timestamp": "2026-09-14T14:20:11Z",
      "version": "v2"
    }
  ]
}

Response

Application updated.

idstring required

Unique identifier for the application. Prefixed with application_.

client_application_idstring

Your ID for applications you reported in an Application file. Lead omits it for applications created through the API.

status'approved' | 'declined' | 'canceled' | 'submitted' | 'under_review' required

The application's status. Applications created through the API are always approved, declined, or canceled, the statuses POST accepts.

submitted and under_review appear only on applications you reported in an Application file before a decision was made. They are read only: POST does not accept them, and a PATCH that includes status leaves it unchanged.

product_namestring required

Your internal product name.

metadataobject

Key-value pairs for your own use.

created_atstring date-time required

When the application was created. RFC 3339, UTC.

updated_atstring date-time required

When the application was last updated. RFC 3339, UTC.

Example response

{
  "id": "application_xyz123",
  "client_application_id": "APP-2024-001",
  "status": "approved",
  "product_name": "Growth Business Credit Line",
  "entities": {
    "account_holder_type": "commercial",
    "account_holders": [
      "entity_xyz123"
    ],
    "authorized_signers": [
      "entity_xyz123"
    ]
  },
  "details": {
    "underwriting": {
      "underwriting_grade": "A2",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "file_id": "file_7RwQ2mK9pL4xT1vN8jS5",
      "timestamp": "2026-09-14T14:20:11Z",
      "version": "v2"
    }
  ],
  "legacy_documents": [
    {
      "document_id": "loan_agreement_01_2026.pdf",
      "version": "v1"
    }
  ],
  "created_at": "2026-05-14T15:59:30Z",
  "updated_at": "2026-05-14T15:59:30Z"
}

Changes