Get a User

Get a user by its id

API scope required: users.read

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

Get a User

cURL

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

200

{
  "userDetails": true,
  "kycData": false,
  "dueDiligence": false,
  "verificationHistory": false,
  "email": "[e-mail]",
  "phoneNumber": "[phone]",
  "userId": "usr_1234567890",
  "legalDocuments": {
    "type": "crossmint-privacy-policy",
    "acceptedAt": "2023-01-01T00:00:00.000Z",
    "isValidVersion": true
  }
}

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

User found

userDetails · boolean · required

Whether user details have been provided

Example:

true

kycData · boolean · required

Whether KYC data has been provided

Example:

false

dueDiligence · boolean · required

Whether due diligence data has been provided

Example:

false

verificationHistory · boolean · required

Whether verification history has been provided

Example:

false

email · string

User's email address

Example:

"[e-mail]"

phoneNumber · string

User's phone number

Example:

"[phone]"

userId · string

Unique user identifier

Example:

"usr_1234567890"

legalDocuments · object[]

List of accepted legal documents

Show child attributes

Example:

{
  "type": "crossmint-privacy-policy",
  "acceptedAt": "2023-01-01T00:00:00.000Z",
  "isValidVersion": true
}