Skip to main content
PATCH

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
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.

Maximum string length: 255

Path Parameters

user_account_id
string
required

User Account ID The ID of the User Account object.

Pattern: ^user_account_\w+$
Example:

"user_account_xyz123"

Body

application/json

Request body for updating an existing user account

application_id
string

Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

requested_features
enum<string>[]

The features the user account should be granted. The feature must be pre-approved for your program. Learn more about features here.

A feature of the user account

Available options:
deposit,
credit_with_underwriting,
credit_without_underwriting
product_name
string

Partner's name for their product

balance_sheet_model
enum<string>

How Lead carries the user account's credit on its balance sheet. Accepted only when the PATCH adds a credit feature through requested_features, and required in that case. Cannot be changed once set. Learn more about balance sheet model here.

Available options:
held_for_investment,
held_for_sale
details
object

Additional details for the user account

metadata
object

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

documents
object[]

Compliance documents linked to the user account. Each entry references a file uploaded with the Files API. A supplied array replaces the whole array: to add a document, send every existing entry plus the new one.

Response

User account updated successfully.

A user account object

id
string
required

The ID of the User Account object.

Pattern: ^user_account_\w+$
Example:

"user_account_xyz123"

status
enum<string>
required

Current state of the user account

Available options:
active,
inactive,
closed
status_reason
enum<string>
required

Machine-readable reason for the current status

Available options:
client_closed,
entity_closed,
frozen,
dormant,
active,
paid_off,
charged_off,
canceled,
other
features
enum<string>[]
required

Features granted to the user account.

A feature of the user account

Available options:
deposit,
credit_with_underwriting,
credit_without_underwriting
entities
object
required
read-only

Entity relationships associated with the user account (response only)

details
object
required
read-only

Core details of the user account

product_name
string
required

Partner's name for their product

documents
object[]
required

Compliance documents linked to the user account. Each entry references a file uploaded with the Files API.

metadata
object
required

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

created_at
string<date-time>
required
read-only

Creation timestamp

updated_at
string<date-time>
required
read-only

Last update timestamp

application_id
string

Unique identifier for the application. Prefixed with application_.

Pattern: ^application_\w+$
Example:

"application_xyz123"

legacy_documents
object[]
read-only

Document entries created on v0 User Accounts, returned exactly as sent. Read only: ignored if included on a POST or PATCH.

client_account_id
string
read-only

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
enum<string> | null

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

Available options:
held_for_investment,
held_for_sale
product_config_id
string | null

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

Pattern: ^product_config_\w+$
Example:

"product_config_xyz123"

closed_at
string<date-time> | null
read-only

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