User Account Statuses

You manage user account status. New user accounts start in active, and you move them with the activate, deactivate, and close endpoints. This page explains what each status means, which reason each transition takes, and what to do if you closed a user account by mistake.

Lifecycle

The dashed line is error correction only. See Correcting a mistaken closure below.

Statuses

Status	Description	Notes
`active`	The user account is open and operating.	Every new user account starts here.
`inactive`	You have paused the user account, and you expect it may reopen.	Use this for dormant or frozen user accounts. You can still update the user account with `PATCH`.
`closed`	The user account is permanently closed.	You cannot update a closed user account. Lead sets `closed_at`. The user account stays readable.

Transitions

POST requires an Idempotency-Key header of up to 255 characters. See Idempotency.

Endpoint	From	To	Request body
`POST /v2/user_accounts/{id}/deactivate`	`active`	`inactive`	`status_reason` required
`POST /v2/user_accounts/{id}/activate`	`inactive`, or `closed` to correct a mistake	`active`	None
`POST /v2/user_accounts/{id}/close`	`active` or `inactive`	`closed`	`status_reason` required

You cannot change status with PATCH. If you send a status field, Lead ignores it.

Status reasons

status_reason explains the current status. Active user accounts return active. The deactivate and close endpoints each accept their own set of reasons. Deactivate

Reason	Use when
`dormant`	The account holder has not used the user account for the inactivity period your program defines, so you paused it. Use this when you expect the user account to return to `active` once the account holder uses it again.
`frozen`	You restricted the user account so it cannot be used while you investigate or resolve an issue. Examples include suspected fraud, a legal hold such as a levy or garnishment, and a compliance review. Reactivate the user account if the issue is resolved, or close it if it is not.
`other`	You paused the user account for a reason that is neither inactivity nor a restriction. Use this only when `dormant` and `frozen` do not fit.

Close

Reason	Use when
`client_closed`	You closed the user account. Requires `details.adverse_action_notice` on the user account before or with the close request.
`entity_closed`	The account holder asked to close the user account.
`paid_off`	User accounts with a credit feature only. The account holder repaid the full outstanding balance, and the user account was closed with no further credit available. Use this for loans repaid at maturity or early, and for credit lines closed after payoff.
`charged_off`	User accounts with a credit feature only. The outstanding balance was written off as a loss under your charge-off policy, typically after a period of delinquency, and the user account was closed. The account holder may still owe the balance.
`canceled`	The user account was canceled before it was used.

Correcting a mistaken closure

If you closed a user account by mistake, call POST /v2/user_accounts/{id}/activate on the closed user account. No request body is needed. The user account returns to active, and status_reason is set to active.

Use this only to fix a reporting error. If a user account can reopen in the normal course of business, deactivate it instead of closing it.

Relationship to user credit and deposit balances

A user account’s status is separate from the status of the user credit balances and user deposit balances (coming soon) beneath it. Closing or deactivating a user account does not change their status, and open user credit or deposit balances do not block a close. Close or deactivate the user account when the customer relationship changes, and manage each user credit balance and user deposit balance separately.

Products

Banking Infrastructure

Customers & Accounts

Balances and Transactions

Lending & Receivables

Payment Rails

Lifecycle

Statuses

Transitions

Status reasons

Correcting a mistaken closure

Relationship to user credit and deposit balances

​Lifecycle

​Statuses

​Transitions

​Status reasons

​Correcting a mistaken closure

​Relationship to user credit and deposit balances

​Related

Lifecycle

Statuses

Transitions

Status reasons

Correcting a mistaken closure

Relationship to user credit and deposit balances

Related