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

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
userLocator
string
required

A user locator can be of the format:

  • email:<email>
  • userId:<userId>
  • phoneNumber:<phoneNumber>
  • twitter:<handle>
  • x:<handle>

Response

200 - application/json

Verification triggered

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