Skip to content
Logo

api.accounts.get

Read a single account by its UUID. Polymorphic: branch on account.kind to dispatch on the layout of details. When you know the kind upfront, the per-kind variants under api.customers.getFiatAccount / api.customers.getCryptoAccount give a narrower response type.

A virtual account that has never had a balance sync is refreshed at request time, the same one-shot backfill as api.accounts.balance, so the first such read may take a moment. The result is stored and later reads are instant.

const  = await ..("5e3a…");
 
if (. === "fiat") {
  // account.shape ∈ FiatShape; account.details is a FiatAccount variant.
} else {
  // account.shape ∈ CryptoShape; account.details is { address }.
}
 
// Disambiguate a quote against a multi-rail account.
if (.. > 1) {
  const  = await ..({
    : "7c4b…",
    : "individual",
    : "200",
    : { : ., : ["ach"] },
    : "3c92d2a1-…",
  });
}

Arguments: id: string.

Returns: Promise<Account>.

REST endpoint: GET /accounts/:id.