Skip to main content
POST
Create a user

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
first_name
string

Pre-fill Link's login screen with this first name.

last_name
string

Pre-fill Link's login screen with this last name.

email
string

Pre-fill Link's login screen with this email.

Required for banking verifications when phone_number is not provided.

Invalid email addresses will cause the request to fail. We recommend client-side validation and retrying the request without the invalid email if you receive:

phone_number
string

Pre-fill Link's login screen with this phone number. E.164 international format recommended.

Required for banking verifications when email is not provided.

Invalid phone numbers will cause the request to fail. We recommend client-side validation and retrying the request without the invalid phone number if you receive:

ssn
string

Social Security number.

Required for banking verifications when birth_date is not provided.

address
object

Address of the user.

birth_date
object

Date of birth of the user.

Required for banking verifications when ssn is not provided.

external_metadata
object

Any valid JSON.

open_banking
object

Can be optionally included when ordering banking verifications.

external_id
string

Any string. Maximum 100 characters.

Response

200 - application/json
user_token
string

Token associated with the created user.

id
string<uuid>

Unique ID of the user.