POST/api/partner/users

Create a user

Creates a Prio account for one of your users and returns a signed-in session. Hand the session to the embed and your user picks up onboarding where your data leaves off.

Request body

Field Type Required
email string yes
phone string yes
firstName string or null when isIndividual
lastName string or null when isIndividual
displayName string or null when not isIndividual
legalName string or null no
isIndividual boolean yes
entityType string or null no
website string yes
defaultRole string yes
businessDescription string or null no
dob string or null no
taxId string or null no
averageTransactionSize number or null no
averageWeeklyTransactions number or null no
address <Address> or null no
street string yes
streetLine2 string or null no
city string yes
state string yes
postalCode string yes
country string yes

What each field means

Field Type Meaning
email string stored lower-cased, with spaces trimmed
phone string a 10-digit number without + gets +1 in front
isIndividual boolean true sends firstName and lastName; false sends displayName
displayName string the business name; required when isIndividual is false
legalName string the business's legal name; optional
entityType string one of sole_proprietorship, limited_liability_partnership, limited_liability_company, c_corporation, s_corporation or b_corporation
201 Created
{
  "success": true,
  "message": "User created successfully",
  "result": {
    "userId": "8f2c1d4e-6b7a-4c3d-9e1f-2a3b4c5d6e7f",
    "jwt": "eyJhbGciOi…",
    "refreshJwt": "eyJhbGciOi…",
    "referralToken": "maya-ortiz"
  }
}

An email or phone that is already a Prio account returns 409. When that account is one of your own users, the reply's details.userId names it, so a retried create can go on with GET /api/partner/users/:userId. The name you send sets the user's handle for good — the referralToken a payment button names — and it cannot be changed later.