Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Dependent

dependent

Returns dependent for a dependent id.<p>Scopes: export_company_info, export_payroll</p>

get/v{version}/dependents/{id}

Path parameters

idstring required
versionstring required

Response

Success

first_namestring

The Dependent's firstname.

last_namestring

The Dependent's lastname.

middle_namestring

The Dependent's middlename.

gender'Male' | 'Female' | ''

The Dependent's gender.

birth_datestring

The Dependent's birthdate.

ssnstring

The Dependent's SSN.

relationshipstring

The Dependent's relationship.

tobaccostring

The Dependent's tobacco status.

disabledstring

The Dependent is disabled.

has_diff_addressstring

Does the Dependent have a different address?

is_archivedboolean

The Dependent is archived.

deceased_datestring

The Dependent's deceased date.

idstring

The Dependent's Id.

Example response

{
  "birth_date": "yyyy-MM-dd",
  "deceased_date": "yyyy-MM-dd"
}