Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
People

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.

post/people

Request body

accountIdstring required

The ID of the account to work with.

firstNamestring required
lastNamestring required
roleName'Owner' | 'Admin' | 'Payer' | 'Viewer' | 'Accountant' | 'User' required
emailAddressstring email required
dobstring nullable

Date of birth

nationalitiesstring[] nullable

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

primaryMobileNumberstring nullable
status'active' | 'deactivated'
employeeNumberstring
jobTitlestring nullable
notifyEmailTransboolean

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

createdByPersonaIdstring uuid

The creator's persona ID.

addToUserPoolboolean

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.

sendInviteboolean

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.

emailTheme'em-light' | 'em-dark'
sessionIdstring

The session ID.

mfaCodestring
customerIpstring

The customer's IP.

locale'en-GB'

Determines customer communication language. emails, notifications, etc.

Example request

{
  "accountId": "F50091",
  "firstName": "Dolly",
  "lastName": "Parton",
  "roleName": "Owner",
  "emailAddress": "sally.smith@example.com",
  "dob": "1946-01-19",
  "nationalities": [
    "GB",
    "US"
  ],
  "address": {
    "streetName": "Great Building",
    "buildingNumber": "10",
    "buildingName": "Greater Building",
    "postcode": "SE13UB",
    "city": "My Town",
    "region": "Greater London",
    "countryCode": "GB"
  },
  "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",
  "locale": "en-GB"
}

Response

Created

idstring uuid required
firstNamestring required
lastNamestring required
title'Master' | 'Mr' | 'Miss' | 'Mrs' | 'Ms' | 'Mx' nullable
middleInitialsstring nullable required
dobstring nullable required
genderstring nullable required
nationalitystring nullable required
nationalitiesstring[] nullable

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

countryOfResidencestring nullable required
primaryMobileNumberstring nullable
primaryEmailAddressstring email required

The primary email address for this person.

sendInviteboolean

Send the invite now

roleIdstring uuid
verifyEmailAddressboolean
verifyMobileNumberboolean
substring nullable

The Cognito ID of the person to work with.

hasPeopleCardboolean

Indicates whether this person has an individual card.

status'active' | 'deactivated' | 'kycReferred' | 'rejected' required
locale'en-GB' nullable required

Determines customer communication language. emails, notifications, etc.

productIdstring uuid required

The ID of the product to work with.

avatarIdstring uuid nullable required
avatarCdnUrlstring nullable required
emailThemestring nullable
preferred2FAMethod'whatsapp' | 'sms' nullable required
personaobject
createdAtstring date-time required

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

updatedAtstring date-time required

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

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "firstName": "Dolly",
  "lastName": "Parton",
  "title": "Master",
  "middleInitials": "R",
  "dob": "1946-01-19",
  "gender": "Female",
  "nationality": "US",
  "nationalities": [
    "GB"
  ],
  "countryOfResidence": "US",
  "primaryMobileNumber": "+447798121212",
  "primaryEmailAddress": "test@equalsqa.com",
  "avatar": {
    "url": "string",
    "fileName": "string"
  },
  "sendInvite": true,
  "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  "verifyEmailAddress": true,
  "verifyMobileNumber": true,
  "sub": "8e214819-5c83-429f-a976-eb127a0a8a88 or auth0|12345a6b7890c1def1234dg5",
  "hasPeopleCard": true,
  "card": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "status": "active",
  "locale": "en-GB",
  "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
  "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",
  "avatarCdnUrl": "string",
  "emailTheme": "string",
  "preferred2FAMethod": "whatsapp",
  "persona": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
    "streetName": "Great Building",
    "buildingNumber": "10",
    "buildingName": "Greater Building",
    "postcode": "SE13UB",
    "city": "My Town",
    "region": "Greater London",
    "countryCode": "GB"
  }
}