🆕 Create KYC Verification

Code samples

PUT /webapi/kyc

Body parameter

{
  "email": "user@example.com",
  "country_restriction_mode": "all",
  "allowed_countries": ["ru", "kz"],
  "allowed_document_types": ["passport", "id_card"]
}

🛠️ Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» email	body	string(email)	true	Email address for verification
» country_restriction_mode	body	string	false	Country restriction mode: `all` or `whitelist`
» allowed_countries	body	string[]	false	List of allowed countries (ISO codes)
» allowed_document_types	body	string[]	false	List of allowed document types

Example responses

200 Response

{
  "success": true,
  "item": {
    "id": 1,
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": 123,
    "email": "user@example.com",
    "status": 0,
    "step": 0,
    "country_restriction_mode": "all",
    "allowed_countries": null,
    "allowed_document_types": null,
    "liveness_status": 0,
    "liveness_attempts": 0,
    "created_at": "2023-12-01T09:00:00Z",
    "updated_at": "2023-12-01T09:00:00Z"
  }
}

🔁 Responses

Status	Meaning	Description	Schema
200	OK	KYC verification successfully created	Inline
401	Unauthorized	Unauthorized	Inline
422	Unprocessable Entity	Validation error	Inline

📋 Response Schema (KycVerification)

Name	Type	Description
id	integer	Record ID
uuid	string(uuid)	Verification UUID
user_id	integer	User ID
email	string	Email
status	integer	0: new, 1: process, 2: moderate, 3: fail, 4: success
step	integer	Current step
country_restriction_mode	string	`all` or `whitelist`
allowed_countries	string[]	Allowed countries
allowed_document_types	string[]	Allowed document types
liveness_status	integer	0: pending, 1: pass, 2: fail
liveness_attempts	integer	Number of liveness attempts