Sign in
Accounts

Get accounts by customer

Returns all accounts for a specific customer. Use holdsBalance=true to list balance accounts.

get/v1/accounts/customer/{customerId}

Path parameters

customerIdstring required

Customer ID

Query parameters

limitnumber

Number of results to return (1-1000). Use with offset for traditional pagination.

offsetnumber

Number of results to skip. Use with limit for traditional pagination.

page_sizenumber

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

starting_afterstring

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

idstring

Account ID prefix to search for

holdsBalanceboolean

Only return balance accounts (USD or stablecoin). Same set as POST /v1/balance-accounts and POST /v1/balance-accounts/stablecoin.

balanceSourceEligibleboolean

Only return balance accounts that can fund a transfer from balance. Narrower than holdsBalance.

counterpartyIdstring
type'VIRTUAL_BANK' | 'VIRTUAL_WALLET' | 'INFINITE_BANK' | 'INFINITE_WALLET' | 'EXTERNAL_BANK' | 'EXTERNAL_WALLET' | 'EXTERNAL_PROXY' | 'PROVIDER_BALANCE'
providerstring
status'IN_REVIEW' | 'ACTIVE' | 'CLOSED'
addressType'EVM' | 'TRON' | 'BITCOIN' | 'SOLANA'
currencyCodesstring[]
paymentRailsstring[]
expandstring[]

Headers

X-API-Keystring

API key

Response

Paginated list of customer accounts

totalnumber
limitnumber
offsetnumber

Changes

Changed in 8 of the 19 revisions of this API.148

  • c5a90949ca591See the full diff
    • ○

      added the required property //////////////// to the response with the status

      response-required-property-added

  • bb2702829ce011See the full diff
    • ●

      added the new ROBINHOOD enum value to the ///////////////// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional query request parameter balanceSourceEligible

      new-optional-request-parameter

  • 916d2367a8f812See the full diff
    • ▲

      the response property //// became nullable for the status

      response-property-became-nullable

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • 7788dddbcb212See the full diff
    • ○

      added the optional property ////////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////////// to the response with the status

      response-optional-property-added

  • 16bbb87acca91See the full diff
    • ○

      added the optional property //////////// to the response with the status

      response-optional-property-added

  • f0ba578043a91See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 70223aefae8c1See the full diff
    • ●

      added the new LIVENESS_CHECK enum value to the ///////// response property for the response status

      response-property-enum-value-added

  • 7d6487f295d72See the full diff
    • ●

      added the new MESTA enum value to the //////////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new MESTA enum value to the ////////////// response property for the response status

      response-property-enum-value-added