Update dependent information

client.dependents.update(, ?, ?): Dependent { id, active, created_at, 10 more }

put/v1/dependents/{dependent_id}

Updates an existing dependent's mutable information. Allows modification of relationship type and active status. Name, DOB, and sex cannot be modified after creation.

ParametersExpand Collapse

dependentID: string

body: DependentUpdateParams { active, gender, relationship }

active?: boolean | null

Whether the dependent is active

gender?: string | null

Gender identity

relationship?: Relationship | null

Spouse - Spouse
Child - Child

Accepts one of the following:

"Spouse"

"Child"

ReturnsExpand Collapse

Dependent { id, active, created_at, 10 more }

Serializer for Dependent entity in public API responses.

Dependents are family members (spouse, children) who may be eligible for benefit coverage through an employee.

id: string

Unique dependent identifier with 'dpnd_' prefix

active: boolean

Whether the dependent is currently active

created_at: string

Timestamp when the dependent was created

formatdate-time

date_of_birth: string

Dependent's date of birth (YYYY-MM-DD)

formatdate

first_name: string

Dependent's legal first name

last_name: string

Dependent's legal last name

member_id: string

ID of the primary member/employee (mbr_*)

relationship: Relationship

Spouse - Spouse
Child - Child

Accepts one of the following:

"Spouse"

"Child"

sex: Sex

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

"Male"

"Female"

"Other"

"Unknown"

updated_at: string

Timestamp when the dependent was last updated

formatdate-time

gender?: string | null

Gender identity, if provided

ssn_last_four?: string | null

Last 4 digits of SSN (masked)

suffix?: string | null

Name suffix (e.g., Jr., Sr., III)

Update dependent information

import VitableConnectAPI from 'vitable-connect-api';

const client = new VitableConnectAPI({
  apiKey: 'My API Key',
});

const dependent = await client.dependents.update('dpnd_abc123def456');

console.log(dependent.id);

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "date_of_birth": "2019-12-27",
  "first_name": "first_name",
  "last_name": "last_name",
  "member_id": "member_id",
  "relationship": "Spouse",
  "sex": "Male",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "gender": "gender",
  "ssn_last_four": "ssn_last_four",
  "suffix": "suffix"
}

Returns Examples

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "date_of_birth": "2019-12-27",
  "first_name": "first_name",
  "last_name": "last_name",
  "member_id": "member_id",
  "relationship": "Spouse",
  "sex": "Male",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "gender": "gender",
  "ssn_last_four": "ssn_last_four",
  "suffix": "suffix"
}