Skip to main content
GET
Get KYC status

Authorizations

Authorization
string
header
required

API key sent in the Authorization header.

Path Parameters

customer_id
string<uuid>
required

The customer (child org) ID. Must belong to the caller's organization or a direct child.

Query Parameters

requirements
boolean
default:false

Include the per-requirement requirements breakdown. Off by default.

Response

The org-level KYC status for the customer

KYC status response

customerId
string<uuid>
required
documents
object[]
required
needsWork
boolean
required
selfies
object[]
required
status
enum<string>
required

Unified KYC status for the customer's organization.

  • not_started: no KYC started
  • in_progress: the customer started the flow but hasn't submitted everything
  • submitted: submitted, awaiting review (manual or automated)
  • approved: cleared; the customer can transact
  • denied: a rejected verdict, or a previously-approved customer whose approval was revoked (reason in currentRejectionReason)
Available options:
not_started,
in_progress,
submitted,
approved,
denied
approvedAt
string<date-time> | null
currentRejectionReason
string | null
onChainMarked
boolean | null

Whether KYC is marked on-chain. Only present for Solana wallets. For other blockchain types (Stellar, EVM), this field is omitted as on-chain marking doesn't apply.

requirements
object[]

What the customer's verification still needs, step by step. Present only when asked for with ?requirements=true and the customer has been routed to their country's requirements; omitted otherwise.

userMessage
string | null
walletPublicKey
string | null