Create or Update User

Create or update a user and their personal data by user locator. If the user doesn’t exist, they will be created.

API scope required: users.create

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

Create or Update User

cURL

curl --request PUT \
  --url https://staging.crossmint.com/api/2025-06-09/users/{userLocator} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "userDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1990-01-15",
    "countryOfResidence": "US"
  },
  "kycData": {
    "nationality": "US",
    "addressOfResidence": {
      "line1": "123 Main Street",
      "line2": "Apt 4B",
      "city": "New York",
      "stateOrRegion": "NY",
      "postalCode": "10001"
    },
    "email": "[e-mail]",
    "phoneNumber": "[phone]",
    "identityDocument": {
      "type": "passport",
      "number": "AB123456",
      "issuingCountryCode": "ES"
    }
  },
  "verificationHistory": {
    "idVerificationTimestamp": "2024-01-15T10:30:00Z",
    "livenessVerificationTimestamp": "2024-01-15T10:32:00Z"
  },
  "dueDiligence": {
    "employmentStatus": "full-time",
    "sourceOfFunds": "salary-disbursement",
    "industry": "financial-institution",
    "estimatedYearlyIncome": "income-50k-100k"
  }
}
'

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>

Body

application/json

userDetails · object · required

Optional user details including name, date of birth, and country of residence

Show child attributes

Example:

{
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-01-15",
  "countryOfResidence": "US"
}

kycData · object · required

Optional KYC data for identity verification

Show child attributes

Example:

{
  "nationality": "US",
  "addressOfResidence": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "New York",
    "stateOrRegion": "NY",
    "postalCode": "10001"
  },
  "email": "[e-mail]",
  "phoneNumber": "[phone]",
  "identityDocument": {
    "type": "passport",
    "number": "AB123456",
    "issuingCountryCode": "ES"
  }
}

verificationHistory · object · required

Optional verification timestamps.

Show child attributes

Example:

{
  "idVerificationTimestamp": "2024-01-15T10:30:00Z",
  "livenessVerificationTimestamp": "2024-01-15T10:32:00Z"
}

dueDiligence · object

Optional due diligence information for compliance purposes

Option 1

Option 2

Show child attributes

Example:

{
  "employmentStatus": "full-time",
  "sourceOfFunds": "salary-disbursement",
  "industry": "financial-institution",
  "estimatedYearlyIncome": "income-50k-100k"
}

Response

200

application/json

User updated

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
}