Dependents

Detailed mapping of the fields used in a POST request to create a dependent. The schema below is used in creating:

• a dependent via a POST request to subscribers/{id}/dependents

• a dependent in the dependents array, in a POST request to groups/{id}/subscribers

Required Elements

These fields are Required to create a dependent. The same fields are required when:

• a dependent is created in a POST request to subscribers/{id}/dependents

• a dependent is created in the dependents array, in a POST request to groups/{id}/subscribers

Ideon	Usage and Mapping
*external_identifier	This is an identifier that your system can use or generate to identify the dependent. This is in addition to our id that we generate upon creation.
*birth_date	This field contains the date of birth for the dependent
*first_name	This is the legal first name of the dependent.
*last_name	This is the legal last name of the dependent.
*gender	This is a value representing the member's gender. Accepted values in the API are: female male non_binary unknown Ideon transmits unknown and non_binary as female when carriers only accept Binary values, per carrier instruction. For carriers with no specific non-binary value, we map non_binary to unknown if accepted.
*subscriber_relationship	This value defines the dependent's relationship with the subscriber, and thus what "type" of dependent they are. Accepted values are: child, grandchild, registered_domestic_partner, spouse, court_ordered_dependent

Conditionally Required

While the elements above are required, there are additional common elements that your system will likely always have available.

We ask you provide these common values if available, as these can be required by Carriers on their data transmissions.

These elements are Recommended

Ideon	Usage and Mapping
handicapped	Does the member have a disability? / Is the member disabled? This is required by some carriers when a child dependent ages-out but is still eligible for coverage due to disability status. Accepted values: true, false
tobacco_use	This value shows whether a member is a current tobacco user for the purposes of plan eligibility. This is often required for Medical plans and Critical Illness plans that are "tobacco-rated". If present, it's helpful to provide across members, unless you only sell/enroll in "uni-smoker" rated products.
middle_name	This is the legal middle name of the dependent. It is best to include this information if accurate and present in your system.
mailing_address	This is the address at which the member receives mailed communications. If this mailing address differs from the residential, it is essential to provide it. However, Mailing Address can always be provided, as Ideon's system will determine for which carriers it should be transmitted. Required address_line_1 city zip Recommended if present address_line_2 state fips_county_code country_code Note: Ideon currently only supports domestic addresses for enrollments, the country code can be defaulted to USA (as it will be if not provided)
residential_address	This is the address at which the member resides, their "home" address value. Required address_line_1 city zip Recommended if present address_line_2 state fips_county_code country_code Note: Ideon currently only supports domestic addresses for enrollments, the country code can be defaulted to USA (as it will be if not provided)
social_security_number	This a field that captures data for the dependent's social security number If the SSN is accurate and unique per member, please include this information. We can then send to carriers that prefer this information and omit from others' transmissions.

Optional Elements

Ideon	Usage and Mapping
citizenship_status	What citizenship status is the dependent? Accepted values: alien, alien_non_resident, alien_resident, illegal_alien, us_citizen, us_citizen_non_resident, us_citizen_resident
languages	This is an array to represent one or more languages spoken by the member, which could be used to drive communication preferences. Each entry in the array contains language - a text field for each language, a language_proficiency reading, writing, speaking, native_language
medicare	This object captures information related to Medicare coverage and eligibility. Accepted values medicare_beneficiary_identifier eligibility eligibility_start_date enrolled coverages
height	This is a height value for the member, expressed in inches. This field takes an integer value - i.e. 60
weight	This is a height value for the member, expressed in pounds (lb). This field takes an integer value - i.e. 175
name_prefix	This is a string field to express a prefix, such as Mr, Dr, etc
name_suffix	This is a string field to express a suffix, such as Jr or Sr
race_ethnicity	This is a field to express the member's race and ethnicity value. Accepted values: not_provided, not_applicable, asian_or_pacific_islander, black, caucasian, subcontinent_asian_american, other_race_or_ethnicity, asian_pacific_american, native_american, hispanic, american_indian_or_alaskan_native, native_hawaiian, black_non-hispanic, white_non_hispanic, pacific_islander
emails	This field allows a platform to send email addresses for a given member. These are associated with a type - personal, work, other - and are useful for member communications. Validation pattern: ^.@.$ Example: [e-mail]
phone_numbers	This field allows a platform to send email addresses for a given member. These are associated with a type - personal, work, other - and are useful for member communications. Validation: minLength: 10 maxLength: 15 Example: 12223334444
substance_abuse	Does the member have a history of substance abuse as relevant to their eligibility? Accepted values: true, false
schools	Thie fields allows a student to enumerate school and educational institutions with which they are affiliated schools can have the elements: emails phone_numbers address name* - Required
student_status	This expresses whether a dependent is a student. Accepted values: full_time, not_a_student, part_time

See Additional Documentation for links to our current API documentation.