Skip to main content
POST
/
core
/
users
Create user
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/core/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[email protected]",
  "termsOfService": "general-gb-fca",
  "country": "GB",
  "subdivision": "GB-MAN",
  "citizenshipCountry": "GB",
  "partnerOnboardedAt": "2025-02-01T00:00:00Z"
}'
{
  "user": {
    "id": "cd21b26d-35d2-408a-9201-b8fdbef7a604",
    "email": "[email protected]",
    "citizenshipCountry": "GB",
    "address": {
      "country": "GB",
      "subdivision": "GB-MAN"
    },
    "partnerOnboardedAt": "2025-02-01T00:00:00Z",
    "createdAt": "2024-03-13T20:20:39Z",
    "updatedAt": "2024-03-13T20:20:39Z"
  }
}
Users must read and agree with the general Terms of Service associated with their country of residence, and you must provide it in the termsOfService field of the request. You can find details on countries and subdivisions here.
The X-Uphold-User-Ip request metadata header is mandatory on this request, so that the user’s IP gets recorded when accepting the general Terms of Service.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
email
string<email>
required

The email address.

Maximum length: 255
​
country
string
required

The country of residency.

​
citizenshipCountry
string
required

The citizenship country.

​
termsOfService
enum<string>
required

The general terms of service the user agreed to.

Available options:
general-us-hq,
general-ca-osc,
general-gb-fca,
general-lt-fcs,
general-bs-scb
​
partnerOnboardedAt
string<date-time>
required

The date and time when the user was onboarded by the partner.

​
subdivision
string

The subdivision of residency.

Response

User created.

​
user
object
required