Skip to content

Developer Documentation

Compliance (KYC)

Endpoints for managing user identity verification and compliance status. A minimum KYC level is required for most transactions.

Get KYC Status

GET /v1/compliance/kyc

Retrieve the current KYC level and compliance status for the authenticated user.

Query Parameters
Request Body
{}
Body Parameters
Test Request
Response
{
  "status": "success",
  "data": {
    "kyc_level": "none",
    "compliance_status": "pending_verification"
  }
}

Submit KYC Documents

POST /v1/compliance/kyc

Submit identity documents to upgrade your KYC tier. In this simulated environment, submitting a valid document type will instantly upgrade you to `tier1`.

Request Body
{
  "document_type": "national_id",
  "document_number": "12345678"
}
Body Parameters
  • document_type (string, required): The type of document (e.g., 'national_id', 'passport').
  • document_number (string, required): The document identification number.
Test Request
Response
{
  "status": "success",
  "message": "KYC documents submitted and verified.",
  "new_level": "tier1"
}