v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

Users

Get a User

Get a user by its id

API scope required: users.read

get/2025-06-09/users/{userLocator}

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

User found

emailstring

User's email address

phoneNumberstring

User's phone number

userIdstring

Unique user identifier

userDetailsboolean required

Whether user details have been provided

kycDataboolean required

Whether KYC data has been provided

dueDiligenceboolean required

Whether due diligence data has been provided

verificationHistoryboolean required

Whether verification history has been provided

Example response

{
  "email": "john.doe@example.com",
  "phoneNumber": "+1234567890",
  "userId": "usr_1234567890",
  "userDetails": true,
  "legalDocuments": [
    {
      "type": "crossmint-privacy-policy",
      "acceptedAt": "2023-01-01T00:00:00.000Z",
      "isValidVersion": true
    }
  ]
}