Get KYC status

Check the current KYC verification status. Use provider=align for Align.

GET /api/v1/user/kyc/status

Get KYC status

cURL

curl --request GET \
  --url https://api.example.com/api/v1/user/kyc/status \
  --header 'Authorization: Bearer <token>'

200

{
  "provider": "swipelux",
  "email": "<string>",
  "kycStatus": "not_started",
  "externalUserId": "<string>",
  "status": "not_started",
  "firstName": "<string>",
  "lastName": "<string>",
  "entityName": "<string>",
  "kycLink": "<string>",
  "kycUrl": "<string>",
  "contactSupportLink": "https://app.gethevn.com/chat"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Query Parameters

provider · enum<string> · default: swipelux

Supported fiat payment providers.

Available options: swipelux, align, dakota, mcp, wirex, conduit_fiat, conduit_crypto, due

Response

200

application/json

Successful Response

Response schema for KYC status check.

provider · enum<string> · required

Supported fiat payment providers.

Available options: swipelux, align, dakota, mcp, wirex, conduit_fiat, conduit_crypto, due

email · string · required

kycStatus · enum<string> · required

KYC verification status.

Available options: not_started, requested, incorporating, pending, under_review, approved, rejected

externalUserId · string | null

status · enum<string> | null

KYC verification status.

Available options: not_started, requested, incorporating, pending, under_review, approved, rejected

firstName · string | null

lastName · string | null

entityName · string | null

kycLink · string | null

kycUrl · string | null

contactSupportLink · string · default: https://app.gethevn.com/chat