Get dependent details

dependents.retrieve(dependent_id) -> Dependent { id, active, created_at, 10 more }

get/v1/dependents/{dependent_id}

Retrieves detailed information for a specific dependent by ID. Returns dependent profile including name, date of birth, and relationship type.

ParametersExpand Collapse

dependent_id: String

ReturnsExpand Collapse

class 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: bool

Whether the dependent is currently active

created_at: Time

Timestamp when the dependent was created

formatdate-time

date_of_birth: Date

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: Time

Timestamp when the dependent was last updated

formatdate-time

gender: String

Gender identity, if provided

ssn_last_four: String

Last 4 digits of SSN (masked)

suffix: String

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

Get dependent details

require "vitable_connect_api"

vitable_connect_api = VitableConnectAPI::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

dependent = vitable_connect_api.dependents.retrieve("dpnd_abc123def456")

puts(dependent)

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