Sign in
Accounts

Get account by ID

Retrieve an account by ID with optional expansion of related resources.

Use the expand query parameter to include full objects:

  • customer: Include full customer details
  • sweepTargetAccount: Include full sweep target account details (for virtual bank accounts and virtual wallets)
  • counterparty: Include full counterparty details (for third-party recipient accounts)

Multiple expansions can be requested: ?expand=customer,sweepTargetAccount,counterparty

get/v1/accounts/{id}

Path parameters

idstring required

Account ID

Query parameters

expandstring[]

Fields to expand in the response. Pass as comma-separated values or repeated query params.

[
  "customer",
  "sweepTargetAccount",
  "counterparty"
]

Headers

X-API-Keystring

API key

Response

Account details

idstring required

Account ID (vba_xxx for virtual bank, vwa_xxx for virtual wallet, inb_xxx for infinite bank, inw_xxx for infinite wallet, eba_xxx for external bank, ewa_xxx for external wallet, pba_xxx for provider balance)

customerIdstring required

Customer ID

type'VIRTUAL_BANK' | 'VIRTUAL_WALLET' | 'INFINITE_BANK' | 'INFINITE_WALLET' | 'EXTERNAL_BANK' | 'EXTERNAL_WALLET' | 'EXTERNAL_PROXY' | 'PROVIDER_BALANCE' required

Account type

externalReferencestring

Client-provided external reference for mapping to your system

status'IN_REVIEW' | 'ACTIVE' | 'CLOSED' required

Account status

currencyCodesstring[]

Currency codes supported by this account

isThirdPartyboolean

Is this account owned by a third party?

counterpartyIdstring nullable

Counterparty ID when this is a third-party recipient account

referenceIdstring

Client-provided reference ID

originCapableboolean nullable

Whether this account can be used as the canonical transfer origin.

originAccountIdstring nullable

Canonical origin account ID when this account is a virtual alias.

createdAtstring date-time required

Account creation date

updatedAtstring date-time required

Account last update date

createdboolean

Whether this account was newly created in this request. Returns false if an existing account was returned (idempotent behavior).

holdsBalanceboolean

Present and true when this is a balance account (USD or stablecoin). Deposits credit the account instead of being swept, and the balance can fund transfers. See GET /v1/accounts/{id}/balance.

paymentRailstring

Payment rail for provider balance accounts (e.g. ETHEREUM). Omitted for other account types.

lastSentAtstring date-time nullable

Timestamp of the last transfer sent from this account

lastReceivedAtstring date-time nullable

Timestamp of the last transfer received to this account

screeningStatusstring nullable

Changes

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

  • c5a90949ca591See the full diff
    • ○

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

      response-required-property-added

  • bb2702829ce01See the full diff
    • ●

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

      response-property-enum-value-added

  • 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