Person

  • dateOfBirth
    Type: string | nullFormat: date
    required

    Person's date of birth, or null when it has not been supplied.

  • email
    Type: string | nullFormat: email
    required

    Employer-confirmed email address, or null when it has not been supplied.

  • forename1
    Type: string
    required

    Person's first forename.

  • forename2
    Type: string | null
    required

    Person's second forename, or null when they do not have one.

  • gender
    Type: "female" or "male" or nullenum
    required

    Employee's current gender as required for HMRC reporting.

  • homeAddress
    Type: objectnullable
    required

    Person's home address, or null when it has not been supplied.

    Properties: 6
  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit Person ID.

  • nationalInsuranceNumber
    Type: string | null
    required

    Employee's National Insurance number, or null when it is not known.

  • partnerPersonId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    Immutable Person ID from the Partner's product.

  • surname
    Type: string
    required

    Person's surname.

  • title
    Type: string | nullenum
    required

    Person's title, or null when they have not given one.

    values
    • mr
    • mrs
    • ms
    • miss
    • dr
    • lord
    • lady
    • sir