Accounts

Account Invitations can be sent to any Collaborator. Once the Invitation has been accepted, the Collaborator sets up an Account and becomes a User.

Account

{
  "_id": "{id}",
  "openId": "auth0|12345abcde",
  "username": "[email protected]",
  "firstName": "Jane",
  "lastName": "Smith",
  "profilePhoto": "",
  "brandCodeAffiliations": [],
  "primaryResidence": {
    "_id": "{id}",
    "country": "Canada",
    "__v": 0
  },
  "emails": [
    {
      "primary": true,
      "verified": true,
      "address": "[email protected]"
    }
  ],
  "phones": [
    {
      "primary": true,
      "number": 4161234567,
      "ext": 0,
      "mobile": true
    }
  ],
  "settings": {
    "notificationMethod": "push",
    "communicationLanguage": "en-CA",
    "preferredLanguage": "en-CA",
    "country": "CA",
    "mfaDisabled": true,
    "notificationsDisabled": true,
    "mfaMode": "sometimes",
    "idpMfa": "sometimes",
    "currency": "string"
  },
  "agreements": [
    {
      "locale": "en-CA",
      "type": "tos",
      "version": 0,
      "consent": true
    }
  ],
  "dataBaseRegion": "CA",
  "identityProvider": "auth0"
}

Account entity

username string
Account username.
Default: Auth0 username (email).

---

firstName string
Account user's first name.
Default: Auth0 first name.

---

lastName string
Account user's last name.
Default: Auth0 last name.

---

profilePhoto string
URL of the profile photo.

---

dateOfBirth string
Date of birth in DD/MM/YYYY format.

---

maritalStatus enum
Marital status.
Possible values: single, rather_not_say, married, separated, divorced, widowed, defunct.

---

brandCodeAffiliations string
Brand code affiliations.

---

primaryResidence Address entity
Account user's primary residence.

---

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

---

emails array of Email entities
Account email address(es).
Default: Auth0 email.

---

phones array of Phone entities required
Account phone number(s).

---

settings Account Settings entity required
Account settings information.

---

agreements Agreements entity required
Agreements.

---

invitationCode string
Invitation code.

---

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 enum
Identity provider used when the Account is created.
Default: Auth0.
Possible values: auth0, keycloak.

---

Address entity

buildingNumber string
Address building number.

---

streetName string
Address street name.

---

unitNumber string
Address unit number.

---

city string
Address city.

---

provinceState string
Address province or state.

---

postalZip string
Address postal code or ZIP code.

---

country string required
Address country.

---

Email entity

primary boolean
Set primary = true if this is the primary email address.

---

verified boolean
verified = true if the email has been verified.

---

address string required
Email address.

---

Phone entity

primary boolean
primary = true if this is the primary phone number.

---

number number required
Phone number.

---

ext number required
Phone number extension.

---

mobile boolean required
mobile = true if this is a mobile number.

---

Account Settings (settings) entity

notificationMethod enum required
Preferred communication method.
Possible values: push, email, sms, log.

---

communicationLanguage enum required
Preferred communication language.
Possible values: en-CA, fr-CA, en-US, es-US.

---

preferredLanguage enum required
Preferred language.
Possible values: en-CA, fr-CA, en-US, es-US.

---

country enum required
Country of residence in ISO 3166 format.

Possible values:

AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

---

mfaDisabled boolean required
Set mfaDisabled = true if multi-factor authentication should be disabled.

---

notificationsDisabled boolean required
Set notificationsDisabled = true if notifications should be disabled.

---

mfaMode enum required
Multi-factor authentication mode.
Possible values: sometimes, everyTime, never.

---

idpMfa enum required
Identity provider multi-factor authentication mode.
Possible values: sometimes, everyTime, never.

---

currency string required
Currency in which to operate.

---

Agreements (agreements) entity

locale enum required
Locale.
Possible values: en-CA, fr-CA, en-US, es-US.

---

type enum required
Agreement type.
Possible values: tos, privacy_policies, anti_spam.

---

version number required
Agreement version.

---

consent boolean required
consent = true if consent is given for the agreement.