Path parameters

• employer_id string Required
• employee_id string Required

Responses

• 200 application/json

  Employee retrieved successfully.

  Hide response attributes Show response attributes object

  • id string

    Unique identifier for the employee.

  • upload_id string

    ID of the file upload from which the employee was created (if applicable).

  • employer_id string

    Identifier for the employer associated with the employee.

  • external_id string | null

    Your platform's identifier for this employee, as supplied when they were enrolled. Only returned to Partner organisations that use single sign-on with Penfold; for every other caller the field is omitted entirely. null when Penfold holds no identifier for this employee, for example when they were enrolled before your platform began sending one.

  • email string(email) Required

    Email address of the employee.

  • created_at string(date-time) Required

    The date and time the employee record was created, in ISO 8601 format.

  • updated_at string(date-time) Required

    The date and time the employee record was last updated, in ISO 8601 format.

  • forename string Required

    The employee's first name.

  • surname string Required

    The employee's last name.

  • title string Required

    The employee's title, e.g., Mr., Mrs., Dr., etc.

  • date_of_birth string(date) Required

    The employee's date of birth, as a UTC calendar date in YYYY-MM-DD format.

  • address object Required

    Full UK address for an employee. When provided on PATCH, all required fields must be present — partial address updates are not supported.

    Hide address attributes Show address attributes object

    • street_number string | null

      House or building number, if applicable.

    • line1 string Required

      The first line of the employee's address.

    • line2 string | null

      The second line of the employee's address, if applicable.

    • town string | null

      Town or city.

    • county string | null

      County, if applicable.

    • postcode string Required

      The postal code of the employee's address.

    • country string Required

      ISO 3166-1 alpha-2 country code. Must be GB.

  • national_insurance_number string Required

    The employee's National Insurance number.

  • employment_start_date string(date) Required

    The date the employee started their employment, as a UTC calendar date in YYYY-MM-DD format.

  • exit_date string(date) | null Required

    The date the employee's employment ended, as a UTC calendar date in YYYY-MM-DD format (if applicable).

  • opt_out_date string(date) | null Required

    The date the employee opted out of the pension scheme, in YYYY-MM-DD format (if applicable).

  • opt_in_date string(date) | null Required

    The date the employee opted into the pension scheme, in YYYY-MM-DD format (if applicable).

  • opt_out_window_start_date string(date) Required

    The date the employee's opt out window begins. This is the same date as they were created and enrolled on the scheme.

  • opt_out_window_end_date string(date) Required

    The date the employee's opt out window ends.

  • member_scheme_status string Required

    Current scheme membership status for the worker's employment.

    Values are OptedIn, Deceased, LeftEmployment, CeasedActiveMembership, OptedOut, EmployerSchemeClosed, or IrregularContributor.

  • employee_contributions_percent number | null

    Latest elected employee contribution percentage.

    Minimum value is 0, maximum value is 100.

  • employer_contributions_percent number | null

    Latest employer contribution percentage.

    Minimum value is 0, maximum value is 100.

• 401 application/json

  Unauthorized, the request requires authentication, and the provided credentials are either missing or incorrect.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.

• 404 application/json

  Employee or employer not found, the specified employee_id or employer_id does not match any existing records.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.