v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Query Participants

Get participant KYC status

This endpoint returns KYC Status information attached to a participant.

get/participant/{participant_code}/kyc_status

Path parameters

participant_codestring required

Example:ABCDEF

Unique participant identifier. Always 6 uppercase alphanumeric characters.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved participant KYC status. Including verification tier, status, and approval timestamps.

Example response

{
  "message": {
    "participant_code": "CUST01",
    "idv": "pass",
    "liveness_check": "pass",
    "tax_id": true,
    "edd": true,
    "edd_required": true,
    "tags": [
      "kyc_tier_1"
    ],
    "participant_status": "approved",
    "kyc_attempts": 1,
    "email_screening": "failed"
  }
}