Create a Dependent

post

https://integrate.nayya.com/accounts/employers/{employerId}/employees/{employeeId}/dependents

Path Params

employerId

string

required

The unique ID from Nayya or your unique ID prefixed with the external: indicator that represents an employer (e.g. external:3438yht-hg8ht39-h23uh9th-uewht0o).

employeeId

string

required

The unique ID from Nayya or your unique ID prefixed with the external: indicator that represents an employee (e.g. external:3438yht-hg8ht39-h23uh9th-uewht0o).

Body Params

relationship

string

enum

required

Dependent's Relationship to the employee

Allowed:

string

Dependent email

ssn

string

9 digit SSN

firstName

string

Dependent first name

lastName

string

Dependent last name

gender

string

enum

Dependent gender

Allowed:

dateOfBirth

date

required

Dependent date of birth

streetAddress

string

Dependent street address

city

string

Dependent city

state

string

Dependent state

zipCode

string

Dependent zip code

phoneNumber

string

Dependent phone number

incomeAmountCents

number

Dependent income amount in cents

incomeType

string

enum

Dependent income type

Allowed:

hoursPerWeek

number

Dependent hours worked per week

tobaccoUsage

boolean

Dependent tobacco usage

dependentStatus

boolean

Defaults to true

Status indicating whether the dependent should be included in the employee's benefit recommendations.

externalId

string

external id of the partner employee dependent

employmentStatus

string

enum

Dependent employment status

Allowed:

Headers

X-API-Version

string

Defaults to 1

Optional API major version. Omit this header for the same behavior as 1 (this specification).

Responses

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

201Created