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}

cURL

Full KYC

curl --request PUT \
  --url https://staging.crossmint.com/api/2025-06-09/users/{userLocator} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "dueDiligence": {
    "employmentStatus": "full-time",
    "expectedYearlyTxVolume": "volume-0-25k",
    "industry": "financial-institution",
    "sourceOfFunds": "salary-disbursement"
  },
  "kycData": {
    "addressOfResidence": {
      "city": "Berlin",
      "line1": "123 Hauptstrasse",
      "line2": "Apt 5",
      "postalCode": "10115",
      "stateOrRegion": "Berlin"
    },
    "email": "[e-mail]",
    "identityDocument": {
      "issuingCountryCode": "DE",
      "number": "AS12321",
      "type": "passport"
    },
    "ipAddresses": [
      "203.0.113.1"
    ],
    "nationality": "DE"
  },
  "userDetails": {
    "countryOfResidence": "DE",
    "dateOfBirth": "1995-01-01",
    "firstName": "John",
    "lastName": "Doe"
  }
}
'

200

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

Authorizations

X-API-KEY · string · header · 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>

Examples:

"email:[e-mail]"

"userId:507f1f77bcf86cd799439011"

"userId:did:example:cm4lr5piw0h6t1bjho0onryql"

"phoneNumber:[phone]"

"twitter:johndoe"

"x:@johndoe"

Body

application/json

dueDiligence · Non-US residents · object

Optional due diligence information for compliance purposes

Non-US residents

US residents

Show child attributes

Example:

{
  "employmentStatus": "full-time",
  "expectedYearlyTxVolume": "volume-25k-75k",
  "industry": "financial-institution",
  "sourceOfFunds": "salary-disbursement"
}

kycData · object

Optional KYC data for identity verification

Show child attributes

Example:

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

userDetails · object

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

Show child attributes

Example:

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

verificationHistory · object

Optional verification timestamps.

Show child attributes

Example:

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

Response

200

application/json

User updated

dueDiligence · boolean · required

Whether due diligence data has been provided

Example:

false

kycData · boolean · required

Whether KYC data has been provided

Example:

false

userDetails · boolean · required

Whether user details have been provided

Example:

true

verificationHistory · boolean · required

Whether verification history has been provided

Example:

false

email · string

User's email address

Example:

"[e-mail]"

legalDocuments · object[]

List of accepted legal documents

Show child attributes

Example:

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

phoneNumber · string

User's phone number

Example:

"[phone]"

userId · string

Unique user identifier

Example:

"usr_1234567890"