Member Search¶

The Member Search API enables employers and payroll software providers to efficiently search and retrieve details of employees enrolled in the YIP Scheme.

(Please see Sovereign OpenAPI documentation for detailed schema)

Searching for Employees¶

To find employees using the Employee Search API, submit a request with the desired search criteria:

GET Request URL

https://api.yip.services/v1.0/employees/{social_security_no}

The API response will be a JSON object containing the details of the employee matching the search criteria.

Example Response:

application/json

{
    "personalDetails": {
        "fullName": "Ms Lesli Hickman",
        "gender": "Female",
        "dateOfBirth": "1999-08-26",
        "countryOfBirth": "Guernsey",
        "nationality": "Guernsey"
    },
    "pensionDetails": {
        "planName": "Your Island Pension",
        "status": "Active",
        "dateJoinedPlan": "2020-04-04"
    },
    "employerDetails": {
        "employer": "Plumbing Limited",
        "startDate": "2016-06-18"
    }
}

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