CustomerGetKycStatus

Endpoint

GET /customer/kyc

Authorization

Requires SESSION_CUSTOMER token.

Description

Returns the authenticated customer's KYC profile, active steps and documents. If the customer does not have a profile yet, profile is null, steps is an empty array and documents is an empty array.

Response

{
  "profile": {
    "id": 1,
    "customer_id": 100,
    "brand": "default",
    "status": 2,
    "current_level": 0,
    "required_level": 1,
    "risk_level": 0,
    "created_time": 1778160000,
    "updated_time": 1778160000
  },
  "steps": [
    {
      "id": 10,
      "customer_id": 100,
      "kyc_id": 1,
      "brand": "default",
      "template_id": 1,
      "level": 1,
      "code": "proof_id",
      "name": "Proof of identity",
      "step_type": 0,
      "required": 1,
      "status": 0,
      "requirements": {},
      "form_schema": {},
      "answers": {}
    }
  ],
  "documents": [
    {
      "id": 1,
      "customer_id": 100,
      "kyc_id": 1,
      "step_id": 10,
      "brand": "default",
      "type": "passport",
      "status": 0,
      "file_id": "2d8b3e5c-5b02-43f4-8b31-1a1cc33c7d12",
      "file_name": "passport.pdf",
      "content_type": "application/pdf",
      "file_size": 245000,
      "checksum": "..."
    }
  ]
}

Errors

HTTP	Error	Description
400	INVALID_CUSTOMER	Customer was not found
401	PERMISSION_DENIED	Customer session is missing or invalid