Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Members
Dependents

Add new dependent

client.members.dependents.create(stringmemberID, DependentCreateParams { date_of_birth, first_name, last_name, 5 more } body, RequestOptionsoptions?): Dependent { id, active, created_at, 10 more }
post/v1/members/{member_id}/dependents

Creates a new dependent record for a member. Required: first name, last name, date of birth, sex, and relationship type. SSN is optional but recommended for coverage verification.

ParametersExpand Collapse
memberID: string
body: DependentCreateParams { date_of_birth, first_name, last_name, 5 more }
date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate
first_name: string

Dependent's legal first name

maxLength100
minLength1
last_name: string

Dependent's legal last name

maxLength100
minLength1
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"
gender?: string | null

Gender identity

ssn?: string | null

Social Security Number (optional, XXX-XX-XXXX or XXXXXXXXX)

maxLength11
minLength9
suffix?: string | null

Name suffix (Jr., Sr., III)

maxLength10
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)

Add new dependent
import VitableConnectAPI from 'vitable-connect-api';

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

const dependent = await client.members.dependents.create('mbr_abc123def456', {
  date_of_birth: '2019-12-27',
  first_name: 'x',
  last_name: 'x',
  relationship: 'Spouse',
  sex: 'Male',
});

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"
}