Create or Update User

Headers

X-API-KEY

string

required

API key required for authentication

Path Parameters

userLocator

string

required

Body

application/json

userDetails

object

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

Show child attributes

userDetails.firstName

string

required

User's legal first name

Required string length: 1 - 50

Example:

"John"

userDetails.lastName

string

required

User's legal last name

Required string length: 1 - 60

Example:

"Doe"

userDetails.dateOfBirth

string

required

User's date of birth in YYYY-MM-DD format

Required string length: 10

Example:

"1990-01-15"

userDetails.countryOfResidence

string

required

User's country of residence in ISO 3166-1 alpha-2 format

Required string length: 2

Example:

"US"

Example:

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

kycData

object

Optional KYC data for identity verification

Show child attributes

kycData.addressOfResidence

object

required

Physical address of residence

Show child attributes

kycData.addressOfResidence.line1

string

required

Primary address line (street address)

Minimum string length: 1

Example:

"123 Main Street"

kycData.addressOfResidence.city

string

required

City name

Minimum string length: 1

Example:

"New York"

kycData.addressOfResidence.state

string

required

State or province

Minimum string length: 1

Example:

"NY"

kycData.addressOfResidence.postalCode

string

required

Postal or ZIP code

Minimum string length: 1

Example:

"10001"

kycData.addressOfResidence.line2

string

Secondary address line (apartment, suite, etc.)

Example:

"Apt 4B"

Example:

{
  "line1": "123 Main Street",
  "line2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001"
}

kycData.identityDocument

object

required

Identity document details

Show child attributes

kycData.identityDocument.type

enum<string>

required

Type of identity document

Available options:

id,

passport

Example:

"passport"

kycData.identityDocument.number

string

required

Identity document number

Minimum string length: 1

Example:

"AB123456"

Example:

{ "type": "passport", "number": "AB123456" }

kycData.email

string<email>

User's email address, Recommended for verification

Example:

"[email protected]"

kycData.phoneNumber

string

User's phone number, Recommended for verification

Example:

"+1234567890"

Example:

{
  "addressOfResidence": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "email": "[email protected]",
  "phoneNumber": "+1234567890",
  "identityDocument": { "type": "passport", "number": "AB123456" }
}

dueDiligence

object

Optional due diligence information for compliance purposes

Show child attributes

dueDiligence.employmentStatus

enum<string>

required

User's current employment status

Available options:

contractual,

full-time,

part-time,

retired,

self-employed,

student,

unemployed

Example:

"full-time"

dueDiligence.sourceOfFunds

enum<string>

required

Primary source of the user's funds

Available options:

employment-income,

investments-gains,

business-dividends-profits,

real-estate,

inheritance,

savings-personal-funds,

loan-disbursement,

government-benefits,

other

Example:

"employment-income"

dueDiligence.industry

enum<string>

required

Industry in which the user is employed or conducts business

Available options:

accommodation-food-services,

administrative-support-waste-management-remediation-services,

adult-entertainment,

agriculture-forestry-fishing-hunting,

arts-entertainment-recreation,

auctions,

automobiles,

blockchain,

construction,

crypto,

e-commerce,

educational-services,

export-import,

finance-insurance,

financial-institution,

hedge-fund,

health-care-social-assistance,

information,

insurance,

investment,

management-of-companies-enterprises,

manufacturing,

market-maker,

mining,

money-service-business,

non-profit,

precious-metals,

professional-scientific-technical-services,

public-administration,

real-estate-rental-leasing,

registered-investment-advisor,

retail-trade,

shell-bank,

stock-issuer,

student,

transportation-warehousing,

travel-transport,

unemployed,

utilities,

wholesale-trade,

other-services

Example:

"finance-insurance"

Example:

{
  "employmentStatus": "full-time",
  "sourceOfFunds": "employment-income",
  "industry": "finance-insurance"
}

verificationHistory

object

Optional verification timestamps.

Show child attributes

verificationHistory.idVerificationTimestamp

string<date-time>

required

ISO 8601 timestamp of when ID verification was completed

Example:

"2024-01-15T10:30:00Z"

verificationHistory.livenessVerificationTimestamp

string<date-time>

required

ISO 8601 timestamp of when liveness verification was completed

Example:

"2024-01-15T10:32:00Z"

Example:

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

Response

User updated

Response schema indicating which user data fields have been populated

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

string

User's email address

Example:

"[email protected]"

phoneNumber

string

User's phone number

Example:

"+1234567890"

userId

string

Unique user identifier

Example:

"usr_1234567890"

Introduction

Users & Compliance

Onramp

Treasury Wallet

Regulated Transfers

Headers

Path Parameters

Body

Response