Skip to main content
PUT
/
2025-06-09
/
users
/
{userLocator}
/
identity-verification
Trigger Identity Verification
curl --request PUT \
  --url https://staging.crossmint.com/api/2025-06-09/users/{userLocator}/identity-verification \
  --header 'X-API-KEY: <x-api-key>'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
userLocator
string
required

Response

200 - application/json

Verification triggered

Response containing identity verification eligibility status for all verification types

​
eligibility
object[]
required

Array of eligibility status for different verification types

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"
  }
]