Create a person

Creates a person and adds them to a given account. The email address provided for this person will be used to identify them and cannot be changed later.

If a person with this email address already exists, this request will add the existing person to the account.

SecurityCommonAuth
Request
Request Body schema: application/json

Body

accountId
required
string

The ID of the account to work with.

firstName
required
string <= 256 characters
lastName
required
string <= 256 characters
roleName
required
string
Enum: "Owner" "Admin" "Payer" "Viewer" "Accountant" "User"
emailAddress
required
string <email> <= 256 characters
dob
string or null

Date of birth

nationalities
Array of strings or null

Array of ISO 3166-1 alpha-2 country codes representing person nationalities

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

Indicates whether this persona has opted to receive the emails or not.

createdByPersonaId
string <uuid> <= 36 characters

The creator's persona ID.

addToUserPool
boolean
Default: true

Indicates whether or not to create a new user in the Cognito user pool.

sendInvite
boolean
Default: true

Indicates whether or not to send a Cognito invite to the user so that they can complete the sign-up process.

emailTheme
string
Enum: "em-light" "em-dark"
sessionId
string

The session ID.

mfaCode
string
customerIp
string

The customer's IP.

Responses
201

Created

post/people
Request samples
application/json
{
  • "accountId": "F50091",
  • "firstName": "Dolly",
  • "lastName": "Parton",
  • "roleName": "Owner",
  • "emailAddress": "sally.smith@example.com",
  • "dob": "1946-01-19",
  • "nationalities": [
    ],
  • "address": {
    },
  • "primaryMobileNumber": "+447798121212",
  • "status": "active",
  • "employeeNumber": "948947464",
  • "jobTitle": "Human Division Manager",
  • "notifyEmailTrans": true,
  • "createdByPersonaId": "cc834d96-ccd5-4ce7-9615-8371e8a19e4c",
  • "addToUserPool": false,
  • "sendInvite": false,
  • "emailTheme": "em-light",
  • "sessionId": "1234567890",
  • "mfaCode": "12345",
  • "customerIp": "173.21.221.46"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "Dolly",
  • "lastName": "Parton",
  • "title": "Master",
  • "middleInitials": "R",
  • "dob": "1946-01-19",
  • "gender": "Female",
  • "nationality": "US",
  • "nationalities": [
    ],
  • "countryOfResidence": "US",
  • "primaryMobileNumber": "+447798121212",
  • "primaryEmailAddress": "test@equalsqa.com",
  • "avatar": {
    },
  • "sendInvite": true,
  • "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  • "verifyEmailAddress": true,
  • "verifyMobileNumber": true,
  • "sub": "753487e7-10bc-4e69-b3b2-4da33721ea3e",
  • "hasPeopleCard": true,
  • "card": {
    },
  • "persona": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}