> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a person

> Updates a given person's details.



## OpenAPI

````yaml /autogenerated/openapi/cis.openapi.json patch /people/{personId}
openapi: 3.1.0
info:
  title: CIS API
  version: 2.0.0
  description: Version 2
  license:
    name: UNLICENSED
    url: https://docs.equalsmoney.com
servers:
  - url: https://api.equalsmoney.com/v2
    description: Production
  - url: https://api-sandbox.equalsmoney.com/v2
    description: Sandbox
security: []
paths:
  /people/{personId}:
    patch:
      tags:
        - People
      summary: Update a person
      description: Updates a given person's details.
      operationId: updatePerson
      parameters:
        - name: personId
          in: path
          required: true
          schema:
            description: The ID of the person to work with.
            type:
              - string
            format: uuid
            maxLength: 36
            example: 775596ae-2624-40af-a9dc-9756110a4a04
      requestBody:
        description: Body
        content:
          application/json:
            schema:
              type:
                - object
              properties:
                accountId:
                  type:
                    - string
                  description: The ID of the account to work with.
                  example: F50091
                firstName:
                  type:
                    - string
                  maxLength: 256
                  example: Dolly
                lastName:
                  type:
                    - string
                  maxLength: 256
                  example: Parton
                title:
                  type:
                    - string
                    - 'null'
                  enum:
                    - Master
                    - Mr
                    - Miss
                    - Mrs
                    - Ms
                    - Mx
                  example: Mrs
                middleInitials:
                  type:
                    - string
                    - 'null'
                  maxLength: 10
                  example: R
                dob:
                  type:
                    - string
                    - 'null'
                  description: Date of birth
                  example: '1946-01-19'
                gender:
                  type:
                    - string
                    - 'null'
                  maxLength: 20
                  example: Female
                nationality:
                  type:
                    - string
                    - 'null'
                  maxLength: 256
                  example: US
                  deprecated: true
                nationalities:
                  type:
                    - array
                  items:
                    type:
                      - string
                    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
                  description: >-
                    Array of ISO 3166-1 alpha-2 country codes representing
                    person nationalities
                  example:
                    - GB
                    - US
                countryOfResidence:
                  type:
                    - string
                    - 'null'
                  maxLength: 256
                  example: US
                primaryMobileNumber:
                  type:
                    - string
                    - 'null'
                  maxLength: 50
                  example: '+447798121212'
                emailTheme:
                  type:
                    - string
                  enum:
                    - em-light
                    - em-dark
                  example: em-light
                preferred2FAMethod:
                  type:
                    - string
                    - 'null'
                  enum:
                    - sms
                    - whatsapp
                  example: sms
                transactionalEmailPreference:
                  type:
                    - boolean
                    - 'null'
                  description: >-
                    Indicates whether all the associated personas have opted to
                    receive the emails or not.
                  example: true
                locale:
                  type:
                    - string
                  enum:
                    - en-GB
                  description: >-
                    Determines customer communication language. emails,
                    notifications, etc.
                  example: en-GB
              example:
                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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  id:
                    type:
                      - string
                    format: uuid
                  firstName:
                    type:
                      - string
                    maxLength: 256
                    example: Dolly
                  lastName:
                    type:
                      - string
                    maxLength: 256
                    example: Parton
                  title:
                    type:
                      - string
                      - 'null'
                    enum:
                      - Master
                      - Mr
                      - Miss
                      - Mrs
                      - Ms
                      - Mx
                  middleInitials:
                    type:
                      - string
                      - 'null'
                    maxLength: 10
                    example: R
                  dob:
                    type:
                      - string
                      - 'null'
                    example: '1946-01-19'
                  gender:
                    type:
                      - string
                      - 'null'
                    maxLength: 20
                    example: Female
                  nationality:
                    type:
                      - string
                      - 'null'
                    maxLength: 256
                    example: US
                    deprecated: true
                  nationalities:
                    type:
                      - array
                      - 'null'
                    items:
                      type:
                        - string
                      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
                      example: GB
                    description: >-
                      Array of ISO 3166-1 alpha-2 country codes representing
                      person nationalities
                  countryOfResidence:
                    type:
                      - string
                      - 'null'
                    maxLength: 256
                    example: US
                  primaryMobileNumber:
                    type:
                      - string
                      - 'null'
                    maxLength: 50
                    example: '+447798121212'
                  primaryEmailAddress:
                    type:
                      - string
                    format: email
                    maxLength: 256
                    description: The primary email address for this person.
                    example: test@equalsqa.com
                  avatar:
                    type:
                      - object
                    properties:
                      url:
                        type:
                          - string
                      fileName:
                        type:
                          - string
                  sendInvite:
                    type:
                      - boolean
                    description: Send the invite now
                  roleId:
                    type:
                      - string
                    format: uuid
                  verifyEmailAddress:
                    default: true
                    type:
                      - boolean
                  verifyMobileNumber:
                    default: true
                    type:
                      - boolean
                  sub:
                    type:
                      - string
                      - 'null'
                    maxLength: 256
                    description: The Cognito ID of the person to work with.
                    example: >-
                      8e214819-5c83-429f-a976-eb127a0a8a88 or
                      auth0|12345a6b7890c1def1234dg5
                  hasPeopleCard:
                    type:
                      - boolean
                    description: Indicates whether this person has an individual card.
                  card:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type:
                          - string
                        format: uuid
                        description: The id of the card
                    required:
                      - id
                    description: >-
                      The individual card object if the person has an individual
                      card
                  status:
                    type:
                      - string
                    enum:
                      - active
                      - deactivated
                      - kycReferred
                      - rejected
                  locale:
                    type:
                      - string
                      - 'null'
                    enum:
                      - en-GB
                    description: >-
                      Determines customer communication language. emails,
                      notifications, etc.
                    example: en-GB
                  productId:
                    type:
                      - string
                    format: uuid
                    maxLength: 36
                    description: The ID of the product to work with.
                    example: 3ef24d53-6e22-4103-a16b-d268e4f7346d
                  avatarId:
                    type:
                      - string
                      - 'null'
                    format: uuid
                  avatarCdnUrl:
                    type:
                      - string
                      - 'null'
                  emailTheme:
                    type:
                      - string
                      - 'null'
                    maxLength: 32
                  preferred2FAMethod:
                    type:
                      - string
                      - 'null'
                    enum:
                      - whatsapp
                      - sms
                  persona:
                    type:
                      - object
                    properties: {}
                    additionalProperties: true
                  createdAt:
                    type:
                      - string
                    format: date-time
                    description: >-
                      The date the Resource was initially created. ISO 8601
                      format without milliseconds.
                  updatedAt:
                    type:
                      - string
                    format: date-time
                    description: >-
                      The date the Resource was last modified. ISO 8601 format
                      without milliseconds.
                required:
                  - id
                  - firstName
                  - lastName
                  - middleInitials
                  - dob
                  - gender
                  - nationality
                  - countryOfResidence
                  - primaryEmailAddress
                  - status
                  - locale
                  - productId
                  - avatarId
                  - avatarCdnUrl
                  - preferred2FAMethod
                  - createdAt
                  - updatedAt
                example:
                  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'
      security:
        - CommonAuth:
            - people:update:any
components:
  securitySchemes:
    CommonAuth:
      type: apiKey
      in: header
      name: Authorization

````