curl https://api.thanxsandbox.com/users/ \
-X POST \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "X-ClientId: ${client_id}" \
-d '{
"user": {
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"month": 8,
"day": 14
},
"zip_code": "12345"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "X-ClientId: ${client_id}" \
-d '{
"user": {
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"month": 8,
"day": 14
},
"zip_code": "12345",
"signup_program_id": "awe833ke24"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
$STANDARD_HEADERS \
-d '{
"user": {
"email": "jane.smith@example.com"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
$STANDARD_HEADERS \
-d '{
"user": {
"email": "jane.smith@example.com"
}
}'
{
"user": {
"id": "wroeiu2304hfwf",
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"year": 1987,
"month": 8,
"day": 14
},
"zip_code": "12345"
},
"authorization": {
"token_type": "Bearer",
"scope": "passwordless",
"created_at": 1577836800,
"access_token": "945148251b603ae34561d90acfe4050e67494d6d1e65d4d3d52798407f03c0bd",
"refresh_token": "c74334301a7c74d21b714c905fd3047177dab56de6a86899e6f6b7f71bab7d55"
}
}
{
"error": {
"code": "USER_NAME_REQUIRED",
"message": "First and last name are required fields."
}
}
{
"error": {
"code": "BAD_REQUEST",
"message": "User account exists"
}
}
Users
Create User
POST
/
users
curl https://api.thanxsandbox.com/users/ \
-X POST \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "X-ClientId: ${client_id}" \
-d '{
"user": {
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"month": 8,
"day": 14
},
"zip_code": "12345"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "X-ClientId: ${client_id}" \
-d '{
"user": {
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"month": 8,
"day": 14
},
"zip_code": "12345",
"signup_program_id": "awe833ke24"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
$STANDARD_HEADERS \
-d '{
"user": {
"email": "jane.smith@example.com"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
$STANDARD_HEADERS \
-d '{
"user": {
"email": "jane.smith@example.com"
}
}'
{
"user": {
"id": "wroeiu2304hfwf",
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"year": 1987,
"month": 8,
"day": 14
},
"zip_code": "12345"
},
"authorization": {
"token_type": "Bearer",
"scope": "passwordless",
"created_at": 1577836800,
"access_token": "945148251b603ae34561d90acfe4050e67494d6d1e65d4d3d52798407f03c0bd",
"refresh_token": "c74334301a7c74d21b714c905fd3047177dab56de6a86899e6f6b7f71bab7d55"
}
}
{
"error": {
"code": "USER_NAME_REQUIRED",
"message": "First and last name are required fields."
}
}
{
"error": {
"code": "BAD_REQUEST",
"message": "User account exists"
}
}
This endpoint creates a user, but it also facilitates signing an existing
platform user up with the client brand in scenarios where the SSO flow wouldn’t
be appropriate (i.e., the user is not signing in to an authenticated
experience).
If a user with the specified email already exists, it signs the user up with the
client brand before returning a 400 level error. This endpoint also returns
authorization information for a successfully created user, including an
access_token that can be used to access other API endpoints. Experiences
utilizing this endpoint must adhere to the
legal requirements for user creation.
Please review proper request headers here.
Body
string
required
The user’s email
string
The user’s phone number in E.164 format,
with the country code prefix (e.g.
+14157582345). Phones submitted
without the country code prefix are stored as-is — this endpoint does
not normalize them — and will fail later phone-based lookups (such as
Partner Auth Token) that depend on E.164 parsing.string
required
The user’s first name
string
required
The user’s last name
hash
string
The user’s zip code
string
The Program ID to associate with this user signup. This is used to track which signup program the user enrolled through. The program must be active and belong to the merchant. If the program is invalid, it will be silently ignored without preventing user creation. Only applied to new users; existing users will not have their signup_program_id updated.
This endpoint permits minimal requests that only contain an
email parameter
for the purposes of signing up an existing platform user with the client
brand. If the email belongs to an existing user, it signs the user up with the
brand before returning a 400 level error.curl https://api.thanxsandbox.com/users/ \
-X POST \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "X-ClientId: ${client_id}" \
-d '{
"user": {
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"month": 8,
"day": 14
},
"zip_code": "12345"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "X-ClientId: ${client_id}" \
-d '{
"user": {
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"month": 8,
"day": 14
},
"zip_code": "12345",
"signup_program_id": "awe833ke24"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
$STANDARD_HEADERS \
-d '{
"user": {
"email": "jane.smith@example.com"
}
}'
curl https://api.thanxsandbox.com/users/ \
-X POST \
$STANDARD_HEADERS \
-d '{
"user": {
"email": "jane.smith@example.com"
}
}'
Response
User
The newly created user
Show User
Show User
string
The user's identifier
string
The user's email
string
The user's phone number, in E.164 format (eg.
+14157582345)string
The user's first name
string
The user's last name
hash
string
The user's zip code
Authorization
The authorization type of the created user
{
"user": {
"id": "wroeiu2304hfwf",
"email": "jane.smith@example.com",
"phone": "+14158672345",
"first_name": "Jane",
"last_name": "Smith",
"birth_date": {
"year": 1987,
"month": 8,
"day": 14
},
"zip_code": "12345"
},
"authorization": {
"token_type": "Bearer",
"scope": "passwordless",
"created_at": 1577836800,
"access_token": "945148251b603ae34561d90acfe4050e67494d6d1e65d4d3d52798407f03c0bd",
"refresh_token": "c74334301a7c74d21b714c905fd3047177dab56de6a86899e6f6b7f71bab7d55"
}
}
{
"error": {
"code": "USER_NAME_REQUIRED",
"message": "First and last name are required fields."
}
}
{
"error": {
"code": "BAD_REQUEST",
"message": "User account exists"
}
}