Skip to main content

Account

The authenticated account

GET /v2/account​

Get the account for the authenticated key

Identifies the account your key belongs to, and carries the settings other endpoints refer back to — most importantly preferredCurrency, which is the unit of every balancePrefCurrency field on GET /v2/balances. That unit is published here and nowhere else, so a client that formats balances needs this call once at start-up.

Responses

CodeDescriptionBody
200Success.AccountResource
401application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).—
403application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).—
429application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).—
500application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).—
502application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).—
503application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).—

Schemas​

AccountResource​

FieldTypeDescription
idstring
usernamestring
emailstring
fullNamestringe.g. Jane Doe.
nationalIdstring | null
verificationStatusstring
preferredCurrencystring

Problem​

FieldTypeDescription
typestringStable problem-type URI. Resolves to docs for this error. e.g. https://docs.skipo.com/errors/rate_limited.
titlestringShort, human-readable summary (stable, English). e.g. Rate limit exceeded.
statusnumberHTTP status code. e.g. 429.
codestringStable machine-readable error code (equals the last path segment of type). e.g. rate_limited.
retryablebooleanWhether retrying the identical request may succeed. e.g. true.
detail (optional)stringHuman-readable, possibly localized detail.
instance (optional)stringThe request path that produced the error.
traceId (optional)stringTrace id — joins BigQuery api_request and Cloud Logging.

Back to the endpoint reference. See also: Pagination · Errors · Ids and correlation.