Skip to main content
POST
Create a user

Authorizations

Authorization
string
header
required

Bearer JWT issued to your business account during onboarding

Body

application/json
name
string
required
Example:

"Jane Doe"

birthDate
string
required

Date of birth (YYYY-MM-DD). Required. User must be at least 18 years old. Sent to the card issuer on enroll.

Example:

"1990-05-15"

email
string
required

Valid email address (RFC format). Plus-address aliases such as jane+tag@example.com are allowed.

Example:

"jane@enduser.example.com"

phone
object
required

Required.

password
string
required

At least 8 characters with uppercase, lowercase, number, and special character.

Example:

"Str0ng!Pass"

confirmPassword
string
required

Must match password.

Example:

"Str0ng!Pass"

termsPolicy
boolean
required

Must be true. User agrees to the Terms and Conditions.

Example:

true

firstName
string
Example:

"Jane"

lastName
string
Example:

"Doe"

subAccountId
string

Defaults to the business default sub-account. Must be an active sub-account belonging to your business.

physicalAddress
object

Residential address. Optional on create; required later for virtual card issue if not already stored.

Response

201 - application/json
userId
string
required

End user id (users._id)

Example:

"507f1f77bcf86cd799439013"

verificationUrl
string
required

Hosted link for the end user to complete identity verification

Example:

"https://verify.easyonramp.com/kyc?token=..."