Skip to main content
GET
Get an account

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant. Send client_id:client_secret as HTTP Basic, or as form fields. Tokens are HS256 JWTs valid for one hour (configurable). Decode them at jwt.io.

Path Parameters

id
string
required

Response

ok

object
enum<string>
required

Discriminator naming the shape of this resource (e.g. account, transaction).

Available options:
account
Example:

"account"

id
string
required
Example:

"accounts_receivable:acme"

type
enum<string>
required
Available options:
asset,
liability,
revenue,
expense,
equity
Example:

"liability"

currency
string
required
Example:

"USDC"

name
string
Example:

"Acme payable"

currency_decimals
integer | null

6 for USDC, 8 for BTC, 18 for ETH; null for unknown.

Example:

6

currency_kind
enum<string> | null
Available options:
fiat,
crypto,
stablecoin,
null
Example:

"stablecoin"

unknown_currency
boolean

True if currency isn't in our metadata registry. The ledger still works.

Example:

false

overdraft_policy
enum<string>
Available options:
allowed,
none
Example:

"allowed"

overdraft_limit
string

Numeric string. Always nonneg.

Example:

"0"

account_kind
enum<string>
default:standard

restricted is set by the platform on accounts created via POST /v1/reserves. Customers can also pass it explicitly to model reserves they build by hand.

Available options:
standard,
restricted
counterparty_ref
string | null

Opaque, customer-defined identifier of the counterparty a reserve account is held against. Set automatically by POST /v1/reserves; ignored on non-reserve accounts.

Example:

"acme"

fund_classification
enum<string>
default:neutral

Customer-set grouping for funds segregation reporting. The platform does not interpret this beyond grouping accounts in GET /v1/reports/fund_segregation. Inherited from the account's template when omitted on create.

Available options:
client_held,
operator,
neutral
custody_provider
string | null

Opaque custody-system identifier (e.g. fireblocks, anchorage). Paired with custody_external_id: both set or both null.

Example:

"fireblocks"

custody_external_id
string | null

Provider-specific identifier (vault id, account id, etc.). Paired with custody_provider.

Example:

"vault_42"

metadata
object
created_at
string<date-time>
Example:

"2026-05-14T10:23:45.123456Z"