Create an Account

post https://api-sbx.sidedrawersbx.com/api/v1/users/accounts

Creates an Account. Use the request body to set such parameters as: username, name, date of birth, primary residence, emails, phone numbers.

Body Params

username

string

Account username. By default, takes the Auth0 username (email).

firstName

string

Account first name, by default takes Auth0 first name.

lastName

string

Account last name, by default takes Auth0 last name.

profilePhoto

string

URL of the profile photo.

dateOfBirth

string

Date of birth in DD/MM/YYYY format.

maritalStatus

string

Marital status.

brandCodeAffiliations

array of strings

Brand code affiliations.

brandCodeAffiliations

primaryResidence

object

Account User's primary residence address.

gender

string

Account User's gender. Possible values: female, male, rather_not_say, other.

emails

array of objects

Account email address(es). Default: Auth0 email.

emails

phones

array of objects

required

Account phone number(s).

phones*

settings

object

required

Account settings information.

agreements

array of objects

required

Agreements object.

agreements*

invitationCode

string

The Invitation code to the entity.

referralCode

string

Invitation code sent from a referral, business or sponsor.

defaultSidedrawer

string

Default Drawer (sidedrawer) identifier.

dataBaseRegion

string

Region in which to store the data. Possible values: "US", "CA", "EU".

identityProvider

string

Identity provider used when the Account is created. Default: Auth0.

Response

Language

Credentials

Bearer

JWT


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://api-sbx.sidedrawersbx.com/api/v1/users/accounts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "settings": {
8
    "notificationMethod": "push",
9
    "communicationLanguage": "en-CA",
10
    "preferredLanguage": "en-CA",
11
    "country": "AF",
12
    "mfaDisabled": true,
13
    "notificationsDisabled": true,
14
    "mfaMode": "sometimes",
15
    "idpMfa": "sometimes"
16
  }
17
}
18
'


xxxxxxxxxx
 
1
{
2
  "id": ""
3
}

201The Account has been successfully created.