Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lead.bank/llms.txt

Use this file to discover all available pages before exploring further.

Lifecycle

Diagram of the statuses and lifecycle for accounts.

Statuses

StatusDescriptionNotes
unassignedAn Account Number is created but has not been assigned to a valid customer through either entity_id or client_customer_id.Cannot send or receive any transfers.
activeAn Account Number is assigned or re-activated with a valid customer.Can receive and send (if enabled) transfers.
inactiveAn active Account Number being deactivated by client, or deactivated by Lead due to internal policies.Cannot receive or send any transfers.
canceledThis is a terminal status and can not be re-activated. Canceled Account Number will not be recycled for future usage.Cannot send or receive any transfers.