Returns bank accounts belonging to the specified person and visible to the authenticated customer, paginated by opaque continuation token. Account numbers are masked to ****.
Opaque continuation token returned by the previous response’s page.nextToken. Omit on the first request. Format is server-controlled and may change without an API version bump.
Requested number of items in the response. Defaults to 25 when omitted; values outside [1, 250] are rejected with 400 (not clamped). The actual size returned is reflected in page.size and may be smaller (last page or empty result).
Default:25
>= 1<= 250
ID of the person
A page of bank accounts belonging to the person.
Per-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.
Page metadata for a token-based list response.
Creates a new bank account for a person
ID of the person
The 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
Example:false
Bank account created successfully
The 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
Returns bank accounts belonging to the specified firm and visible to the authenticated customer, paginated by opaque continuation token. Account numbers are masked to ****.
Opaque continuation token returned by the previous response’s page.nextToken. Omit on the first request. Format is server-controlled and may change without an API version bump.
Requested number of items in the response. Defaults to 25 when omitted; values outside [1, 250] are rejected with 400 (not clamped). The actual size returned is reflected in page.size and may be smaller (last page or empty result).
Default:25
>= 1<= 250
ID of the firm
A page of bank accounts belonging to the firm.
Per-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.
Page metadata for a token-based list response.
Creates a new bank account for a firm scoped to the authenticated customer. Returns the created record with the account number masked.
ID of the firm
The 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
Example:false
Bank account created successfully
The 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
Operations for managing firm identities