UpdateBankAccountRequest
objectThe type of bank account
Allowed values:SAVINGSCHECKING
Example:CHECKING
Name of the account holder
Example:Jane Doe
Bank account number (4-17 digits)
Match pattern:^\d{4,17}$
>= 4 characters<= 17 characters
Example:9876543210
Bank routing number (exactly 9 digits)
Match pattern:^\d{9}$
>= 9 characters<= 9 characters
Example:021000021
Name of the bank
Example:Wells Fargo
Optional nickname for the bank account
Example:Secondary
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
BankAccountResponse
objectThe unique identifier for the bank account
Example:550e8400-e29b-41d4-a716-446655440000
The type of bank account
Allowed values:SAVINGSCHECKING
Example:CHECKING
Name of the account holder
Example:Jane Doe
Masked bank account number (last 4 digits visible)
Example:****7890
Bank routing number
Example:021000021
Name of the bank
Example:Chase Bank
Optional nickname for the bank account
Example:Main
Indicates if this is the primary bank account
Example:true
Timestamp when the bank account was created
Example:2024-01-15T10:30:00Z
Timestamp when the bank account was last updated
Example:2024-01-15T14:45:00Z
BankAccountListItemV2
objectPer-row shape returned by V2 bank-account list endpoints. Carries owner context (personId or firmId, plus the producer NPN where known) for reconciliation use cases. The account number is always masked here; the unmasked value is reachable only via GET /v2/bank-accounts/{id} behind an elevated scope.
Bank account identifier.
Example:550e8400-e29b-41d4-a716-446655440000
Owning person id. Set when this is a person-owned bank account; null for firm-owned.
Owning firm id. Set when this is a firm-owned bank account; null for person-owned.
National Producer Number of the owning person or firm, when known.
Example:1234567
The type of bank account
Allowed values:SAVINGSCHECKING
Example:CHECKING
Name of the bank.
Example:Chase Bank
Account number masked to ****.
Example:****7890
Indicates if this is the owner’s primary bank account.
Example:true
RFC3339 UTC timestamp of the bank account’s last modification.
Example:2026-05-21T14:00:00Z
Page
objectPage metadata for a token-based list response.
Number of items actually returned in this response — equal to items.length. On an empty result this is 0. This is NOT a copy of the request’s page_size hint; clients holding the hint already know what they asked for.
>= 0
Example:25
Opaque token to request the next page. null when this is the last page. Pass back as the page_token query parameter to resume.
Example:eyJ2IjoxLCJrIjp7InVwZGF0ZWRBdCI6IjIwMjYtMDUtMTlUMTI6MDA6MDBaIiwiaWQiOiIwMUhYWVoifX0
CreateBankAccountRequest
objectThe type of bank account
Allowed values:SAVINGSCHECKING
Example:CHECKING
Name of the account holder
Example:Jane Doe
Bank account number (4-17 characters)
>= 4 characters<= 17 characters
Example:1234567890
Bank routing number (exactly 9 digits)
>= 9 characters<= 9 characters
Example:021000021
Name of the bank
Example:Chase Bank
Optional nickname for the bank account
Example:Main
Whether this should become the owner’s primary bank account. Setting true demotes any existing primary for the same owner. Defaults to false (the owner’s first bank account always becomes primary regardless of this value). null is treated the same as omitted.
Default:false