Get Employee Dependent

Returns the details of a single employee dependent by their dependent ID. The response is a JSON object with a top-level key "Employee Dependents" containing a single-element array. SSN and SIN are returned as masked values (e.g. "xxx-xx-1234"). State and country are returned as full names. Supports both JSON and XML response formats via the Accept header. Requires Benefits Administration permissions.

OAuth Scopes: employee:dependent, employee:dependent:ssn

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Response

{
  "Employee Dependents": [
    {
      "id": "1",
      "employeeId": "40341",
      "firstName": "Cheryl",
      "middleName": "Anne",
      "lastName": "Linetti",
      "relationship": "spouse",
      "gender": "female",
      "maskedSSN": "xxx-xx-1122",
      "maskedSIN": null,
      "dateOfBirth": "1972-04-23",
      "addressLine1": "11437 W Schoolhouse Lane",
      "addressLine2": null,
      "city": "Cedar Hills",
      "state": "Utah",
      "zipCode": "84062",
      "homePhone": null,
      "country": "United States",
      "isUsCitizen": "yes",
      "isStudent": ""
    }
  ]
}
<EmployeeDependents>
    <EmployeeDependent id="1" employeeId="40341" firstName="Sheryl" middleName="Lynn" lastName="Binetti" relationship="spouse" gender="female" maskedSSN="xxx-xx-1122" maskedSIN="" dateOfBirth="1966-12-09" addressLine1="4015 W Centennial St" addressLine2="" city="Cedar Hills" state="Utah" zipCode="84062" homePhone="" country="United States" isUsCitizen="yes" isStudent=""/>
</EmployeeDependents>
Path Params
integer
required

The numeric ID of the employee dependent to retrieve.

Headers
string
enum

This endpoint can produce either JSON or XML.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The specified dependent ID was not found.

403

The authenticated user does not have Benefits Administration permissions.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json