LElead
User Account

Close a user account

Changed on

Close a User Account. All balances must be zero before a User Account can be closed. If a User Account can reopen in the normal course of business, deactivate it instead. To undo a mistaken closure, see Correcting a mistaken closure.

post/v2/user_accounts/{user_account_id}/close

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/user_accounts/{user_account_id}/close
  • Auth
    HTTP bearer

Path parameters

user_account_idstring required

The ID of the User Account object.

Example:user_account_xyz123

User Account ID

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_reason'entity_closed' | 'client_closed' | 'paid_off' | 'charged_off' | 'canceled' required

Valid reasons for closing a user account

Response

User account closed successfully.

idstring required

The ID of the User Account object.

status'active' | 'inactive' | 'closed' required

Current state of the user account

status_reason'client_closed' | 'entity_closed' | 'frozen' | 'dormant' | 'active' | 'paid_off' | 'charged_off' | 'canceled' | 'other' required

Machine-readable reason for the current status

application_idstring

Unique identifier for the application. Prefixed with application_.

featuresUserAccountFeatureV2[] required

Features granted to the user account.

product_namestring required

Partner's name for their product

client_account_idstring

The identifier you assigned in an Account file. Present only on user accounts created through file upload. Omitted on user accounts created through the API, which are identified only by id.

balance_sheet_model'held_for_investment' | 'held_for_sale'

How Lead carries the user account's credit on its balance sheet.

product_config_idstring nullable

The id of the product configuration the user account was created under. null only on user accounts created before product config ids existed.

metadataMetadata required

A set of key-value pairs that can be used to store additional information related to this object.

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

closed_atstring date-time nullable

Timestamp when the user account was closed. Updated by /close endpoint.

Example response

{
  "id": "user_account_xyz123",
  "application_id": "application_xyz123",
  "details": {
    "underwriting": {
      "currency_code": "USD"
    }
  },
  "documents": [
    {
      "file_id": "file_7RwQ2mK9pL4xT1vN8jS5",
      "timestamp": "2026-09-14T14:20:11Z",
      "version": "v2"
    }
  ],
  "legacy_documents": [
    {
      "document_id": "loan_agreement_01_2026.pdf",
      "version": "v1"
    }
  ],
  "product_config_id": "product_config_xyz123"
}

Changes