API Reference
KYC

Save details without sending them for review

PUT
/v1/kyc/profiles/{id}/draft

Saves the account type and the details typed so far. Nothing is checked or reviewed until you submit. Saving replaces the details stored before, so send every field you want kept.

Only Kenya is supported for now: country must be Kenya or left out (400 kyc.country_unsupported otherwise). A profile waiting for review can't be changed (409 kyc.pending_review).

Authorization

personalKeyAuth
AuthorizationBearer <token>

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

Path Parameters

id*string

The KYC profile id.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/kyc/profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft" \  -H "Content-Type: application/json" \  -d '{    "kind": "individual",    "evidence": {}  }'
{  "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"}
{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ],    "resolution": "string",    "reason": "invalid_characters",    "suggested_e164": "+254727524723"  }}
{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ],    "resolution": "string",    "reason": "invalid_characters",    "suggested_e164": "+254727524723"  }}

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`.

List the documents uploaded to a verification GET

The newest document of each type is the one reviewed.