Members

Create member dependent

Saves a dependent (spouse or child) for a member. Saving does not enroll the dependent or change the member's coverage or coverage tier. If the member already has an active dependent matching this person, that relationship is reused and returned with a 200 and created: false; otherwise a new one is created with a 201 and created: true. In both cases the dependent's address is set to the one supplied; other details of a person Vitable already has on file are not changed. When a new dependent is created at exactly the member's address, Vitable also adds them to the member's household where it can; this never fails the request. The returned IDs identify the saved dependent. Social Security numbers are not accepted, and a body with an ssn field returns a 400. The caller must have write access to the target member, and API access tokens cannot save dependents. A member not visible to the caller returns a 404 before the body is validated. Business-rule failures return a 422 with child_over_max_age (a child must be under 26), duplicate_active_spouse (the member already has a different active spouse), same_member, member_creation_failed, or legal_dependent_creation_failed.

post/v1/members/{member_id}/dependents

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/members/{member_id}/dependents
  • Auth: HTTP bearer

Path parameters

member_idstring required

Unique member identifier (mbr_*)

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Request body

first_namestring required

Dependent's legal first name

last_namestring required

Dependent's legal last name

suffix'Sr' | 'Jr' | 'I' | 'II' | 'III' | 'IV' | 'V'
  • Sr - Sr
  • Jr - Jr
  • I - I
  • II - II
  • III - III
  • IV - IV
  • V - V
date_of_birthstring date required

Date of birth (YYYY-MM-DD); cannot be in the future

sex_at_birth'Male' | 'Female' | 'Other' | 'Unknown'
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
gender'Male' | 'Female' | 'Transgender' | 'Non-binary' | 'Prefer not to respond'
  • Male - Male
  • Female - Female
  • Transgender - Transgender
  • Non-binary - Non-binary
  • Prefer not to respond - Prefer not to respond
emailstring nullable

Dependent's email address. Ignored for dependents under 18, and not changed for a dependent Vitable already has on file.

phonestring nullable

Dependent's 10-digit US phone number; formatting characters and a leading 1 are ignored. Ignored for dependents under 18, and not changed for a dependent Vitable already has on file.

relationship'Spouse' | 'Child' required
  • Spouse - Spouse
  • Child - Child

Response

The member already had this dependent; the existing relationship was returned.

Changes

No recorded changes to this operation across all 1 revision of this API.