Skip to main content
POST
Create a user entity

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
first_name
string
required

First name.

last_name
string
required

Last name.

address_one
string
required

Street address line 1.

city
string
required

City.

postal_code
string
required

5-digit US ZIP code.

country
string
required

ISO 3166-1 alpha-2 country code.

state
string
required

ISO 3166-2 two-letter state/region code.

email
string<email>
required

Email address.

Example:

"jane.doe@example.com"

phone_number
string
required

Phone number in E.164 format.

Example:

"+12125551234"

api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

ssn
string

Social security number. Encrypted at rest.

date_of_birth
string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-04-15"

middle_name
string

Middle name.

address_two
string

Street address line 2.

username
string

Chosen username for the user.

terms_accepted
boolean

True to confirm the end user accepted the program terms.

meta_data
object[]

List of {name, value} pairs to persist alongside the entity.

business_id
string

Optional. When supplied, the created user is also linked as a contact of this business.

Example:

"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"

is_vendor
boolean

Optional. When business_id is supplied, marks the created business contact as a vendor.

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.