GET
/
api
/
hris
/
v1
/
dependents
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default: false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

200 - application/json
id
string
required
remote_id
string | null
required

The third-party API ID of the matching object.

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

employee
any | null
required

The employee holding this position.

home_location
object | null
required

The employee's home address.

first_name
string | null
required

The dependent's first name

middle_name
string | null
required

The dependent's middle name

last_name
string | null
required

The dependent's last name

relationship
string | null
required

The dependent's relationship with this employee

date_of_birth
string | null
required

The dependent's date of birth

gender
string | null
required

The dependent's gender

phone_number
string | null
required

The dependent's phone number

ssn
string | null
required

The dependent's SSN

raw_data
object | null

This is the Raw data