Create company user

post

https://{hostname}/api/v1/platform/companies/{companyId}/users

Provisions a new user on the given company. The email must be unique among active users — reactivate an inactive user by updating them instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

uuid

required

The company's unique identifier.

Body Params

The full set of fields required to provision a company user via the Platform API.

firstName

string

required

^[A-Za-z ]*$

The user's first name. Letters and spaces only. Combined with lastName must not exceed 24 characters.

lastName

string

required

^[A-Za-z ]*$

The user's last name. Letters and spaces only. Combined with firstName must not exceed 24 characters.

string

required

The user's email address.

phone

string

required

A valid US phone number for the user.

address

object

required

The user's residential address.

birthdate

date

required

The user's date of birth (ISO 8601). Must be 18 years or older.

title

string

enum

required

The user's title at the company.

role

string

enum

required

The user's role on the company.

Allowed:

isOwner

boolean

Whether the user is also a beneficial owner of the business.

ipAddress

string

The end user's IP address, captured for terms acceptance. Defaults to your server's IP if omitted.

userAgent

string

The end user's user agent string, captured for terms acceptance. Defaults to your server's user agent if omitted.

Responses

200User created.

401The credential is missing, invalid, expired, or doesn't have permission for this endpoint.

403The credential is valid but doesn't have permission to access this resource.

404The requested resource doesn't exist or isn't accessible to your platform.

422The request failed validation, or a user with this email already exists.

500An unexpected server error occurred. Retry the request; if the problem persists, contact support.