Identity API

BankAccountFullResponse

object

Bank account resource returned by the single-resource GET endpoint. The number field contains the full account number. In all other endpoints number is masked to ****<last4>.

idstring(uuid)requiredread-only

The unique identifier for the bank account.

Example:550e8400-e29b-41d4-a716-446655440000

typestringrequired

The type of bank account

Allowed values:SAVINGSCHECKING

Example:CHECKING

holderNamestringrequired

Name of the account holder.

Example:Jane Doe

numberstringrequiredread-only

Full bank account number.

Example:1234567890

routingNumberstringrequiredread-only

Bank routing number.

Example:021000021

bankNamestringrequired

Name of the bank.

Example:Chase Bank

nicknamestring

Optional nickname for the bank account.

Example:Main

primaryAccountbooleanrequired

Indicates if this is the primary bank account.

Example:true

createdAtstring(date-time)requiredread-only

RFC3339 UTC timestamp when the bank account was created.

Example:2024-01-15T10:30:00Z

updatedAtstring(date-time)read-only

RFC3339 UTC timestamp when the bank account was last updated.

Example:2024-01-15T14:45:00Z

Example

V2FieldError

object
paramstringrequired

The request field that failed validation

Example:email

messagestringrequired

Human-readable description of the failure

Example:must not be blank

Example

V2Error

object
messagestringrequired

Human-readable error summary. Do not parse — use “code” for branching.

Example:Validation failed

detailsarray[object]required

Per-field validation errors. Empty for all non-400 responses.

Show Child Parameters
codestringrequired

Stable machine-readable error code.

Allowed values:validation_failedunauthorizedunauthorized_scoperesource_not_foundconflictunprocessableunsupported_media_typerate_limitedinternal

Example:validation_failed

Example

UpdateBankAccountRequest

object
typestringrequired

The type of bank account

Allowed values:SAVINGSCHECKING

Example:CHECKING

holderNamestringrequired

Name of the account holder

Example:Jane Doe

numberstringrequired

Bank account number (4-17 digits)

Match pattern:^\d{4,17}$

>= 4 characters<= 17 characters

Example:9876543210

routingNumberstringrequired

Bank routing number (exactly 9 digits)

Match pattern:^\d{9}$

>= 9 characters<= 9 characters

Example:021000021

bankNamestringrequired

Name of the bank

Example:Wells Fargo

nicknamestring

Optional nickname for the bank account

Example:Secondary

primaryAccountboolean

Whether this should become the owner’s primary bank account. Setting true demotes any existing primary for the same owner. An existing primary account cannot be demoted directly by omitting or setting this to false — set another account as primary instead. null is treated the same as omitted.

Default:false

Example

BankAccountResponse

object
idstring(uuid)read-only

The unique identifier for the bank account

Example:550e8400-e29b-41d4-a716-446655440000

typestring

The type of bank account

Allowed values:SAVINGSCHECKING

Example:CHECKING

holderNamestring

Name of the account holder

Example:Jane Doe

numberstringread-only

Masked bank account number (last 4 digits visible)

Example:****7890

routingNumberstringread-only

Bank routing number

Example:021000021

bankNamestring

Name of the bank

Example:Chase Bank

nicknamestring

Optional nickname for the bank account

Example:Main

primaryAccountboolean

Indicates if this is the primary bank account

Example:true

createdAtstring(date-time)read-only

Timestamp when the bank account was created

Example:2024-01-15T10:30:00Z

updatedAtstring(date-time)read-only

Timestamp when the bank account was last updated

Example:2024-01-15T14:45:00Z

Example