Flow
Steps
1
1) Get fields + values
GET /kyc/values to see required fields and allowed values.2
2) Submit application
POST /kyc/applications with the fields below. Sandbox: set lastName to approved to auto‑approve.3
3) Complete verification
We return a
completionLink (or externalVerificationLink). Open it in a browser for document upload and face match. Users finish verification there — you don’t need to handle media.4
4) Check status
Poll
GET /kyc/status until the status becomes approved (or an actionable state such as needs_information).5
5) Accept agreements
After approval, fetch the agreements and collect user consent. See Agreements.
States
- approved
- pending
- needs_information
- needs_verification
- manual_review
- denied
- locked
- canceled
Fields (submit application)
SOC occupation code (e.g.,
49-3023). Full list: KYC Field Values.Choose one label (we map to the underlying range for you):
-
<40k -
50k–99k -
100k–149k -
150k+
Choose one label (we map to the underlying range for you):
-
under $1k -
$1k–$5k -
$5k–$20k -
$20k+
Response (status)
One of:
approved, pending, needs_information, needs_verification, manual_review, denied, locked, canceled.Sandbox shortcut: set
lastName to approved to auto‑approve. See KYC Field Values for allowed field values.