Get Dependent

Authorizations

Authorization

string

header

required

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

Path Parameters

dependent_id

string<uuid>

required

The unique identifier of the dependent you would like to view

Example:

"fd62665c-0846-4e9d-bd29-80779b5f685c"

Response

200 - application/json

Successful Response - Returns a single Dependent

created

integer

required

The date the record was originated

employee_id

string<uuid>

required

Unique identifier of the employee in Noyo

string<uuid>

required

Unique identifier of the dependent in Noyo

modified

integer

required

The date the record was last updated

person

object

required

Personal information for the dependent

Show child attributes

person.date_of_birth

string<date>

required

ISO-8601 date string for the date of birth of the person

Example:

"1977-06-03"

person.first_name

string

required

First name of the person

Example:

"Catherine"

person.home_address

object

required

Home address of the person

Show child attributes

person.home_address.city

string

required

City of the address

Example:

"Bend"

person.home_address.state

enum<string>

required

State postal code of the address

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AS,

GU,

MH,

FM,

MP,

PW,

PR,

VI,

UM

Example:

"OR"

person.home_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

person.home_address.zip_code

string

required

Zip code of the address

Example:

"97701"

person.home_address.county

string

County of the address

Example:

"Deschutes"

person.home_address.street_two

string

Line two of the address

Example:

"Apartment 5"

person.last_name

string

required

Last name of the person

Example:

"Briggs"

person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

Example:

"F"

person.contact

object

Contact information for the person

Show child attributes

person.contact.email_address

string<email>

Email address of the person

Example:

"[email protected]"

person.contact.email_address_type

enum<string>

Type of email address

Available options:

home,

work

Example:

"home"

person.contact.home_phone

string

Home phone number in E.164 format

Example:

"+15555551212"

person.contact.preferred_language

string

Preferred written or spoken language of the person

Example:

"Engish"

person.contact.preferred_method

enum<string>

Preferred method of contact for the person

Available options:

mail,

email,

home-phone,

work-phone,

other

Example:

"email"

person.contact.speaks_english

boolean

True if the person can speak or communicate in English

Example:

true

person.contact.work_phone

string

Work phone number in E.164 format

Example:

"+15555551212"

person.details

object

Additional personal details of the person

Show child attributes

person.details.american_indian

object

American Indian status details (if applicable)

Show child attributes

person.details.american_indian.state

enum<string>

Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AS,

GU,

MH,

FM,

MP,

PW,

PR,

VI,

UM

person.details.american_indian.tribe

string

Name of the federally-recognized American Indian or Alaska Native tribe, if applicable

Example:

"Ojibwe"

person.details.disability

object

Disability details (if applicable)

Show child attributes

person.details.disability.communication

boolean

True if the disability impacts the ability to communicate or read

person.details.disability.disabled

boolean

True if the member has a disability

person.details.disability.reason

string

Description of the disability

person.details.is_military

boolean

True if the person is in the military

person.details.is_student

boolean

True if the person is a student

person.details.tobacco

object

Tobacco usage details (if applicable)

Show child attributes

person.details.tobacco.duration

string

Duration of tobacco use

Example:

"5 years"

person.details.tobacco.frequency

string

Frequency of tobacco use

Example:

"Daily"

person.details.tobacco.types

enum<string>[]

List of types of tobacco use

Minimum array length: 1

Available options:

pipe,

cigarettes,

chewing-tobacco

Example:

"cigarettes"

person.details.tobacco.user

boolean

True if the person uses tobacco of any kind

Example:

true

person.maiden_name

string

Maiden name of the person (deprecated)

person.mailing_address

object

Mailing address of the person, if different from home address

Show child attributes

person.mailing_address.city

string

required

City of the address

Example:

"Bend"

person.mailing_address.state

enum<string>

required

State postal code of the address

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AS,

GU,

MH,

FM,

MP,

PW,

PR,

VI,

UM

Example:

"OR"

person.mailing_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

person.mailing_address.zip_code

string

required

Zip code of the address

Example:

"97701"

person.mailing_address.county

string

County of the address

Example:

"Deschutes"

person.mailing_address.street_two

string

Line two of the address

Example:

"Apartment 5"

person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

Example:

"married"

person.middle_name

string

Middle name of the person

Example:

"S"

person.ssn

string | null

Social Security Number of the person

Example:

"123456789"

person.suffix

string

Suffix of the person

relationship

enum<string>

required

Relationship of the dependent to the employee

Available options:

spouse,

child,

domestic-partner,

grandchild,

civil-union,

step-child,

foster-child,

adopted-child,

legal-guardianship,

ex-spouse,

other

version

string<uuid>

required

Version of the dependent record

custom_individual_id

string

The custom identifier for this dependent in your system

Groups

Members

Changes

Legacy

Authorizations

Path Parameters

Response