Skip to main content
GET
Get customer by ID

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

customerId
string
required

Response

Customer details with wallets

Customer response object. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only — accepted in POST/PATCH but never returned in responses.

id
string
Example:

"cst_01H9Xa8F5dN6mP3q"

type
enum<string>

Customer type. Individuals are subject to the project's KYC policy, businesses to its KYB policy.

Available options:
individual,
business
Example:

"individual"

name
string

An individual's first, middle and last names joined by spaces, or a business's legal name. Left out when the customer has no name.

Example:

"Jane Smith"

firstName
string | null
Example:

"Jane"

middleName
string | null
Example:

null

lastName
string | null
Example:

"Smith"

email
string | null
Example:

"jane@example.com"

phone
string | null

Primary phone in E.164 format.

Example:

"+12125551234"

nationality
string | null

ISO 3166-1 alpha-2 country code.

Example:

"US"

externalId
string | null

Developer's own user ID for cross-referencing.

Example:

"usr_12345"

status
enum<string>

Where the customer is in onboarding. actionRequired carries a hold saying what to do, and rejected carries a failure. offboarded is a deleted or deactivated customer.

Available options:
pending,
actionRequired,
active,
rejected,
offboarded
Example:

"active"

hold
object

What you must do for a customer in actionRequired.

failure
object

Why a customer or an endorsement was rejected.

signedAgreement
boolean

Whether the customer has accepted OMS terms of service.

Example:

true

signedAgreementAt
string<date-time> | null

Timestamp when signedAgreement was set to true. Null if not yet signed.

Example:

"2026-03-20T14:15:22Z"

totalBalance
object

USD rollup of a customer's balances. Returned on GET /customers/{id} only — never on list, create, or update. Covers fiat wallets and custodial crypto wallets; noncustodial wallets are not yet valued, so a customer holding one reads an undercount here. Omitted entirely when the rollup cannot be read; a partial total is never returned, so treat an absent field as "unknown", not as zero.

wallets
object[]

Simplified flat view: one entry per wallet-asset combination. Use GET /wallets/{id} for the full representation.

endorsements
object[]

What the customer is endorsed for. An endorsement never reads further along than its customer, and one that was not requested is left out.

metadata
object | null
createdAt
string<date-time>
updatedAt
string<date-time>