Redeem API

Method: POST (HTTPS only)

  • Authorization: Bearer
  • Content-Type: application/json

Important: HTTPS is required. Responses should be deterministic to support idempotency.

Request

json
{
  "code": "CODE123",
  "state": "STATE123",
  "client_id": "cryptopass-mobile"
}

Response (200 OK)

json
{
  "ok": true,
  "provider_slug": "myexchange",
  "user_id": "ext-user-12345",
  "sumsub_applicant_id": "optional-abc123",
  "email": "optional@example.com"
}

Errors

CodeErrorDescription
400invalid_codeBad request
401unauthorizedAuth failed
409replayCode already used
429rate_limitedToo many requests
5xxinternal_errorServer error

provider_slug must match the agreed slug (af_sub3). user_id must be a stable external user identifier.