Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
People

Update a person

Updates a given person's details.

patch/people/{personId}

Path parameters

personIdstring uuid required

The ID of the person to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a04

Request body

accountIdstring

The ID of the account to work with.

firstNamestring
lastNamestring
title'Master' | 'Mr' | 'Miss' | 'Mrs' | 'Ms' | 'Mx' nullable
middleInitialsstring nullable
dobstring nullable

Date of birth

genderstring nullable
nationalitystring nullable
nationalitiesstring[]

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

countryOfResidencestring nullable
primaryMobileNumberstring nullable
emailTheme'em-light' | 'em-dark'
preferred2FAMethod'sms' | 'whatsapp' nullable
transactionalEmailPreferenceboolean nullable

Indicates whether all the associated personas have opted to receive the emails or not.

locale'en-GB'

Determines customer communication language. emails, notifications, etc.

Example request

{
  "accountId": "F50091",
  "firstName": "Dolly",
  "lastName": "Parton",
  "title": "Mrs",
  "middleInitials": "R",
  "dob": "1946-01-19",
  "gender": "Female",
  "nationality": "US",
  "nationalities": [
    "GB",
    "US"
  ],
  "countryOfResidence": "US",
  "primaryMobileNumber": "+447798121212",
  "emailTheme": "em-light",
  "preferred2FAMethod": "sms",
  "transactionalEmailPreference": true,
  "locale": "en-GB"
}

Response

OK

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"
}