Skip to main content
POST
Create a person

Authorizations

Authorization
string
header
required

Body

application/json

Body

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

firstName
string
required
Maximum string length: 256
Example:

"Dolly"

lastName
string
required
Maximum string length: 256
Example:

"Parton"

roleName
enum<string>
required
Available options:
Owner,
Admin,
Payer,
Viewer,
Accountant,
User
emailAddress
string<email>
required
Maximum string length: 256
Example:

"sally.smith@example.com"

dob
string | null

Date of birth

Example:

"1946-01-19"

nationalities
enum<string>[] | null

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

Available options:
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
Example:
address
object
primaryMobileNumber
string | null
Maximum string length: 50
Example:

"+447798121212"

status
enum<string>
default:active
Available options:
active,
deactivated
Example:

"active"

employeeNumber
string
Maximum string length: 256
Example:

"948947464"

jobTitle
string | null
Maximum string length: 256
Example:

"Human Division Manager"

notifyEmailTrans
boolean
default:true

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

Example:

true

createdByPersonaId
string<uuid>

The creator's persona ID.

Maximum string length: 36
addToUserPool
boolean
default:true

Creates a sign-in-capable user account for this person. Only applies to products with an Equals Money-provided front-end. Set to false otherwise.

Example:

false

sendInvite
boolean
default:true

Sends an invitation email so the user can set their password and complete sign-up. Only applies to products with an Equals Money-provided front-end. Set to false otherwise.

Example:

false

emailTheme
enum<string>
Available options:
em-light,
em-dark
Example:

"em-light"

sessionId
string

The session ID.

Example:

"1234567890"

mfaCode
string
Example:

"12345"

customerIp
string

The customer's IP.

Example:

"173.21.221.46"

locale
enum<string>

Determines customer communication language. emails, notifications, etc.

Available options:
en-GB
Example:

"en-GB"

Response

201 - application/json

Created

id
string<uuid>
required
firstName
string
required
Maximum string length: 256
Example:

"Dolly"

lastName
string
required
Maximum string length: 256
Example:

"Parton"

middleInitials
string | null
required
Maximum string length: 10
Example:

"R"

dob
string | null
required
Example:

"1946-01-19"

gender
string | null
required
Maximum string length: 20
Example:

"Female"

nationality
string | null
required
deprecated
Maximum string length: 256
Example:

"US"

countryOfResidence
string | null
required
Maximum string length: 256
Example:

"US"

primaryEmailAddress
string<email>
required

The primary email address for this person.

Maximum string length: 256
Example:

"test@equalsqa.com"

status
enum<string>
required
Available options:
active,
deactivated,
kycReferred,
rejected
locale
enum<string> | null
required

Determines customer communication language. emails, notifications, etc.

Available options:
en-GB
Example:

"en-GB"

productId
string<uuid>
required

The ID of the product to work with.

Maximum string length: 36
Example:

"3ef24d53-6e22-4103-a16b-d268e4f7346d"

avatarId
string<uuid> | null
required
avatarCdnUrl
string | null
required
preferred2FAMethod
enum<string> | null
required
Available options:
whatsapp,
sms
createdAt
string<date-time>
required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt
string<date-time>
required

The date the Resource was last modified. ISO 8601 format without milliseconds.

title
enum<string> | null
Available options:
Master,
Mr,
Miss,
Mrs,
Ms,
Mx
nationalities
enum<string>[] | null

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

Available options:
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
primaryMobileNumber
string | null
Maximum string length: 50
Example:

"+447798121212"

avatar
object
sendInvite
boolean

Send the invite now

roleId
string<uuid>
verifyEmailAddress
boolean
default:true
verifyMobileNumber
boolean
default:true
sub
string | null

The Cognito ID of the person to work with.

Maximum string length: 256
Example:

"8e214819-5c83-429f-a976-eb127a0a8a88 or auth0|12345a6b7890c1def1234dg5"

hasPeopleCard
boolean

Indicates whether this person has an individual card.

card
object | null

The individual card object if the person has an individual card

emailTheme
string | null
Maximum string length: 32
persona
object
address
object | null