Skip to main content
POST
/
core
/
users
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/core/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "email": "[email protected]",
  "termsOfService": "general-gb-fca",
  "country": "GB",
  "subdivision": "GB-MAN",
  "citizenshipCountry": "GB",
  "metadata": {
    "externalId": 123
  }
}
'
{
  "user": {
    "id": "cd21b26d-35d2-408a-9201-b8fdbef7a604",
    "type": "individual",
    "email": "[email protected]",
    "citizenshipCountry": "GB",
    "address": {
      "country": "GB",
      "subdivision": "GB-MAN"
    },
    "createdAt": "2024-03-13T20:20:39.000Z",
    "updatedAt": "2024-03-13T20:20:39.000Z"
  }
}
client Create user registers a new user with their identity and compliance information. 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 optionally include custom entity metadata in the metadata field to store your own business data (e.g., external IDs, settings, tracking parameters). If not provided during creation, you can add it later using Set metadata endpoint.
The X-Uphold-User-Ip user context header is mandatory to record the user’s IP when accepting the Terms of Service.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
type
enum<string>
default:individual
required

The type of the user.

Available options:
individual
​
email
string<email>
required

The email address.

Maximum string length: 255
​
country
string
required

The country of residency.

Pattern: ^[A-Z]{2}$
​
citizenshipCountry
string
required

The citizenship country.

Pattern: ^[A-Z]{2}$
​
termsOfService
enum<string>
required

The general terms of service the user agreed to.

Available options:
general-us-hq,
general-gb-fca,
general-pt-bop,
general-lt-fcs,
general-bs-scb
​
subdivision
string

The subdivision of residency.

Pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
​
partnerOnboardedAt
string<date-time>

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

Response

User created.

​
user
Individual · object
required
​
errors
object

Additional contextual errors that occurred while processing the request.