Skip to main content
POST
Identify user
Identify user finds an existing user or creates a new one, so you can then start a KYC sharing session for them with Create session.
The X-Uphold-User-Ip user context header is mandatory to record the user’s IP.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication

Body

application/json
email
string<email>
required

The email address.

Maximum string length: 255
country
string
required

The country of residency.

Pattern: ^[A-Z]{2}$

Response

User identified.

user
object
required