Skip to main content
DELETE
Delete a customer

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

customerId
string
required

Response

Customer soft-deleted (status set to inactive)

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"

object
string
Example:

"customer"

type
enum<string>

Customer type. Only individual is supported for MVP.

Available options:
individual
Example:

"individual"

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>

active or inactive. Inactive customers cannot create new transactions. No intermediate states — all granularity lives in endorsement statuses.

Available options:
active,
inactive
Example:

"active"

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"

wallets
object[]

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

endorsements
object[]

Endorsements track KYC/compliance status. Types: basic, cryptoCustody, usd. Statuses use SCREAMING_CASE: INACTIVE, PENDING, ISSUES, ACTIVE, REJECTED, REVOKED_ISSUES, OFFBOARDED.

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