Employee Alterations¶

The Employee Alterations API endpoint allows employers to modify employees details, such as changes of address and other relevant information.

(Please see Sovereign OpenAPI documentation for detailed schema)

Changing details employees¶

To modify details for employees, utilise the PATCH request with the following URL:

PATCH Request URL

https://api.yip.services/v1.0/employees

And provide the necessary JSON payload as follows:

application/json

{
  "employees": [
    {
      "socialSecurityNo": "GY333369",
      "dateOfBirth": "1978-08-31",
      "update": {
        "address": "93 Wartnaby Road",
        "city": "Acton",
        "postcode": "CW5 3NB",
        "country": "United Kingdom"
      }
    },
    {
      "socialSecurityNo": "GY338673",
      "dateOfBirth": "1968-08-31",
      "update": {
        "title": "Mr",
        "firstName": "Bob"
      }
    }
  ]
}

Last update: February 15, 2024
Created: October 11, 2023