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

Add new dependent

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.

Path ParametersExpand Collapse
member_id: string
Body ParametersExpand Collapse
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: optional string

Gender identity

ssn: optional string

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

maxLength11
minLength9
suffix: optional string

Name suffix (Jr., Sr., III)

maxLength10
ReturnsExpand Collapse
Dependent = object { 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: optional string

Gender identity, if provided

ssn_last_four: optional string

Last 4 digits of SSN (masked)

suffix: optional string

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

Add new dependent
curl https://api.vitablehealth.com/v1/members/$MEMBER_ID/dependents \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $VITABLE_connect_API_API_KEY" \
    -d '{
          "date_of_birth": "2019-12-27",
          "first_name": "x",
          "last_name": "x",
          "relationship": "Spouse",
          "sex": "Male"
        }'
{
  "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"
}