Employee Leavers¶

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

(Please see Sovereign OpenAPI documentation for detailed schema)

Scheme member leaver¶

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

DELETE Request URL

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

Set type to Leaver when the employee has left employment, or Opt-Out when they remain employed but have chosen to leave the pension scheme. Each employee is matched on their socialSecurityNo, dateOfBirth and lastName. Provide the necessary JSON payload as follows:

application/json

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

A successful request returns the number of employees processed and their social security numbers:

application/json

{
  "success": true,
  "numLeavers": 1,
  "membersLeavers": [
    "GY338669"
  ]
}

Validate before committing

Append ?validate=true to the request URL to check your payload without changing any records. The response is the same as a live request but includes "isValidate": true, and nothing is saved.

Last update: July 30, 2026
Created: February 11, 2025