--- title: "Create a person" method: POST path: "/people" tags: ["People"] --- # Create a person `POST /people` 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. ## Request body - object - `accountId` string, required — The ID of the account to work with. - `firstName` string, required - `lastName` string, required - `roleName` 'Owner' | 'Admin' | 'Payer' | 'Viewer' | 'Accountant' | 'User', required - `emailAddress` string, email, required - `dob` string, nullable — Date of birth - `nationalities` string[], nullable — Array of ISO 3166-1 alpha-2 country codes representing person nationalities - `address` object - `streetName` string, nullable, required — The street name of the person's address. - `buildingNumber` string, nullable, required — The building number of the person's address. - `buildingName` string, nullable, required — The building name of the person's address. - `postcode` string, nullable, required — The postal or ZIP code of the person's address. - `city` string, nullable, required — The town or city of the person's address. - `region` string, nullable, required — The region of the person's address. - `countryCode` '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', nullable, required — The country code of the person's address. - `primaryMobileNumber` string, nullable - `status` 'active' | 'deactivated' - `employeeNumber` string - `jobTitle` string, nullable - `notifyEmailTrans` boolean — Indicates whether this persona has opted to receive the emails or not. - `createdByPersonaId` string, uuid — The creator's persona ID. - `addToUserPool` boolean — 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. - `sendInvite` boolean — 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' - `sessionId` string — The session ID. - `mfaCode` string - `customerIp` string — The customer's IP. - `locale` 'en-GB' — Determines customer communication language. emails, notifications, etc. ## Response `201` Created - object - `id` string, uuid, required - `firstName` string, required - `lastName` string, required - `title` 'Master' | 'Mr' | 'Miss' | 'Mrs' | 'Ms' | 'Mx', nullable - `middleInitials` string, nullable, required - `dob` string, nullable, required - `gender` string, nullable, required - `nationality` string, nullable, required - `nationalities` string[], nullable — Array of ISO 3166-1 alpha-2 country codes representing person nationalities - `countryOfResidence` string, nullable, required - `primaryMobileNumber` string, nullable - `primaryEmailAddress` string, email, required — The primary email address for this person. - `avatar` object - `url` string - `fileName` string - `sendInvite` boolean — Send the invite now - `roleId` string, uuid - `verifyEmailAddress` boolean - `verifyMobileNumber` boolean - `sub` string, nullable — The Cognito ID of the person to work with. - `hasPeopleCard` boolean — Indicates whether this person has an individual card. - `card` object, nullable — The individual card object if the person has an individual card - `id` string, uuid, required — The id of the card - `status` 'active' | 'deactivated' | 'kycReferred' | 'rejected', required - `locale` 'en-GB', nullable, required — Determines customer communication language. emails, notifications, etc. - `productId` string, uuid, required — The ID of the product to work with. - `avatarId` string, uuid, nullable, required - `avatarCdnUrl` string, nullable, required - `emailTheme` string, nullable - `preferred2FAMethod` 'whatsapp' | 'sms', nullable, required - `persona` object - `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. - `address` object, nullable - `id` string, uuid, required - `personId` string, uuid — The ID of the person to work with. - `streetName` string, nullable, required — The street name of the person's address. - `buildingNumber` string, nullable, required — The building number of the person's address. - `buildingName` string, nullable, required — The building name of the person's address. - `postcode` string, nullable, required — The postal or ZIP code of the person's address. - `city` string, nullable, required — The town or city of the person's address. - `region` string, nullable, required — The region of the person's address. - `countryCode` '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', nullable, required — The country code of the person's address. --- [API](https://skmtc.net/equalsmoney/apis/cis-api.md) · [All operations](https://skmtc.net/equalsmoney/apis/cis-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/equalsmoney/cis-api/revisions/a162c72b8bf6/schema)