Start a new verification
Starts a draft profile. Most owners already have one: it is created
when you verify your phone while setting up a workspace, so check
GET /v1/kyc/profiles first. A new profile backs a workspace only
once you link it there in the console.
Authorization
personalKeyAuth Your personal API key, sent as Authorization: Bearer <key>. Generate
it in the SautiKit console under Account > API key. It acts as you,
not as a workspace, so it reaches what belongs to you as a person:
your KYC verification. Workspace API keys don't work here.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/kyc/profiles" \ -H "Content-Type: application/json" \ -d '{ "kind": "individual" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "individual", "display_name": "string", "level": "none", "status": "draft", "requested_level": "individual", "phone_e164": "+254712345678", "phone_verified_at": "2019-08-24T14:15:22Z", "review_note": "string", "daily_limit": 100, "number_limit": 20, "numbers_owned": 3, "used_today": 4, "workspace_count": 1, "suspended_at": "2019-08-24T14:15:22Z", "suspension_reason": "string", "created_at": "2019-08-24T14:15:22Z"}List your verifications GET
Returns your KYC profiles, with their level, review status and limits. A profile belongs to you as a person and can back several of your workspaces; its daily and number limits apply across all of them.
Get a verification and the details saved on it GET
Returns the profile and the details typed into it so far (`evidence`), including a draft that has not been sent for review. A profile that isn't yours answers `404 kyc.not_found`.