Skip to main content
POST
Create a new Consumer

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
birthDate
string<date>
required

Consumer has Birth Date

phoneNumber
string
required

Consumer has Phone Number

Pattern: ^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$
lastName
string
required

Consumer has Last Name

firstName
string
required

Consumer has First Name

id
string

Customer is uniquely identified by id

addresses
(string | Address · object)[]

Customer is located at Addresses

phoneNumbers
string[]

Customer has Phone Number

Pattern: ^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$
email
string<idn-email>

Consumer has Email

ssn
string

Consumer has SSN

Response

Consumer Created

data
Consumer · object
Example:
success
boolean