POST
/
compliance
/
v2
/
kyc
Initiate a KYC workflow.
curl --request POST \
  --url https://sandbox-api.sandbox.lemmax.com/compliance/v2/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": {
    "level": 1,
    "type": "OCC_RULES_ENGINE_V2"
  },
  "customer": {
    "external_id": "wallet_address",
    "wallet": {
      "address": "0xaac17f958d2ee523a2206206994597c13d831ec2",
      "blockchain": "sepolia"
    }
  }
}'
{
  "data": {
    "error_code": "ERR01",
    "flow": "KYC_OCC",
    "widget_data": null
  }
}

Authorizations

​
Authorization
string
header
required

The access_token returned by the POST /auth/v1/oauth2/token API call.

Body

application/json

Initiate a KYC workflow.

The body is of type object.

Response

200
application/json

KYC process is successfully started.

The error case where API response is with 200 HTTP status code, but KYC cannot be started because customer is banned. The 200 HTTP status code is returned so that Developers would still initialize the widget and provide the response directly to the widget.