Get Identity Verification Status

Get identity verification status for a user.

API scope required: users.read

GET /2025-06-09/users/{userLocator}/identity-verification

Get Identity Verification Status

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/users/{userLocator}/identity-verification \
  --header 'X-API-KEY: <x-api-key>'

200

{
  "eligibility": [
    {
      "type": "onramp",
      "status": "requires-data",
      "missingData": [
        "user-details",
        "kyc-data"
      ],
      "missingDocuments": [
        "id",
        "proof-of-address"
      ]
    },
    {
      "type": "offramp",
      "status": "verified"
    },
    {
      "type": "regulated-transfer",
      "status": "pending-review"
    }
  ]
}

Headers

X-API-KEY · string · required

API key required for authentication

Path Parameters

userLocator · string · required

Response

200 - application/json

Verification status

Response containing identity verification eligibility status for all verification types

eligibility · object[] · required

Array of eligibility status for different verification types

Show child attributes

Example:

[
  {
    "type": "onramp",
    "status": "requires-data",
    "missingData": ["user-details", "kyc-data"],
    "missingDocuments": ["id", "proof-of-address"]
  },
  { "type": "offramp", "status": "verified" },
  {
    "type": "regulated-transfer",
    "status": "pending-review"
  }
]