Employee Leavers

The Employee Leavers API endpoint allows employers to declare employees have left employement or opted out of the pension scheme.

(Please see Sovereign OpenAPI documentation for detailed schema)

Scheme member leaver

To dclare an employee leaver, utilise the DELETE request with the following URL:

DELETE Request URL

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

And provide the necessary JSON payload as follows:

application/json

{
  "employees": [
    {
      "socialSecurityNo": "GY338669",
      "dateOfBirth": "1978-08-31",
      "lastName": "Bob",
      "type": "Leaver",
      "dateOfLeaving": "2023-12-26"
    }
  ]
}

---

Last update: June 28, 2024
Created: October 11, 2023