v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

Users

Trigger Identity Verification

Trigger identity verification for a user.

API scope required: users.create

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

Path parameters

userLocatorstring required

A user locator can be of the format:

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

Headers

X-API-KEYstring required

API key required for authentication

Response

Verification triggered

Example response

{
  "eligibility": [
    {
      "type": "onramp",
      "status": "requires-data",
      "missingData": [
        "user-details",
        "kyc-data"
      ],
      "missingDocuments": [
        "id",
        "proof-of-address"
      ]
    }
  ]
}