Skip to main content
GET
/
2025-06-09
/
users
/
{userLocator}
Get a User
curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/users/{userLocator} \
  --header 'X-API-KEY: <x-api-key>'
{
  "email": "john.doe@example.com",
  "phoneNumber": "+1234567890",
  "userId": "usr_1234567890",
  "userDetails": true,
  "kycData": false,
  "dueDiligence": false,
  "verificationHistory": false
}

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

User found

Response schema indicating which user data fields have been populated

​
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:

"john.doe@example.com"

​
phoneNumber
string

User's phone number

Example:

"+1234567890"

​
userId
string

Unique user identifier

Example:

"usr_1234567890"

​
legalDocuments
object[]

List of accepted legal documents

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