Enrollments
API Endpoint
https://enrollments.ideonapi.com
Getting Started
Signing Up
Reach out to [email protected] to inquire about signing up.
Authentication
To authenticate, pass the API Key as Vericred-Api-Key in the headers of calls.
curl -H 'Vericred-Api-Key: YOUR_KEY' "https://enrollments.ideonapi.com/groups"
Optionally, Ideon supports token-based authentication with expiring tokens. To make use of this feature, you can use the Auth Token endpoint.
Pagination
Endpoints that accept page and per_page parameters are paginated. They expose four additional fields that contain data about your position in the response, namely Total, Per-Page,
Link, and Page as described in RFC-5988.
For example, to display 5 results per page and view the second page of a
GET to /groups, your final request would be GET /groups?....page=2&per_page=5.
Status Codes
Ideon uses HTTP codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error given the request and/or credentials provided. Codes in the 5xx range indicate an error with Ideon’s servers.
| HTTP Code | Description |
|---|---|
| 200 | The request was successful. |
| 201 | The request was successful and a resource was created. |
| 204 | The request was successful and no content is returned. |
| 401 | The API request requires user authentication. Refer to our Authentication section above. |
| 403 | The API key doesn’t have permissions to perform the request. |
| 404 | The resource was not found. |
| 405 | The HTTP Method is not allowed. Are you doing a GET when it’s a POST? |
| 422 | There is something invalid or missing in the request body. |
| 429 | Too many requests hit the API too quickly. |
| 500 | The Ideon server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | The Ideon server timed out when processing the request. |
Environments
There are three environments that can be used: Staging, QA, and Production.
| Environment | PII/PHI? | Data Delivered to Carriers? | Base URL |
|---|---|---|---|
| Production | Yes | Yes | https://enrollments.ideonapi.com |
| QA | Yes | No | https://enrollments.qa.ideonapi.com |
| Staging | No | No | https://enrollments.staging.ideonapi.com |
Integrating
Ideon has designed the Enrollments API Platform with you in mind. There are several different ways Enrollment information can be transmitted to Ideon: directly connecting to the API or transmitting files in any of the many supported flat file formats.
Carrier Group Installment
Ideon makes installing groups with insurance for the first time with a carrier simple. Using the API, you can pass the information to Ideon in a standard format and Ideon will send the application information to the carrier for enrollment.
A walkthrough is available here.
Member Management
Ideon’s Enrollment API takes the complexity out of managing member enrollment for in-force groups, or groups with insurance in place with carriers. Similar to Carrier Group Installment, you can pass the information to Ideon in a standard format and Ideon will deliver the details to each carrier in the format(s) they require. Ideon will handle account structure configuration/mapping, standardize reconciliation reports, and Open Enrollment periods and Blackout periods.
A walkthrough of Member Management available here.
Details on the added features Ideon provides can be found here.
Authentication
This API uses Custom Header for its authentication.
The parameters that are needed to be sent for this type of authentication are as follows:
Vericred-Api-Key
Authentication ¶
Auth Token ¶
POST /auth/token
Responses
Token Generated
Headers
Content-Type: application/jsonBody
{
"token": "eyJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50X2lkIjoxMSwiZXhwIjoxNjUxMTYwNjU5fQ.tc_ltWQOh7Gyz2Rd_Qd831fHIb6LSQvKFK9QJfzHyuU",
"expires_at": "2022-04-28T15:44:19.000Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "A JWT for authentication"
},
"expires_at": {
"type": "string",
"description": "The expiry date-time for the token"
}
},
"required": [
"token",
"expires_at"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a TokenPOST/auth/token
While not required, Ideon can support token-based authentication. This endpoint can be used to create a short-lived token to be passed in the optional
Authorization: Bearer YOUR_TOKEN header.
Groups ¶
Groups ¶
POST /groups
Requests
Headers
Content-Type: <<Add Header Value>>Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"group": {
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"general_agency": {
"name": "House Mormont",
"representative": {
"last_name": "Mormont",
"first_name": "Maege"
},
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"group_setup": {
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
}
},
"producer_agency": {
"name": "Stark Industries",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"employer": {
"organization_name": "ABCD Co",
"standard_industrial_classification_code": "8011",
"fein": "222222222",
"established_date": "2010-01-01",
"employer_type": "private_sector",
"census": {
"employees": 25,
"full_time_equivalent_employees": 20,
"eligible_employees": 18
},
"member_of_association": false,
"leave_of_absence_medical_coverage_months": "three",
"leave_of_absence_personal_coverage_months": "three",
"wage_frequency": "weekly",
"current_coverages": [
{
"product_line": "medical",
"coverage_end_date": "2022-01-01",
"carrier_name": "cigna",
"policy_number": "ABC12345"
}
]
},
"primary_location": {
"type": "physical",
"external_identifier": "ABC-132A54",
"employer_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"billing_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"benefit_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
},
"secondary_locations": [],
"producers_of_record": [
{
"first_name": "Arya",
"last_name": "Stark",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"commission_split": 100,
"signature_date": "",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"general_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the general agency"
},
"representative": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"description": "The last name of a representative for the general agency"
},
"first_name": {
"type": "string",
"description": "The first name of a representative for the general agency"
}
},
"required": [
"last_name"
]
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the general agency"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The general agency associated with the group"
},
"group_setup": {
"type": "object",
"properties": {
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
}
}
},
"producer_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The agency the producer represents"
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the producer"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The producer agency associated with the writing agents of the group"
},
"employer": {
"type": "object",
"properties": {
"organization_name": {
"type": "string",
"description": "The employer's legal name"
},
"standard_industrial_classification_code": {
"type": "string",
"description": "The Standard Industrial Classification (SIC) code for the employer's business"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"established_date": {
"type": "string",
"description": "The date on which the company was founded and began operations"
},
"employer_type": {
"type": "string",
"enum": [
"private_sector",
"tribal_government",
"religious_employer",
"state_government",
"foreign_government",
"corporation",
"s_corporation",
"partnership",
"proprietorship",
"limited_liability_company",
"limited_partnership",
"limited_liability_partnership",
"other"
],
"description": "The type of the employer"
},
"census": {
"type": "object",
"properties": {
"employees": {
"type": "number",
"description": "The total number of persons employed by the employer as defined by a carrier's underwriting guidelines"
},
"full_time_equivalent_employees": {
"type": "number",
"description": "The total number of full time equivalent employees as defined by a carrier's underwriting guidelines"
},
"eligible_employees": {
"type": "number",
"description": "The total number of eligible employees as defined by a carrier's underwriting guidelines"
}
},
"required": [
"employees",
"full_time_equivalent_employees",
"eligible_employees"
]
},
"member_of_association": {
"type": "boolean",
"description": "Is this employer a member of an association?"
},
"subject_to_family_medical_leave_act": {
"type": "boolean"
},
"leave_of_absence_medical_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"leave_of_absence_personal_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to employees"
},
"hours_required_for_eligibility": {
"type": "number",
"description": "The number of weekly work hours required for insurance eligibility"
},
"employed_20_or_more_for_half_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least half of the previous year?"
},
"employed_20_or_more_for_twenty_weeks_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least twenty weeks of the previous year?"
},
"current_coverages": {
"type": "array",
"description": "List of coverage information for plans the group currently has"
}
},
"required": [
"organization_name",
"fein"
],
"description": "The employer enrolling a group"
},
"primary_location": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"employer_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"billing_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the billing administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the billing administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for billing"
},
"benefit_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the benefit administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the benefit administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for benefit administration"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"type",
"external_identifier",
"employer_address",
"id"
]
},
"secondary_locations": {
"type": "array"
},
"producers_of_record": {
"type": "array",
"description": "The producers associated with the group"
}
},
"required": [
"external_identifier",
"id",
"employer",
"primary_location",
"secondary_locations",
"producers_of_record"
],
"description": "The group associated with the enrollment request"
}
},
"required": [
"group"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a GroupPOST/groups
The Group is a representation of the company and locations. In the response, you will receive an identifier for the Group and each Location, to be used in subsequent API calls.
Groups ¶
GET /groups?page=1&per_page=100
Responses
Groups Request Received
Headers
Content-Type: application/jsonBody
[
{
"group": {
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"general_agency": {
"name": "House Mormont",
"representative": {
"last_name": "Mormont",
"first_name": "Maege"
},
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"group_setup": {
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
}
},
"producer_agency": {
"name": "Stark Industries",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"employer": {
"organization_name": "ABCD Co",
"standard_industrial_classification_code": "8011",
"fein": "222222222",
"established_date": "2010-01-01",
"employer_type": "private_sector",
"census": {
"employees": 25,
"full_time_equivalent_employees": 20,
"eligible_employees": 18
},
"member_of_association": false,
"leave_of_absence_medical_coverage_months": "three",
"leave_of_absence_personal_coverage_months": "three",
"wage_frequency": "weekly",
"current_coverages": [
{
"product_line": "medical",
"coverage_end_date": "2022-01-01",
"carrier_name": "cigna",
"policy_number": "ABC12345"
}
]
},
"primary_location": {
"type": "physical",
"external_identifier": "ABC-132A54",
"employer_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"billing_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"benefit_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
},
"secondary_locations": [],
"producers_of_record": [
{
"first_name": "Arya",
"last_name": "Stark",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"commission_split": 100,
"signature_date": "",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
}
]
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List GroupsGET/groups{?page,per_page}
This endpoint can be used to pull down all Groups under your account. The endpoint is paginated, so please use the page and per_page parameters to navigate. For more information on pagination, please review
the Pagination section.
URI Parameters
- page
number(optional) Example: 1The page number
- per_page
number(optional) Example: 100The resources returned per page
Groups By Id ¶
GET /groups/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"status": "pending",
"group": {
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"general_agency": {
"name": "House Mormont",
"representative": {
"last_name": "Mormont",
"first_name": "Maege"
},
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"group_setup": {
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
}
},
"producer_agency": {
"name": "Stark Industries",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"employer": {
"organization_name": "ABCD Co",
"standard_industrial_classification_code": "8011",
"fein": "222222222",
"established_date": "2010-01-01",
"employer_type": "private_sector",
"census": {
"employees": 25,
"full_time_equivalent_employees": 20,
"eligible_employees": 18
},
"member_of_association": false,
"leave_of_absence_medical_coverage_months": "three",
"leave_of_absence_personal_coverage_months": "three",
"wage_frequency": "weekly",
"current_coverages": [
{
"product_line": "medical",
"coverage_end_date": "2022-01-01",
"carrier_name": "cigna",
"policy_number": "ABC12345"
}
]
},
"primary_location": {
"external_identifier": "ABC-132A54",
"employer_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"billing_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"benefit_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
},
"secondary_locations": [],
"producers_of_record": [
{
"first_name": "Arya",
"last_name": "Stark",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"commission_split": 100,
"signature_date": "",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
}
],
"coverage_periods": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"external_identifier": "ABC-132A54",
"coverage_start_date": "2021-01-01",
"coverage_end_date": "2021-12-31",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"state": "initial",
"plans": [],
"carrier_name": "cigna",
"carrier_group_number": "123456",
"enrollment_type": "member_management"
}
],
"employment_classifications": [
{
"external_identifier": "Class1",
"carrier_identifier": "A001",
"description": "All Eligible Employees in California",
"start_date": "2019-01-01",
"end_date": "2020-12-31",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"type": "department"
}
]
},
"errors": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"pending",
"synced",
"errors"
],
"description": "The status of the group enrollment with the carrier"
},
"status_datetime": {
"type": "string",
"description": "The date the group status was set"
},
"group": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"general_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the general agency"
},
"representative": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"description": "The last name of a representative for the general agency"
},
"first_name": {
"type": "string",
"description": "The first name of a representative for the general agency"
}
},
"required": [
"last_name"
]
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the general agency"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The general agency associated with the group"
},
"group_setup": {
"type": "object",
"properties": {
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
}
}
},
"producer_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The agency the producer represents"
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the producer"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The producer agency associated with the writing agents of the group"
},
"employer": {
"type": "object",
"properties": {
"organization_name": {
"type": "string",
"description": "The employer's legal name"
},
"standard_industrial_classification_code": {
"type": "string",
"description": "The Standard Industrial Classification (SIC) code for the employer's business"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"established_date": {
"type": "string",
"description": "The date on which the company was founded and began operations"
},
"employer_type": {
"type": "string",
"enum": [
"private_sector",
"tribal_government",
"religious_employer",
"state_government",
"foreign_government",
"corporation",
"s_corporation",
"partnership",
"proprietorship",
"limited_liability_company",
"limited_partnership",
"limited_liability_partnership",
"other"
],
"description": "The type of the employer"
},
"census": {
"type": "object",
"properties": {
"employees": {
"type": "number",
"description": "The total number of persons employed by the employer as defined by a carrier's underwriting guidelines"
},
"full_time_equivalent_employees": {
"type": "number",
"description": "The total number of full time equivalent employees as defined by a carrier's underwriting guidelines"
},
"eligible_employees": {
"type": "number",
"description": "The total number of eligible employees as defined by a carrier's underwriting guidelines"
}
},
"required": [
"employees",
"full_time_equivalent_employees",
"eligible_employees"
]
},
"member_of_association": {
"type": "boolean",
"description": "Is this employer a member of an association?"
},
"subject_to_family_medical_leave_act": {
"type": "boolean"
},
"leave_of_absence_medical_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"leave_of_absence_personal_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to employees"
},
"hours_required_for_eligibility": {
"type": "number",
"description": "The number of weekly work hours required for insurance eligibility"
},
"employed_20_or_more_for_half_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least half of the previous year?"
},
"employed_20_or_more_for_twenty_weeks_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least twenty weeks of the previous year?"
},
"current_coverages": {
"type": "array",
"description": "List of coverage information for plans the group currently has"
}
},
"required": [
"organization_name",
"fein"
],
"description": "The employer enrolling a group"
},
"primary_location": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"employer_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"billing_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the billing administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the billing administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for billing"
},
"benefit_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the benefit administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the benefit administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for benefit administration"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"external_identifier",
"employer_address",
"id"
]
},
"secondary_locations": {
"type": "array",
"description": "The location(s) associated with the enrollment request"
},
"producers_of_record": {
"type": "array",
"description": "The producers associated with the group"
},
"coverage_periods": {
"type": "array"
},
"employment_classifications": {
"type": "array",
"description": "The classifications offered by the employer group"
}
},
"required": [
"external_identifier",
"id",
"group_setup",
"employer",
"primary_location",
"secondary_locations",
"producers_of_record",
"coverage_periods"
],
"description": "The group associated with the enrollment request"
},
"errors": {
"type": "array",
"description": "A list of errors provided by the carrier associated with the group"
}
},
"required": [
"status",
"group"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Retrieve a GroupGET/groups/{id}
This endpoint returns a particular Group resource.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
Groups Locations By Id ¶
POST /groups/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/locations
Requests
Headers
Content-Type: application/jsonBody
{
"location": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {}
}
},
"required": [
"location"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"location": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {}
}
},
"required": [
"location"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a LocationPOST/groups/{id}/locations
The Location is a representation of an office location for the company. In the response, you will receive an identifier for the Location, which can be used on the Subscriber resource to indicate where the Subscriber works.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
Group Installments ¶
POST /group_installments
Requests
Headers
Content-Type: <<Add Header Value>>Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"group": {
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"general_agency": {
"name": "House Mormont",
"representative": {
"last_name": "Mormont",
"first_name": "Maege"
},
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"group_setup": {
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
}
},
"producer_agency": {
"name": "Stark Industries",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"employer": {
"organization_name": "ABCD Co",
"standard_industrial_classification_code": "8011",
"fein": "222222222",
"established_date": "2010-01-01",
"employer_type": "private_sector",
"census": {
"employees": 25,
"full_time_equivalent_employees": 20,
"eligible_employees": 18
},
"member_of_association": false,
"leave_of_absence_medical_coverage_months": "three",
"leave_of_absence_personal_coverage_months": "three",
"wage_frequency": "weekly",
"current_coverages": [
{
"product_line": "medical",
"coverage_end_date": "2022-01-01",
"carrier_name": "cigna",
"policy_number": "ABC12345"
}
]
},
"primary_location": {
"type": "physical",
"external_identifier": "ABC-132A54",
"employer_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"billing_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"benefit_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
},
"secondary_locations": [],
"producers_of_record": [
{
"first_name": "Arya",
"last_name": "Stark",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"commission_split": 100,
"signature_date": "",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"general_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the general agency"
},
"representative": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"description": "The last name of a representative for the general agency"
},
"first_name": {
"type": "string",
"description": "The first name of a representative for the general agency"
}
},
"required": [
"last_name"
]
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the general agency"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The general agency associated with the group"
},
"group_setup": {
"type": "object",
"properties": {
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
}
}
},
"producer_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The agency the producer represents"
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the producer"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The producer agency associated with the writing agents of the group"
},
"employer": {
"type": "object",
"properties": {
"organization_name": {
"type": "string",
"description": "The employer's legal name"
},
"standard_industrial_classification_code": {
"type": "string",
"description": "The Standard Industrial Classification (SIC) code for the employer's business"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"established_date": {
"type": "string",
"description": "The date on which the company was founded and began operations"
},
"employer_type": {
"type": "string",
"enum": [
"private_sector",
"tribal_government",
"religious_employer",
"state_government",
"foreign_government",
"corporation",
"s_corporation",
"partnership",
"proprietorship",
"limited_liability_company",
"limited_partnership",
"limited_liability_partnership",
"other"
],
"description": "The type of the employer"
},
"census": {
"type": "object",
"properties": {
"employees": {
"type": "number",
"description": "The total number of persons employed by the employer as defined by a carrier's underwriting guidelines"
},
"full_time_equivalent_employees": {
"type": "number",
"description": "The total number of full time equivalent employees as defined by a carrier's underwriting guidelines"
},
"eligible_employees": {
"type": "number",
"description": "The total number of eligible employees as defined by a carrier's underwriting guidelines"
}
},
"required": [
"employees",
"full_time_equivalent_employees",
"eligible_employees"
]
},
"member_of_association": {
"type": "boolean",
"description": "Is this employer a member of an association?"
},
"subject_to_family_medical_leave_act": {
"type": "boolean"
},
"leave_of_absence_medical_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"leave_of_absence_personal_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to employees"
},
"hours_required_for_eligibility": {
"type": "number",
"description": "The number of weekly work hours required for insurance eligibility"
},
"employed_20_or_more_for_half_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least half of the previous year?"
},
"employed_20_or_more_for_twenty_weeks_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least twenty weeks of the previous year?"
},
"current_coverages": {
"type": "array",
"description": "List of coverage information for plans the group currently has"
}
},
"required": [
"organization_name",
"fein"
],
"description": "The employer enrolling a group"
},
"primary_location": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"employer_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"billing_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the billing administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the billing administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for billing"
},
"benefit_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the benefit administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the benefit administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for benefit administration"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"type",
"external_identifier",
"employer_address",
"id"
]
},
"secondary_locations": {
"type": "array"
},
"producers_of_record": {
"type": "array",
"description": "The producers associated with the group"
}
},
"required": [
"external_identifier",
"id",
"employer",
"primary_location",
"secondary_locations",
"producers_of_record"
],
"description": "The group associated with the enrollment request"
}
},
"required": [
"group"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a Group InstallmentPOST/group_installments
The Group Installment resource is a representation of an application for new policies for a Group. This endpoint should only be used if Ideon will be facilitating the application process of installing a Group for the first time with one or more carriers. In the response, you will receive an identifier for the Group, which can be used to fill out the remaining resources in order for Ideon to apply for coverage with carriers on behalf of the Group.
Group Installments By Id ¶
PUT /group_installments/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: <<Add Header Value>>Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"group": {
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"general_agency": {
"name": "House Mormont",
"representative": {
"last_name": "Mormont",
"first_name": "Maege"
},
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"group_setup": {
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
}
},
"producer_agency": {
"name": "Stark Industries",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
}
},
"employer": {
"organization_name": "ABCD Co",
"standard_industrial_classification_code": "8011",
"fein": "222222222",
"established_date": "2010-01-01",
"employer_type": "private_sector",
"census": {
"employees": 25,
"full_time_equivalent_employees": 20,
"eligible_employees": 18
},
"member_of_association": false,
"leave_of_absence_medical_coverage_months": "three",
"leave_of_absence_personal_coverage_months": "three",
"wage_frequency": "weekly",
"current_coverages": [
{
"product_line": "medical",
"coverage_end_date": "2022-01-01",
"carrier_name": "cigna",
"policy_number": "ABC12345"
}
]
},
"primary_location": {
"type": "physical",
"external_identifier": "ABC-132A54",
"employer_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"billing_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"benefit_administrator": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
},
"secondary_locations": [],
"producers_of_record": [
{
"first_name": "Arya",
"last_name": "Stark",
"national_producer_number": "12345678",
"social_security_number": "222222222",
"fein": "222222222",
"state_license_number": "12345678",
"carrier_producer_identifier": "87654321",
"commission_split": 100,
"signature_date": "",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"general_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the general agency"
},
"representative": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"description": "The last name of a representative for the general agency"
},
"first_name": {
"type": "string",
"description": "The first name of a representative for the general agency"
}
},
"required": [
"last_name"
]
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the general agency"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The general agency associated with the group"
},
"group_setup": {
"type": "object",
"properties": {
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
}
}
},
"producer_agency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The agency the producer represents"
},
"national_producer_number": {
"type": "string",
"description": "The national producer number (NPN) provided by the National Producer Insurance Registry (NIPR)"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"state_license_number": {
"type": "string",
"description": "State provided license number"
},
"carrier_producer_identifier": {
"type": "string",
"description": "Carrier provided identifier to uniquely identify the producer"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
}
},
"required": [
"name",
"national_producer_number"
],
"description": "The producer agency associated with the writing agents of the group"
},
"employer": {
"type": "object",
"properties": {
"organization_name": {
"type": "string",
"description": "The employer's legal name"
},
"standard_industrial_classification_code": {
"type": "string",
"description": "The Standard Industrial Classification (SIC) code for the employer's business"
},
"fein": {
"type": "string",
"description": "Federal employer tax identification number"
},
"established_date": {
"type": "string",
"description": "The date on which the company was founded and began operations"
},
"employer_type": {
"type": "string",
"enum": [
"private_sector",
"tribal_government",
"religious_employer",
"state_government",
"foreign_government",
"corporation",
"s_corporation",
"partnership",
"proprietorship",
"limited_liability_company",
"limited_partnership",
"limited_liability_partnership",
"other"
],
"description": "The type of the employer"
},
"census": {
"type": "object",
"properties": {
"employees": {
"type": "number",
"description": "The total number of persons employed by the employer as defined by a carrier's underwriting guidelines"
},
"full_time_equivalent_employees": {
"type": "number",
"description": "The total number of full time equivalent employees as defined by a carrier's underwriting guidelines"
},
"eligible_employees": {
"type": "number",
"description": "The total number of eligible employees as defined by a carrier's underwriting guidelines"
}
},
"required": [
"employees",
"full_time_equivalent_employees",
"eligible_employees"
]
},
"member_of_association": {
"type": "boolean",
"description": "Is this employer a member of an association?"
},
"subject_to_family_medical_leave_act": {
"type": "boolean"
},
"leave_of_absence_medical_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"leave_of_absence_personal_coverage_months": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to employees"
},
"hours_required_for_eligibility": {
"type": "number",
"description": "The number of weekly work hours required for insurance eligibility"
},
"employed_20_or_more_for_half_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least half of the previous year?"
},
"employed_20_or_more_for_twenty_weeks_of_previous_year": {
"type": "boolean",
"description": "Did the company employ twenty or more for at least twenty weeks of the previous year?"
},
"current_coverages": {
"type": "array",
"description": "List of coverage information for plans the group currently has"
}
},
"required": [
"organization_name",
"fein"
],
"description": "The employer enrolling a group"
},
"primary_location": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"employer_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"billing_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the billing administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the billing administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for billing"
},
"benefit_administrator": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "The first name of the benefit administrator"
},
"last_name": {
"type": "string",
"description": "The last name of the benefit administrator"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
}
},
"required": [
"first_name",
"last_name",
"emails",
"phone_numbers"
],
"description": "A person who can be used as a contact for benefit administration"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"type",
"external_identifier",
"employer_address",
"id"
]
},
"secondary_locations": {
"type": "array"
},
"producers_of_record": {
"type": "array",
"description": "The producers associated with the group"
}
},
"required": [
"external_identifier",
"id",
"employer",
"primary_location",
"secondary_locations",
"producers_of_record"
],
"description": "The group associated with the enrollment request"
}
},
"required": [
"group"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a Group InstallmentPUT/group_installments/{id}
This endpoint edits the information provided for a Group seeking to apply for a policy with a carrier for the first time.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the Group
Coverage Periods ¶
Groups Coverage Periods By Id ¶
POST /groups/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/coverage_periods?carrier_name=guardian
Requests
Headers
Content-Type: application/jsonBody
{
"coverage_period": {
"external_identifier": "ABC-132A54",
"coverage_start_date": "2022-01-01",
"coverage_end_date": "2022-12-31",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"carrier_name": "cigna",
"carrier_group_number": "123456",
"enrollment_type": "member_management"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_period": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"coverage_start_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"coverage_end_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
},
"open_enrollment_end_date": {
"type": "string",
"description": "The last day of the open enrollment period"
},
"open_enrollment_start_date": {
"type": "string",
"description": "The first day of the open enrollment period"
},
"additional_information": {
"type": "object",
"properties": {},
"description": "An arbitrary set of information on a coverage period"
},
"carrier_name": {
"type": "string",
"enum": [
"cigna",
"humana",
"guardian",
"kaiser",
"anthem",
"aetna",
"blue_shield_of_california",
"metlife",
"unitedhealthcare",
"blue_cross_blue_shield_of_florida",
"blue_cross_blue_shield_of_illinois",
"blue_cross_blue_shield_of_texas",
"blue_cross_blue_shield_of_massachusetts",
"oxford",
"carefirst",
"premera_blue_cross",
"regence",
"selecthealth",
"unum",
"lincoln",
"blue_cross_blue_shield_of_kansas_city",
"calchoice",
"voya",
"principal",
"oscar",
"friday_health",
"beam",
"symetra"
],
"description": "The name of the carrier associated with the group enrollment"
},
"carrier_group_number": {
"type": [
"string",
"null"
],
"description": "The carrier group number provided by the carrier to uniquely identify the group. Requests that violate the carrier specific formatting rules will receive a 422 with an error on the parameter `group.group_setup.carrier_group_number`.\n\n- **Aetna:** Ideon accepts either 6 numeric characters or 7 numeric characters where the first character is '0'. If 6 characters are provided a leading zero will automatically be prepended before delivery to the carrier.\n e.g. '0123456', '123456'\n\n- **Anthem:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Blue Shield of California:** Ideon accepts a prefix 'W0' followed by 6 numeric characters\n If the prefix is missing it will automatically be prepended before delivery to\n the carrier.\n e.g. 'W0123456', '123456'\n\n- **Cigna:** Ideon accepts 6 to 8 numeric characters with an optional suffix '-F'. The suffix corresponds with Cigna FACETS. Carrier group numbers will be suffixed and leading zeroes added based on the carrier enrollment system.\n e.g. '123456', '123456-F', '12345678', '12345678-F'\n\n- **Guardian:** Ideon accepts 6 and 8 numeric characters. If fewer than 8 characters are provided they will be padded with leading zeroes.\n e.g. '123456', '01234567', '12345678'\n\n- **Humana:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Kaiser:** Ideon accepts between 6 and 9 numeric characters\n If fewer than 9 characters are provided they will be padded with leading zeroes before\n delivery to the carrier.\n e.g. '123456', '1234567', '001234567'"
},
"enrollment_type": {
"type": "string",
"enum": [
"member_management",
"initial_installment",
"renewal"
],
"description": "The type of coverage period (new/existing)"
}
},
"required": [
"coverage_start_date",
"carrier_name"
]
}
},
"required": [
"coverage_period"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"coverage_period": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"external_identifier": "ABC-132A54",
"coverage_start_date": "2021-01-01",
"coverage_end_date": "2021-12-31",
"distribution_format": "api",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"state": "initial",
"carrier_name": "cigna",
"carrier_group_number": "123456",
"enrollment_type": "member_management",
"next_send_time": null,
"term_by_omission": true,
"cobra_supported": true,
"file_type": "full file"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_period": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"coverage_start_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"coverage_end_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"distribution_format": {
"type": "string",
"enum": [
"api",
"edi"
],
"description": "Mode of Transmission"
},
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
},
"open_enrollment_end_date": {
"type": [
"string",
"null"
],
"description": "The last day of the open enrollment period"
},
"open_enrollment_start_date": {
"type": [
"string",
"null"
],
"description": "The first day of the open enrollment period"
},
"state": {
"type": "string",
"enum": [
"initial",
"configuration",
"test",
"production",
"expired"
],
"description": "The status of the coverage period"
},
"additional_information": {
"type": "object",
"properties": {},
"description": "An arbitrary set of information on a coverage period"
},
"carrier_name": {
"type": "string",
"enum": [
"cigna",
"humana",
"guardian",
"kaiser",
"anthem",
"aetna",
"blue_shield_of_california",
"metlife",
"unitedhealthcare",
"blue_cross_blue_shield_of_florida",
"blue_cross_blue_shield_of_illinois",
"blue_cross_blue_shield_of_texas",
"blue_cross_blue_shield_of_massachusetts",
"oxford",
"carefirst",
"premera_blue_cross",
"regence",
"selecthealth",
"unum",
"lincoln",
"blue_cross_blue_shield_of_kansas_city",
"calchoice",
"voya",
"principal",
"oscar",
"friday_health",
"beam",
"symetra"
],
"description": "The name of the carrier associated with the group enrollment"
},
"carrier_group_number": {
"type": [
"string",
"null"
],
"description": "The carrier group number provided by the carrier to uniquely identify the group. Requests that violate the carrier specific formatting rules will receive a 422 with an error on the parameter `group.group_setup.carrier_group_number`.\n\n- **Aetna:** Ideon accepts either 6 numeric characters or 7 numeric characters where the first character is '0'. If 6 characters are provided a leading zero will automatically be prepended before delivery to the carrier.\n e.g. '0123456', '123456'\n\n- **Anthem:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Blue Shield of California:** Ideon accepts a prefix 'W0' followed by 6 numeric characters\n If the prefix is missing it will automatically be prepended before delivery to\n the carrier.\n e.g. 'W0123456', '123456'\n\n- **Cigna:** Ideon accepts 6 to 8 numeric characters with an optional suffix '-F'. The suffix corresponds with Cigna FACETS. Carrier group numbers will be suffixed and leading zeroes added based on the carrier enrollment system.\n e.g. '123456', '123456-F', '12345678', '12345678-F'\n\n- **Guardian:** Ideon accepts 6 and 8 numeric characters. If fewer than 8 characters are provided they will be padded with leading zeroes.\n e.g. '123456', '01234567', '12345678'\n\n- **Humana:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Kaiser:** Ideon accepts between 6 and 9 numeric characters\n If fewer than 9 characters are provided they will be padded with leading zeroes before\n delivery to the carrier.\n e.g. '123456', '1234567', '001234567'"
},
"enrollment_type": {
"type": "string",
"enum": [
"member_management",
"initial_installment",
"renewal"
],
"description": "The type of coverage period (new/existing)"
},
"next_send_time": {
"type": [
"string",
"null"
]
},
"term_by_omission": {
"type": [
"boolean",
"null"
],
"description": "Term by Omission Flag"
},
"cobra_supported": {
"type": "boolean",
"description": "Cobra supported Flag"
},
"file_type": {
"type": [
"string",
"null"
],
"enum": [
"full file",
"changes only",
null
],
"description": "The type of file by which the coverage period is transmitted"
}
},
"required": [
"id",
"coverage_start_date",
"open_enrollment_end_date",
"open_enrollment_start_date",
"state",
"carrier_name",
"carrier_group_number",
"enrollment_type",
"next_send_time",
"term_by_omission"
]
}
},
"required": [
"coverage_period"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a Coverage PeriodPOST/groups/{id}/coverage_periods{?carrier_name}
The Coverage Period is a representation of the plan year for coverage with a particular carrier. Each Coverage Period can have many plans across all lines of coverage offered by the carrier. In the response, you will receive an identifier for the Coverage Period, which can be used to create Plans and add Qualifying Life Events for Subscribers.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
- carrier_name
string(required) Example: guardianThe insurance carrier
Choices:
cignahumanaguardiankaiseranthemaetnablue_shield_of_californiametlifeunitedhealthcareblue_cross_blue_shield_of_floridablue_cross_blue_shield_of_illinoisblue_cross_blue_shield_of_texasblue_cross_blue_shield_of_massachusettsoxfordcarefirstpremera_blue_crossregenceselecthealthunumlincolnblue_cross_blue_shield_of_kansas_citycalchoicevoyaprincipaloscarfriday_healthbeamsymetra
Coverage Periods 834 By Id ¶
GET /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f.834
Responses
Coverage Period 834 File Generated
Headers
Content-Type: text/plainBody
"Hello, world!"Schema
{
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#"
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create an 834GET/coverage_periods/{id}.834
Generates an 834 for the specified coverage period
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Coverage Periods Csv By Id ¶
GET /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f.csv
Responses
Coverage Period CSV File Generated
Headers
Content-Type: text/plainBody
"Hello, world!"Schema
{
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#"
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a CSVGET/coverage_periods/{id}.csv
Generates coverage information for a Coverage Period in a standardized CSV format. This format is not alterable.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Coverage Periods By Id ¶
GET /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f
Responses
Coverage Period Request Received
Headers
Content-Type: application/jsonBody
{
"coverage_period": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"external_identifier": "ABC-132A54",
"coverage_start_date": "2021-01-01",
"coverage_end_date": "2021-12-31",
"distribution_format": "api",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"state": "initial",
"carrier_name": "cigna",
"carrier_group_number": "123456",
"enrollment_type": "member_management",
"next_send_time": null,
"term_by_omission": true,
"cobra_supported": true,
"file_type": "full file"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_period": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"coverage_start_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"coverage_end_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"distribution_format": {
"type": "string",
"enum": [
"api",
"edi"
],
"description": "Mode of Transmission"
},
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
},
"open_enrollment_end_date": {
"type": [
"string",
"null"
],
"description": "The last day of the open enrollment period"
},
"open_enrollment_start_date": {
"type": [
"string",
"null"
],
"description": "The first day of the open enrollment period"
},
"state": {
"type": "string",
"enum": [
"initial",
"configuration",
"test",
"production",
"expired"
],
"description": "The status of the coverage period"
},
"additional_information": {
"type": "object",
"properties": {},
"description": "An arbitrary set of information on a coverage period"
},
"carrier_name": {
"type": "string",
"enum": [
"cigna",
"humana",
"guardian",
"kaiser",
"anthem",
"aetna",
"blue_shield_of_california",
"metlife",
"unitedhealthcare",
"blue_cross_blue_shield_of_florida",
"blue_cross_blue_shield_of_illinois",
"blue_cross_blue_shield_of_texas",
"blue_cross_blue_shield_of_massachusetts",
"oxford",
"carefirst",
"premera_blue_cross",
"regence",
"selecthealth",
"unum",
"lincoln",
"blue_cross_blue_shield_of_kansas_city",
"calchoice",
"voya",
"principal",
"oscar",
"friday_health",
"beam",
"symetra"
],
"description": "The name of the carrier associated with the group enrollment"
},
"carrier_group_number": {
"type": [
"string",
"null"
],
"description": "The carrier group number provided by the carrier to uniquely identify the group. Requests that violate the carrier specific formatting rules will receive a 422 with an error on the parameter `group.group_setup.carrier_group_number`.\n\n- **Aetna:** Ideon accepts either 6 numeric characters or 7 numeric characters where the first character is '0'. If 6 characters are provided a leading zero will automatically be prepended before delivery to the carrier.\n e.g. '0123456', '123456'\n\n- **Anthem:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Blue Shield of California:** Ideon accepts a prefix 'W0' followed by 6 numeric characters\n If the prefix is missing it will automatically be prepended before delivery to\n the carrier.\n e.g. 'W0123456', '123456'\n\n- **Cigna:** Ideon accepts 6 to 8 numeric characters with an optional suffix '-F'. The suffix corresponds with Cigna FACETS. Carrier group numbers will be suffixed and leading zeroes added based on the carrier enrollment system.\n e.g. '123456', '123456-F', '12345678', '12345678-F'\n\n- **Guardian:** Ideon accepts 6 and 8 numeric characters. If fewer than 8 characters are provided they will be padded with leading zeroes.\n e.g. '123456', '01234567', '12345678'\n\n- **Humana:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Kaiser:** Ideon accepts between 6 and 9 numeric characters\n If fewer than 9 characters are provided they will be padded with leading zeroes before\n delivery to the carrier.\n e.g. '123456', '1234567', '001234567'"
},
"enrollment_type": {
"type": "string",
"enum": [
"member_management",
"initial_installment",
"renewal"
],
"description": "The type of coverage period (new/existing)"
},
"next_send_time": {
"type": [
"string",
"null"
]
},
"term_by_omission": {
"type": [
"boolean",
"null"
],
"description": "Term by Omission Flag"
},
"cobra_supported": {
"type": "boolean",
"description": "Cobra supported Flag"
},
"file_type": {
"type": [
"string",
"null"
],
"enum": [
"full file",
"changes only",
null
],
"description": "The type of file by which the coverage period is transmitted"
}
},
"required": [
"id",
"coverage_start_date",
"open_enrollment_end_date",
"open_enrollment_start_date",
"state",
"carrier_name",
"carrier_group_number",
"enrollment_type",
"next_send_time",
"term_by_omission"
]
}
},
"required": [
"coverage_period"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Retrieve a Coverage PeriodGET/coverage_periods/{id}
This endpoint returns a particular Coverage Period resource.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
PUT /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: application/jsonBody
{
"coverage_period": {
"external_identifier": "ABC-132A54",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"carrier_group_number": "123456",
"enrollment_type": "member_management"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_period": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"coverage_start_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"coverage_end_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
},
"open_enrollment_end_date": {
"type": "string",
"description": "The last day of the open enrollment period"
},
"open_enrollment_start_date": {
"type": "string",
"description": "The first day of the open enrollment period"
},
"additional_information": {
"type": "object",
"properties": {},
"description": "An arbitrary set of information on a coverage period"
},
"carrier_group_number": {
"type": [
"string",
"null"
],
"description": "The carrier group number provided by the carrier to uniquely identify the group. Requests that violate the carrier specific formatting rules will receive a 422 with an error on the parameter `group.group_setup.carrier_group_number`.\n\n- **Aetna:** Ideon accepts either 6 numeric characters or 7 numeric characters where the first character is '0'. If 6 characters are provided a leading zero will automatically be prepended before delivery to the carrier.\n e.g. '0123456', '123456'\n\n- **Anthem:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Blue Shield of California:** Ideon accepts a prefix 'W0' followed by 6 numeric characters\n If the prefix is missing it will automatically be prepended before delivery to\n the carrier.\n e.g. 'W0123456', '123456'\n\n- **Cigna:** Ideon accepts 6 to 8 numeric characters with an optional suffix '-F'. The suffix corresponds with Cigna FACETS. Carrier group numbers will be suffixed and leading zeroes added based on the carrier enrollment system.\n e.g. '123456', '123456-F', '12345678', '12345678-F'\n\n- **Guardian:** Ideon accepts 6 and 8 numeric characters. If fewer than 8 characters are provided they will be padded with leading zeroes.\n e.g. '123456', '01234567', '12345678'\n\n- **Humana:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Kaiser:** Ideon accepts between 6 and 9 numeric characters\n If fewer than 9 characters are provided they will be padded with leading zeroes before\n delivery to the carrier.\n e.g. '123456', '1234567', '001234567'"
},
"enrollment_type": {
"type": "string",
"enum": [
"member_management",
"initial_installment",
"renewal"
],
"description": "The type of coverage period (new/existing)"
}
}
}
},
"required": [
"coverage_period"
]
}Responses
Coverage Period Request Received
Headers
Content-Type: application/jsonBody
{
"coverage_period": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"external_identifier": "ABC-132A54",
"coverage_start_date": "2021-01-01",
"coverage_end_date": "2021-12-31",
"distribution_format": "api",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"state": "initial",
"carrier_name": "cigna",
"carrier_group_number": "123456",
"enrollment_type": "member_management",
"next_send_time": null,
"term_by_omission": true,
"cobra_supported": true,
"file_type": "full file"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_period": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"coverage_start_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"coverage_end_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"distribution_format": {
"type": "string",
"enum": [
"api",
"edi"
],
"description": "Mode of Transmission"
},
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
},
"open_enrollment_end_date": {
"type": [
"string",
"null"
],
"description": "The last day of the open enrollment period"
},
"open_enrollment_start_date": {
"type": [
"string",
"null"
],
"description": "The first day of the open enrollment period"
},
"state": {
"type": "string",
"enum": [
"initial",
"configuration",
"test",
"production",
"expired"
],
"description": "The status of the coverage period"
},
"additional_information": {
"type": "object",
"properties": {},
"description": "An arbitrary set of information on a coverage period"
},
"carrier_name": {
"type": "string",
"enum": [
"cigna",
"humana",
"guardian",
"kaiser",
"anthem",
"aetna",
"blue_shield_of_california",
"metlife",
"unitedhealthcare",
"blue_cross_blue_shield_of_florida",
"blue_cross_blue_shield_of_illinois",
"blue_cross_blue_shield_of_texas",
"blue_cross_blue_shield_of_massachusetts",
"oxford",
"carefirst",
"premera_blue_cross",
"regence",
"selecthealth",
"unum",
"lincoln",
"blue_cross_blue_shield_of_kansas_city",
"calchoice",
"voya",
"principal",
"oscar",
"friday_health",
"beam",
"symetra"
],
"description": "The name of the carrier associated with the group enrollment"
},
"carrier_group_number": {
"type": [
"string",
"null"
],
"description": "The carrier group number provided by the carrier to uniquely identify the group. Requests that violate the carrier specific formatting rules will receive a 422 with an error on the parameter `group.group_setup.carrier_group_number`.\n\n- **Aetna:** Ideon accepts either 6 numeric characters or 7 numeric characters where the first character is '0'. If 6 characters are provided a leading zero will automatically be prepended before delivery to the carrier.\n e.g. '0123456', '123456'\n\n- **Anthem:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Blue Shield of California:** Ideon accepts a prefix 'W0' followed by 6 numeric characters\n If the prefix is missing it will automatically be prepended before delivery to\n the carrier.\n e.g. 'W0123456', '123456'\n\n- **Cigna:** Ideon accepts 6 to 8 numeric characters with an optional suffix '-F'. The suffix corresponds with Cigna FACETS. Carrier group numbers will be suffixed and leading zeroes added based on the carrier enrollment system.\n e.g. '123456', '123456-F', '12345678', '12345678-F'\n\n- **Guardian:** Ideon accepts 6 and 8 numeric characters. If fewer than 8 characters are provided they will be padded with leading zeroes.\n e.g. '123456', '01234567', '12345678'\n\n- **Humana:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Kaiser:** Ideon accepts between 6 and 9 numeric characters\n If fewer than 9 characters are provided they will be padded with leading zeroes before\n delivery to the carrier.\n e.g. '123456', '1234567', '001234567'"
},
"enrollment_type": {
"type": "string",
"enum": [
"member_management",
"initial_installment",
"renewal"
],
"description": "The type of coverage period (new/existing)"
},
"next_send_time": {
"type": [
"string",
"null"
]
},
"term_by_omission": {
"type": [
"boolean",
"null"
],
"description": "Term by Omission Flag"
},
"cobra_supported": {
"type": "boolean",
"description": "Cobra supported Flag"
},
"file_type": {
"type": [
"string",
"null"
],
"enum": [
"full file",
"changes only",
null
],
"description": "The type of file by which the coverage period is transmitted"
}
},
"required": [
"id",
"coverage_start_date",
"open_enrollment_end_date",
"open_enrollment_start_date",
"state",
"carrier_name",
"carrier_group_number",
"enrollment_type",
"next_send_time",
"term_by_omission"
]
}
},
"required": [
"coverage_period"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a Coverage PeriodPUT/coverage_periods/{id}
Update the information for a Coverage Period. This endpoint is only allowable if the Group associated is in the Group Installment path. Group Installments is the flow for applying for policies with carriers for the first time on behalf of a Group.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Coverage Periods Complete Setup By Id ¶
POST /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/complete_setup
Responses
Coverage Period Request Received
Headers
Content-Type: application/jsonBody
{
"coverage_period": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"external_identifier": "ABC-132A54",
"coverage_start_date": "2021-01-01",
"coverage_end_date": "2021-12-31",
"distribution_format": "api",
"group_application_signature": {
"name": "Jon Snow",
"title": "Director of Human Resources",
"date": "2022-01-01"
},
"open_enrollment_end_date": "2021-11-31",
"open_enrollment_start_date": "2021-11-01",
"state": "initial",
"carrier_name": "cigna",
"carrier_group_number": "123456",
"enrollment_type": "member_management",
"next_send_time": null,
"term_by_omission": true,
"cobra_supported": true,
"file_type": "full file"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_period": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"coverage_start_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"coverage_end_date": {
"type": "string",
"description": "The start date of coverage for the group"
},
"distribution_format": {
"type": "string",
"enum": [
"api",
"edi"
],
"description": "Mode of Transmission"
},
"group_application_signature": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the individual authorized by the employer to sign the master employer application"
},
"title": {
"type": "string",
"description": "The title of the individual signing the master employer application"
},
"date": {
"type": "string",
"description": "The date the master employer application was signed by the employer"
}
},
"required": [
"name",
"date"
]
},
"open_enrollment_end_date": {
"type": [
"string",
"null"
],
"description": "The last day of the open enrollment period"
},
"open_enrollment_start_date": {
"type": [
"string",
"null"
],
"description": "The first day of the open enrollment period"
},
"state": {
"type": "string",
"enum": [
"initial",
"configuration",
"test",
"production",
"expired"
],
"description": "The status of the coverage period"
},
"additional_information": {
"type": "object",
"properties": {},
"description": "An arbitrary set of information on a coverage period"
},
"carrier_name": {
"type": "string",
"enum": [
"cigna",
"humana",
"guardian",
"kaiser",
"anthem",
"aetna",
"blue_shield_of_california",
"metlife",
"unitedhealthcare",
"blue_cross_blue_shield_of_florida",
"blue_cross_blue_shield_of_illinois",
"blue_cross_blue_shield_of_texas",
"blue_cross_blue_shield_of_massachusetts",
"oxford",
"carefirst",
"premera_blue_cross",
"regence",
"selecthealth",
"unum",
"lincoln",
"blue_cross_blue_shield_of_kansas_city",
"calchoice",
"voya",
"principal",
"oscar",
"friday_health",
"beam",
"symetra"
],
"description": "The name of the carrier associated with the group enrollment"
},
"carrier_group_number": {
"type": [
"string",
"null"
],
"description": "The carrier group number provided by the carrier to uniquely identify the group. Requests that violate the carrier specific formatting rules will receive a 422 with an error on the parameter `group.group_setup.carrier_group_number`.\n\n- **Aetna:** Ideon accepts either 6 numeric characters or 7 numeric characters where the first character is '0'. If 6 characters are provided a leading zero will automatically be prepended before delivery to the carrier.\n e.g. '0123456', '123456'\n\n- **Anthem:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Blue Shield of California:** Ideon accepts a prefix 'W0' followed by 6 numeric characters\n If the prefix is missing it will automatically be prepended before delivery to\n the carrier.\n e.g. 'W0123456', '123456'\n\n- **Cigna:** Ideon accepts 6 to 8 numeric characters with an optional suffix '-F'. The suffix corresponds with Cigna FACETS. Carrier group numbers will be suffixed and leading zeroes added based on the carrier enrollment system.\n e.g. '123456', '123456-F', '12345678', '12345678-F'\n\n- **Guardian:** Ideon accepts 6 and 8 numeric characters. If fewer than 8 characters are provided they will be padded with leading zeroes.\n e.g. '123456', '01234567', '12345678'\n\n- **Humana:** Ideon accepts 6 numeric characters\n e.g. '123456'\n\n- **Kaiser:** Ideon accepts between 6 and 9 numeric characters\n If fewer than 9 characters are provided they will be padded with leading zeroes before\n delivery to the carrier.\n e.g. '123456', '1234567', '001234567'"
},
"enrollment_type": {
"type": "string",
"enum": [
"member_management",
"initial_installment",
"renewal"
],
"description": "The type of coverage period (new/existing)"
},
"next_send_time": {
"type": [
"string",
"null"
]
},
"term_by_omission": {
"type": [
"boolean",
"null"
],
"description": "Term by Omission Flag"
},
"cobra_supported": {
"type": "boolean",
"description": "Cobra supported Flag"
},
"file_type": {
"type": [
"string",
"null"
],
"enum": [
"full file",
"changes only",
null
],
"description": "The type of file by which the coverage period is transmitted"
}
},
"required": [
"id",
"coverage_start_date",
"open_enrollment_end_date",
"open_enrollment_start_date",
"state",
"carrier_name",
"carrier_group_number",
"enrollment_type",
"next_send_time",
"term_by_omission"
]
}
},
"required": [
"coverage_period"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Mark Coverage Period Setup CompletePOST/coverage_periods/{id}/complete_setup
When loading a Coverage Period for the first time, this endpoint indicates to Ideon that you have completed passing the information and Ideon should take it from here to pass information to the carrier.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Contributions ¶
Coverage Periods Contributions By Id ¶
POST /coverage_periods/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/contributions
Requests
Headers
Content-Type: application/jsonBody
{
"contribution": {
"product_line": "medical",
"type": "percent",
"contribution_amounts": {
"subscriber": 100,
"dependent": 100,
"spouse": 100,
"child": 100,
"family": 100
},
"contributor": "employee",
"carrier": "anthem",
"benefit_level": "HMO A",
"level": "platinum",
"calchoice_contribution_method": "lowest_cost_hmo"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contribution": {
"type": "object",
"properties": {
"product_line": {
"type": "string",
"enum": [
"medical",
"dental",
"vision",
"voluntary_life",
"non_voluntary_life",
"accidental_death_dismemberment",
"voluntary_accidental_death_dismemberment",
"life_accidental_death_dismemberment",
"voluntary_life_accidental_death_dismemberment",
"short_term_disability",
"long_term_disability",
"hospital_indemnity",
"critical_illness",
"accident",
"cancer",
"legal"
],
"description": "The type of insurance product off of which the contribution is based"
},
"type": {
"type": "string",
"enum": [
"percent",
"fixed"
]
},
"contribution_amounts": {
"type": "object",
"properties": {
"subscriber": {
"type": "number"
},
"dependent": {
"type": "number"
},
"spouse": {
"type": "number"
},
"child": {
"type": "number"
},
"family": {
"type": "number"
}
}
},
"contributor": {
"type": "string",
"enum": [
"employee",
"employer"
]
},
"carrier": {
"type": "string"
},
"benefit_level": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"calchoice_contribution_method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"hmo_epo",
"hmo",
"ppo",
"lowest_cost_benefit_ppo",
"lowest_cost_ppo",
"employee_selected_plan",
"lowest_cost_hmo_epo_within_level",
"lowest_cost_ppo_within_level",
"am_buy_up",
"all_voluntary"
]
}
},
"required": [
"product_line",
"type",
"contribution_amounts",
"contributor"
]
}
},
"required": [
"contribution"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"contribution": {
"product_line": "medical",
"type": "percent",
"contribution_amounts": {
"subscriber": 100,
"dependent": 100,
"spouse": 100,
"child": 100,
"family": 100
},
"contributor": "employee",
"carrier": "anthem",
"benefit_level": "HMO A",
"level": "platinum",
"calchoice_contribution_method": "lowest_cost_hmo",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contribution": {
"type": "object",
"properties": {
"product_line": {
"type": "string",
"enum": [
"medical",
"dental",
"vision",
"voluntary_life",
"non_voluntary_life",
"accidental_death_dismemberment",
"voluntary_accidental_death_dismemberment",
"life_accidental_death_dismemberment",
"voluntary_life_accidental_death_dismemberment",
"short_term_disability",
"long_term_disability",
"hospital_indemnity",
"critical_illness",
"accident",
"cancer",
"legal"
],
"description": "The type of insurance product off of which the contribution is based"
},
"type": {
"type": "string",
"enum": [
"percent",
"fixed"
]
},
"contribution_amounts": {
"type": "object",
"properties": {
"subscriber": {
"type": "number"
},
"dependent": {
"type": "number"
},
"spouse": {
"type": "number"
},
"child": {
"type": "number"
},
"family": {
"type": "number"
}
}
},
"contributor": {
"type": "string",
"enum": [
"employee",
"employer"
]
},
"carrier": {
"type": "string"
},
"benefit_level": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"calchoice_contribution_method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"hmo_epo",
"hmo",
"ppo",
"lowest_cost_benefit_ppo",
"lowest_cost_ppo",
"employee_selected_plan",
"lowest_cost_hmo_epo_within_level",
"lowest_cost_ppo_within_level",
"am_buy_up",
"all_voluntary"
]
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"product_line",
"type",
"contribution_amounts",
"contributor",
"id"
]
}
},
"required": [
"contribution"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a ContributionPOST/coverage_periods/{id}/contributions
A Contribution resource is used as part of the Group Installment flow, wherein the Group is applying for insurance for the first time with a carrier. The Contribution is a representation of how the Group and its employees plan to contribute to the costs of certain plan offerings. Depending on the carrier, this can be required as part of the application process.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
GET /coverage_periods/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/contributions
Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"contributions": [
{
"product_line": "medical",
"type": "percent",
"contribution_amounts": {
"subscriber": 100,
"dependent": 100,
"spouse": 100,
"child": 100,
"family": 100
},
"contributor": "employee",
"carrier": "anthem",
"benefit_level": "HMO A",
"level": "platinum",
"calchoice_contribution_method": "lowest_cost_hmo",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contributions": {
"type": "array",
"description": "A list of coverage period contributions"
}
},
"required": [
"contributions"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List ContributionsGET/coverage_periods/{id}/contributions
A Contribution resource is used as part of the Group Installment flow, wherein the Group is applying for insurance for the first time with a carrier. The Contribution is a representation of how the Group and its employees plan to contribute to the costs of certain plan offerings. Depending on the carrier, this can be required as part of the application process.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Contributions By Id ¶
GET /contributions/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"contribution": {
"product_line": "medical",
"type": "percent",
"contribution_amounts": {
"subscriber": 100,
"dependent": 100,
"spouse": 100,
"child": 100,
"family": 100
},
"contributor": "employee",
"carrier": "anthem",
"benefit_level": "HMO A",
"level": "platinum",
"calchoice_contribution_method": "lowest_cost_hmo",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contribution": {
"type": "object",
"properties": {
"product_line": {
"type": "string",
"enum": [
"medical",
"dental",
"vision",
"voluntary_life",
"non_voluntary_life",
"accidental_death_dismemberment",
"voluntary_accidental_death_dismemberment",
"life_accidental_death_dismemberment",
"voluntary_life_accidental_death_dismemberment",
"short_term_disability",
"long_term_disability",
"hospital_indemnity",
"critical_illness",
"accident",
"cancer",
"legal"
],
"description": "The type of insurance product off of which the contribution is based"
},
"type": {
"type": "string",
"enum": [
"percent",
"fixed"
]
},
"contribution_amounts": {
"type": "object",
"properties": {
"subscriber": {
"type": "number"
},
"dependent": {
"type": "number"
},
"spouse": {
"type": "number"
},
"child": {
"type": "number"
},
"family": {
"type": "number"
}
}
},
"contributor": {
"type": "string",
"enum": [
"employee",
"employer"
]
},
"carrier": {
"type": "string"
},
"benefit_level": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"calchoice_contribution_method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"hmo_epo",
"hmo",
"ppo",
"lowest_cost_benefit_ppo",
"lowest_cost_ppo",
"employee_selected_plan",
"lowest_cost_hmo_epo_within_level",
"lowest_cost_ppo_within_level",
"am_buy_up",
"all_voluntary"
]
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"product_line",
"type",
"contribution_amounts",
"contributor",
"id",
"coverage_period_id"
]
}
},
"required": [
"contribution"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Retrieve a ContributionGET/contributions/{id}
This endpoint returns a particular Contribution resource.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the contribution
PUT /contributions/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: application/jsonBody
{
"contribution": {
"product_line": "medical",
"type": "percent",
"contribution_amounts": {
"subscriber": 100,
"dependent": 100,
"spouse": 100,
"child": 100,
"family": 100
},
"contributor": "employee",
"carrier": "anthem",
"benefit_level": "HMO A",
"level": "platinum",
"calchoice_contribution_method": "lowest_cost_hmo"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contribution": {
"type": "object",
"properties": {
"product_line": {
"type": "string",
"enum": [
"medical",
"dental",
"vision",
"voluntary_life",
"non_voluntary_life",
"accidental_death_dismemberment",
"voluntary_accidental_death_dismemberment",
"life_accidental_death_dismemberment",
"voluntary_life_accidental_death_dismemberment",
"short_term_disability",
"long_term_disability",
"hospital_indemnity",
"critical_illness",
"accident",
"cancer",
"legal"
],
"description": "The type of insurance product off of which the contribution is based"
},
"type": {
"type": "string",
"enum": [
"percent",
"fixed"
]
},
"contribution_amounts": {
"type": "object",
"properties": {
"subscriber": {
"type": "number"
},
"dependent": {
"type": "number"
},
"spouse": {
"type": "number"
},
"child": {
"type": "number"
},
"family": {
"type": "number"
}
}
},
"contributor": {
"type": "string",
"enum": [
"employee",
"employer"
]
},
"carrier": {
"type": "string"
},
"benefit_level": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"calchoice_contribution_method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"hmo_epo",
"hmo",
"ppo",
"lowest_cost_benefit_ppo",
"lowest_cost_ppo",
"employee_selected_plan",
"lowest_cost_hmo_epo_within_level",
"lowest_cost_ppo_within_level",
"am_buy_up",
"all_voluntary"
]
}
},
"required": [
"product_line",
"type",
"contribution_amounts",
"contributor"
]
}
},
"required": [
"contribution"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"contribution": {
"product_line": "medical",
"type": "percent",
"contribution_amounts": {
"subscriber": 100,
"dependent": 100,
"spouse": 100,
"child": 100,
"family": 100
},
"contributor": "employee",
"carrier": "anthem",
"benefit_level": "HMO A",
"level": "platinum",
"calchoice_contribution_method": "lowest_cost_hmo",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contribution": {
"type": "object",
"properties": {
"product_line": {
"type": "string",
"enum": [
"medical",
"dental",
"vision",
"voluntary_life",
"non_voluntary_life",
"accidental_death_dismemberment",
"voluntary_accidental_death_dismemberment",
"life_accidental_death_dismemberment",
"voluntary_life_accidental_death_dismemberment",
"short_term_disability",
"long_term_disability",
"hospital_indemnity",
"critical_illness",
"accident",
"cancer",
"legal"
],
"description": "The type of insurance product off of which the contribution is based"
},
"type": {
"type": "string",
"enum": [
"percent",
"fixed"
]
},
"contribution_amounts": {
"type": "object",
"properties": {
"subscriber": {
"type": "number"
},
"dependent": {
"type": "number"
},
"spouse": {
"type": "number"
},
"child": {
"type": "number"
},
"family": {
"type": "number"
}
}
},
"contributor": {
"type": "string",
"enum": [
"employee",
"employer"
]
},
"carrier": {
"type": "string"
},
"benefit_level": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"calchoice_contribution_method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"hmo_epo",
"hmo",
"ppo",
"lowest_cost_benefit_ppo",
"lowest_cost_ppo",
"employee_selected_plan",
"lowest_cost_hmo_epo_within_level",
"lowest_cost_ppo_within_level",
"am_buy_up",
"all_voluntary"
]
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"product_line",
"type",
"contribution_amounts",
"contributor",
"id",
"coverage_period_id"
]
}
},
"required": [
"contribution"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a ContributionPUT/contributions/{id}
This endpoint can be used to update a particular Contribution resource.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the contribution
Plan Availability ¶
Coverage Periods Plan Availability Requests ¶
POST /coverage_periods/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/plan_availability_requests
Requests
Headers
Content-Type: application/jsonBody
{
"product_line": "medical",
"hios_ids": [
"Hello, world!"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"product_line": {
"type": "string",
"description": "The product line of the available plans"
},
"hios_ids": {
"type": "array",
"description": "HIOS IDs to filter the search for available plans"
}
},
"required": [
"product_line"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"plan_availability_request": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"product_line": "medical",
"status": "pending",
"hios_ids": [
"Hello, world!"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"plan_availability_request": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"product_line": {
"type": "string",
"description": "The product line of the available plans"
},
"status": {
"type": "string",
"enum": [
"pending",
"error",
"complete"
],
"description": "The status of the request"
},
"hios_ids": {
"type": "array",
"description": "HIOS IDs to filter the search for available plans"
}
},
"required": [
"id",
"product_line",
"status"
],
"description": "The response for an plan availabity request"
}
},
"required": [
"plan_availability_request"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a Plan Availability RequestPOST/coverage_periods/{id}/plan_availability_requests
This endpoint can be used to request the plans that are available for enrollment with the carrier. This is part of the Group Installment flow, in which a Group is seeking to enroll in a policy for the first time with carriers.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Plan Availability Requests By Id ¶
GET /plan_availability_requests/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"plan_availability_request": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"product_line": "medical",
"status": "pending",
"hios_ids": [
"Hello, world!"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"plan_availability_request": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"product_line": {
"type": "string",
"description": "The product line of the available plans"
},
"status": {
"type": "string",
"enum": [
"pending",
"error",
"complete"
],
"description": "The status of the request"
},
"hios_ids": {
"type": "array",
"description": "HIOS IDs to filter the search for available plans"
}
},
"required": [
"id",
"product_line",
"status"
],
"description": "The response for an plan availabity request"
}
},
"required": [
"plan_availability_request"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Retrieve a Plan Availability RequestGET/plan_availability_requests/{id}
This endpoint can be used to check the status of a Plan Availability Request. This is part of the Group Installment flow, in which a Group is seeking to enroll in a policy for the first time with carriers.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the plan availability request
Plan Availability Requests Available Plans ¶
GET /plan_availability_requests/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/available_plans?page=1&
per_page=100
Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"meta": {
"total": 1,
"page": 1,
"per_page": 1
},
"available_plans": [
{
"plan_name": "SignatureValue HMO Platinum CPSL /F92S",
"plan_type": "HMO",
"contract_code": "CPSL-F92S",
"hios_id": "49116CA0070430"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"page": {
"type": "number"
},
"per_page": {
"type": "number"
}
}
},
"available_plans": {
"type": "array"
}
},
"required": [
"meta",
"available_plans"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List Available PlansGET/plan_availability_requests/{id}/available_plans{?page,per_page}
This endpoint can be used to see the plans that are available for enrollment with the carrier. This is part of the Group Installment flow, in which a Group is seeking to enroll in a policy for the first time with carriers.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the plan availability request
- page
number(optional) Example: 1The page number
- per_page
number(optional) Example: 100The resources returned per page
Plans ¶
Coverage Periods Plans By Id ¶
POST /coverage_periods/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/plans
Requests
Headers
Content-Type: application/jsonBody
{
"plan": {
"product_line": "Hello, world!",
"policy_premium_method": "fixed_family_tier",
"external_identifier": "ABC-132A54",
"plan_identifier": "44147126",
"description": "HSA Open Access Plus Network Only",
"product_type": "health_maintenance_organization",
"composite_rate_premiums": {
"employee_only": 100000,
"employee_plus_children": 100000,
"employee_plus_spouse": 100000,
"family": 100000
},
"riders": [
{
"identifier": "587AR"
}
],
"self_administered": true,
"employer_contribution": {
"type": "percent",
"subscriber_amount": 1,
"dependent_amount": 1,
"method": "lowest_cost_hmo"
},
"taxation": "pre",
"months_after_rehire_eligibility": "three",
"hsa": true,
"infertility_opt_in_rider": true,
"abortion_opt_out_rider": true,
"plan_calendar": "plan_year",
"waiting_period": {
"coverage_start": "first_of_following_month",
"waiting_period": "0_days"
},
"level": "platinum",
"chiropractic_rider_carrier_identifiers": [
{
"identifier": "ABC123",
"identifier_type": "benefit"
}
],
"carrier": "anthem"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"plan": {
"type": "object",
"properties": {
"product_line": {
"type": "string"
},
"policy_premium_method": {
"type": "string",
"enum": [
"fixed_family_tier",
"age_banded",
"4_tier_composite",
"3_tier_composite",
"2_tier_composite",
"adult_child_tier_composite"
],
"description": "The policy premium method is ..."
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"plan_identifier": {
"type": "string",
"description": "A unique identifier defining the plan offered by the carrier, can be a contract code or other"
},
"description": {
"type": "string",
"description": "A user-friendly description of the plan offered to employees, can be a contract code or other"
},
"product_type": {
"type": "string",
"enum": [
"health_maintenance_organization",
"high_deductible_health_plan",
"preferred_provider_organization",
"exclusive_provider_organization",
"point_of_service",
"indemnity"
],
"description": "The type of medical product"
},
"composite_rate_premiums": {
"type": "object",
"properties": {
"employee_only": {
"type": "number",
"description": "The composite rate premium amount in cents for employee only coverage"
},
"employee_plus_children": {
"type": "number",
"description": "The composite rate premium amount in cents for employee plus children coverage"
},
"employee_plus_spouse": {
"type": "number",
"description": "The composite rate premium amount in cents for employee plus spouse coverage"
},
"family": {
"type": "number",
"description": "The composite rate premium amount in cents for family coverage"
}
},
"description": "If the group's plan is composite rated provide the composite rates for the members"
},
"riders": {
"type": "array"
},
"self_administered": {
"type": "boolean"
},
"employer_contribution": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"percent",
"flat"
]
},
"subscriber_amount": {
"type": "number"
},
"dependent_amount": {
"type": "number"
},
"method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"highest_cost_hmo",
"ppo",
"employer_fixed"
],
"description": "The deciding principle for the employer premium contribution amount"
}
}
},
"taxation": {
"type": "string",
"enum": [
"pre",
"post"
]
},
"months_after_rehire_eligibility": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"hsa": {
"type": "boolean"
},
"infertility_opt_in_rider": {
"type": "boolean"
},
"abortion_opt_out_rider": {
"type": "boolean"
},
"plan_calendar": {
"type": "string",
"enum": [
"plan_year",
"calendar_year"
]
},
"waiting_period": {
"type": "object",
"properties": {
"coverage_start": {
"type": "string",
"enum": [
"first_of_following_month",
"immediate"
],
"description": "When coverage will start following the waiting period"
},
"waiting_period": {
"type": "string",
"enum": [
"0_days",
"30_days",
"60_days",
"90_days",
"1_month",
"2_months"
],
"description": "The waiting time period in consecutive days or months that must pass between a subscriber's eligibility start date (typically new hire date) and coverage start date"
}
},
"required": [
"coverage_start",
"waiting_period"
]
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"chiropractic_rider_carrier_identifiers": {
"type": "array"
},
"carrier": {
"type": "string",
"description": "The name of the carrier"
}
},
"required": [
"external_identifier",
"description",
"product_type"
],
"description": "Medical plan offered by the group to employees and dependents. Medical plans can be elected or waived by subscribers and dependents."
}
},
"required": [
"plan"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"plan": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"plan": {
"type": "object",
"properties": {}
}
},
"required": [
"plan"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a PlanPOST/coverage_periods/{id}/plans
A Plan is a representation of a plan offering that the Group has for the employees. For a particular Coverage Period, or plan year, a Group may offer several plans, for a variety of product lines, with a particular carrier.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Plans By Id ¶
PUT /plans/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: application/jsonBody
{
"plan": {
"product_line": "Hello, world!",
"external_identifier": "ABC-132A54",
"plan_identifier": "44147126",
"description": "HSA Open Access Plus Network Only",
"composite_rate_premiums": {
"employee_only": 100000,
"employee_plus_children": 100000,
"employee_plus_spouse": 100000,
"family": 100000
},
"riders": [
{
"identifier": "587AR"
}
],
"self_administered": true,
"employer_contribution": {
"type": "percent",
"subscriber_amount": 1,
"dependent_amount": 1,
"method": "lowest_cost_hmo"
},
"taxation": "pre",
"months_after_rehire_eligibility": "three",
"hsa": true,
"infertility_opt_in_rider": true,
"abortion_opt_out_rider": true,
"plan_calendar": "plan_year",
"waiting_period": {
"coverage_start": "first_of_following_month",
"waiting_period": "0_days"
},
"level": "platinum",
"chiropractic_rider_carrier_identifiers": [
{
"identifier": "ABC123",
"identifier_type": "benefit"
}
],
"carrier": "anthem"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"plan": {
"type": "object",
"properties": {
"product_line": {
"type": "string"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"plan_identifier": {
"type": "string",
"description": "A unique identifier defining the plan offered by the carrier, can be a contract code or other"
},
"description": {
"type": "string",
"description": "A user-friendly description of the plan offered to employees, can be a contract code or other"
},
"composite_rate_premiums": {
"type": "object",
"properties": {
"employee_only": {
"type": "number",
"description": "The composite rate premium amount in cents for employee only coverage"
},
"employee_plus_children": {
"type": "number",
"description": "The composite rate premium amount in cents for employee plus children coverage"
},
"employee_plus_spouse": {
"type": "number",
"description": "The composite rate premium amount in cents for employee plus spouse coverage"
},
"family": {
"type": "number",
"description": "The composite rate premium amount in cents for family coverage"
}
},
"description": "If the group's plan is composite rated provide the composite rates for the members"
},
"riders": {
"type": "array"
},
"self_administered": {
"type": "boolean"
},
"employer_contribution": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"percent",
"flat"
]
},
"subscriber_amount": {
"type": "number"
},
"dependent_amount": {
"type": "number"
},
"method": {
"type": "string",
"enum": [
"lowest_cost_hmo",
"highest_cost_hmo",
"ppo",
"employer_fixed"
],
"description": "The deciding principle for the employer premium contribution amount"
}
}
},
"taxation": {
"type": "string",
"enum": [
"pre",
"post"
]
},
"months_after_rehire_eligibility": {
"type": "string",
"enum": [
"three",
"six",
"nine",
"twelve"
]
},
"hsa": {
"type": "boolean"
},
"infertility_opt_in_rider": {
"type": "boolean"
},
"abortion_opt_out_rider": {
"type": "boolean"
},
"plan_calendar": {
"type": "string",
"enum": [
"plan_year",
"calendar_year"
]
},
"waiting_period": {
"type": "object",
"properties": {
"coverage_start": {
"type": "string",
"enum": [
"first_of_following_month",
"immediate"
],
"description": "When coverage will start following the waiting period"
},
"waiting_period": {
"type": "string",
"enum": [
"0_days",
"30_days",
"60_days",
"90_days",
"1_month",
"2_months"
],
"description": "The waiting time period in consecutive days or months that must pass between a subscriber's eligibility start date (typically new hire date) and coverage start date"
}
},
"required": [
"coverage_start",
"waiting_period"
]
},
"level": {
"type": "string",
"enum": [
"platinum",
"gold",
"silver",
"expanded_bronze",
"bronze",
"catastrophic"
]
},
"chiropractic_rider_carrier_identifiers": {
"type": "array"
},
"carrier": {
"type": "string",
"description": "The name of the carrier"
}
},
"required": [
"external_identifier",
"description"
],
"description": "Medical plan offered by the group to employees and dependents. Medical plans can be elected or waived by subscribers and dependents."
}
},
"required": [
"plan"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"plan": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"plan": {
"type": "object",
"properties": {}
}
},
"required": [
"plan"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a PlanPUT/plans/{id}
Use this endpoint to update an existing Plan.
This endpoint is only allowable if the Group associated is in the Group Installment path. Group Installments is the flow for applying for policies with carriers for the first time on behalf of a Group.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the plan
Employment Classifications ¶
Groups Employment Classifications By Id ¶
POST /groups/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/employment_classifications
Requests
Headers
Content-Type: application/jsonBody
{
"employment_classification": {
"external_identifier": "Class1",
"carrier_identifier": "A001",
"description": "All Eligible Employees in California",
"start_date": "2019-01-01",
"end_date": "2020-12-31",
"type": "department"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"employment_classification": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"carrier_identifier": {
"type": [
"string",
"null"
],
"description": "A carrier defined identifier for the classification"
},
"description": {
"type": "string",
"description": "A unique identifier defining the classification that has been communicated between the employer and carrier"
},
"start_date": {
"type": "string",
"description": "Define the effective start date for the classification when it is used to classify employees"
},
"end_date": {
"type": "string",
"description": "Define the effective end date for the classification when it is no longer used to classify employees"
},
"type": {
"type": "string",
"enum": [
"department",
"division",
"class",
"subgroup",
"region"
]
}
},
"required": [
"external_identifier",
"description",
"start_date",
"type"
],
"description": "Define an employment classification used to categorize employees (subscribers). Classifications are determined by employers and carriers based on various employment conditions: geographic location, earnings, method of compensation, hours and occupational duties, etc. Classifications assist in determining an employee's (subscriber's) eligibility for plans and products. Classifications are not required or used by all carriers."
}
},
"required": [
"employment_classification"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"employment_classification": {
"external_identifier": "Class1",
"carrier_identifier": "A001",
"description": "All Eligible Employees in California",
"start_date": "2019-01-01",
"end_date": "2020-12-31",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"type": "department"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"employment_classification": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"carrier_identifier": {
"type": [
"string",
"null"
],
"description": "A carrier defined identifier for the classification"
},
"description": {
"type": "string",
"description": "A unique identifier defining the classification that has been communicated between the employer and carrier"
},
"start_date": {
"type": "string",
"description": "Define the effective start date for the classification when it is used to classify employees"
},
"end_date": {
"type": "string",
"description": "Define the effective end date for the classification when it is no longer used to classify employees"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"type": {
"type": "string",
"enum": [
"department",
"division",
"class",
"subgroup",
"region"
]
}
},
"required": [
"external_identifier",
"description",
"start_date",
"id",
"type"
],
"description": "Define an employment classification used to categorize employees (subscribers). Classifications are determined by employers and carriers based on various employment conditions: geographic location, earnings, method of compensation, hours and occupational duties, etc. Classifications assist in determining an employee's (subscriber's) eligibility for plans and products. Classifications are not required or used by all carriers."
}
},
"required": [
"employment_classification"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create an Employment ClassificationPOST/groups/{id}/employment_classifications
This endpoint allows you to create an Employment Classification for a Group. Employment Classifications are representations of the various ways that a Group may classify their employees. Often times the difference in classifications result in different billing or offered coverage.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
Employment Classifications By Id ¶
PUT /employment_classifications/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: application/jsonBody
{
"employment_classification": {
"external_identifier": "Class1",
"carrier_identifier": "A001",
"description": "All Eligible Employees in California",
"start_date": "2019-01-01",
"end_date": "2020-12-31",
"type": "department"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"employment_classification": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"carrier_identifier": {
"type": [
"string",
"null"
],
"description": "A carrier defined identifier for the classification"
},
"description": {
"type": "string",
"description": "A unique identifier defining the classification that has been communicated between the employer and carrier"
},
"start_date": {
"type": "string",
"description": "Define the effective start date for the classification when it is used to classify employees"
},
"end_date": {
"type": "string",
"description": "Define the effective end date for the classification when it is no longer used to classify employees"
},
"type": {
"type": "string",
"enum": [
"department",
"division",
"class",
"subgroup",
"region"
]
}
},
"required": [
"external_identifier",
"description",
"start_date",
"type"
],
"description": "Define an employment classification used to categorize employees (subscribers). Classifications are determined by employers and carriers based on various employment conditions: geographic location, earnings, method of compensation, hours and occupational duties, etc. Classifications assist in determining an employee's (subscriber's) eligibility for plans and products. Classifications are not required or used by all carriers."
}
},
"required": [
"employment_classification"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"employment_classification": {
"external_identifier": "Class1",
"carrier_identifier": "A001",
"description": "All Eligible Employees in California",
"start_date": "2019-01-01",
"end_date": "2020-12-31",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"type": "department"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"employment_classification": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"carrier_identifier": {
"type": [
"string",
"null"
],
"description": "A carrier defined identifier for the classification"
},
"description": {
"type": "string",
"description": "A unique identifier defining the classification that has been communicated between the employer and carrier"
},
"start_date": {
"type": "string",
"description": "Define the effective start date for the classification when it is used to classify employees"
},
"end_date": {
"type": "string",
"description": "Define the effective end date for the classification when it is no longer used to classify employees"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"type": {
"type": "string",
"enum": [
"department",
"division",
"class",
"subgroup",
"region"
]
}
},
"required": [
"external_identifier",
"description",
"start_date",
"id",
"type"
],
"description": "Define an employment classification used to categorize employees (subscribers). Classifications are determined by employers and carriers based on various employment conditions: geographic location, earnings, method of compensation, hours and occupational duties, etc. Classifications assist in determining an employee's (subscriber's) eligibility for plans and products. Classifications are not required or used by all carriers."
}
},
"required": [
"employment_classification"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update an Employment ClassificationPUT/employment_classifications/{id}
Use this endpoint to update an existing Employment Classification.
This endpoint is only allowable if the Group associated is in the Group Installment path. Group Installments is the flow for applying for policies with carriers for the first time on behalf of a Group.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
Subscribers ¶
Groups Subscribers By Id ¶
POST /groups/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/subscribers
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"subscriber": {
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"administrative": "administrative",
"bargaining": "bargaining",
"birth_date": "1980-01-01",
"citizenship_status": "alien",
"dependents": [
{
"external_identifier": "ABC-132A54",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"social_security_number": "222222222",
"gender": "male",
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"handicapped": true,
"subscriber_relationship": "child",
"student_status": "full_time",
"birth_date": "1980-01-01",
"height": 62,
"weight": 123,
"tobacco_use": false,
"substance_abuse": true,
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"executive": "executive",
"exempt": "exempt",
"external_identifier": "ABC-132A54",
"first_name": "John",
"gender": "male",
"handicapped": true,
"height": 62,
"highly_compensated": true,
"key_employee": true,
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"last_name": "Smith",
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"management": "management",
"marital_status": "registered_domestic_partner",
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"middle_name": "M",
"name_prefix": "MR",
"name_suffix": "JR",
"owner": true,
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"president": "president",
"race_ethnicity": "not_provided",
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"salary_grade": "A",
"social_security_number": "222222222",
"substance_abuse": true,
"tobacco_use": false,
"union": "union",
"weight": 123,
"work_location": "254A"
}
}Schema
{
"type": "object",
"properties": {
"subscriber": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"division": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the division"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A division used to group employees together based on the carrier group's defined account structure"
},
"department": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the department"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A department used to group employees together based on the carrier group's defined account structure"
},
"class": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the class"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"subgroup": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the subgroup"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"administrative": {
"enum": [
"administrative",
"non_administrative"
],
"description": "Is the member an administrative or non-administrative employee?"
},
"bargaining": {
"enum": [
"bargaining",
"non_bargaining"
],
"description": "Is the member a bargaining or non-bargaining employee?"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"citizenship_status": {
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"dependents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"first_name": {
"type": "string"
},
"middle_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"name_prefix": {
"type": "string"
},
"name_suffix": {
"type": [
"string",
"null"
]
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"gender": {
"enum": [
"male",
"female",
"unknown"
]
},
"race_ethnicity": {
"enum": [
"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"
]
},
"citizenship_status": {
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"handicapped": {
"type": "boolean"
},
"subscriber_relationship": {
"enum": [
"child",
"grandchild",
"registered_domestic_partner",
"spouse",
"court_ordered_dependent"
]
},
"student_status": {
"enum": [
"full_time",
"not_a_student",
"part_time"
],
"description": "The student status of the member"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Member language name"
},
"language_proficiency": {
"enum": [
"reading",
"writing",
"speaking",
"native_language"
],
"description": "Member's proficiency of use for the given language: reading, writing, speaking, native_language"
}
},
"description": "Member language and proficiency if not English"
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"personal",
"work",
"other"
],
"description": "The type of email"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"other",
"beeper",
"mobile",
"fax",
"home",
"work"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"medical",
"prescription",
"hospital",
"medicare_advantage"
],
"description": "The member's Medicare type"
},
"start_date": {
"type": "string",
"description": "The member's Medicare effective coverage start date"
},
"end_date": {
"type": "string",
"description": "The member's Medicare effective coverage end date"
}
},
"required": [
"type",
"start_date"
]
}
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"schools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"work",
"fax"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"name": {
"type": "string",
"description": "The name of the member's school"
}
},
"required": [
"name"
]
}
}
},
"required": [
"external_identifier",
"last_name",
"gender",
"subscriber_relationship",
"birth_date"
]
},
"description": "Dependents associated with the subscriber"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"personal",
"work",
"other"
],
"description": "The type of email"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"employment_details": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "The date when the subscriber began full time employment with the group. In the event of a rehire provide the date of the rehire."
},
"end_date": {
"type": "string",
"description": "The date when the subscriber employment ended with the group"
},
"retirement_date": {
"type": "string",
"description": "The date the subscriber ended employment and entered retirement with the group"
},
"status": {
"enum": [
"active",
"active_military_overseas",
"active_military_usa",
"full_time",
"leave_of_absence",
"part_time",
"retired",
"terminated"
],
"description": "The employment status of the subscriber"
},
"annual_earnings": {
"type": "number",
"description": "The annual earnings of the subscriber in cents Should reflect the annual salary or estimated hourly earnings."
},
"earnings_effective_date": {
"type": "string",
"description": "The date the subscriber's annual salary or estimated hourly earnings is effective"
},
"wage_frequency": {
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to the subscriber"
},
"hours_per_week": {
"type": "number",
"description": "The number of hours worked by the subscriber per week"
},
"compensation": {
"enum": [
"hourly",
"salary"
],
"description": "Employment compensation is via salary or hourly?"
},
"title": {
"type": "string"
}
},
"required": [
"start_date",
"status"
]
},
"executive": {
"enum": [
"executive",
"non_executive"
],
"description": "Is the member an executive or non-executive employee?"
},
"exempt": {
"enum": [
"exempt",
"non_exempt"
],
"description": "Is the member an exempt or non-exempt employee?"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"first_name": {
"type": "string"
},
"gender": {
"enum": [
"male",
"female",
"unknown"
]
},
"handicapped": {
"type": "boolean"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"highly_compensated": {
"type": "boolean",
"description": "Is the member a highly compensated employee?"
},
"key_employee": {
"type": "boolean",
"description": "Is the member a key employee?"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Member language name"
},
"language_proficiency": {
"enum": [
"reading",
"writing",
"speaking",
"native_language"
],
"description": "Member's proficiency of use for the given language: reading, writing, speaking, native_language"
}
},
"description": "Member language and proficiency if not English"
}
},
"last_name": {
"type": "string"
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"management": {
"enum": [
"management",
"non_management"
],
"description": "Is the member a management or non-management employee?"
},
"marital_status": {
"enum": [
"registered_domestic_partner",
"divorced",
"single",
"married",
"separated",
"widowed"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"medical",
"prescription",
"hospital",
"medicare_advantage"
],
"description": "The member's Medicare type"
},
"start_date": {
"type": "string",
"description": "The member's Medicare effective coverage start date"
},
"end_date": {
"type": "string",
"description": "The member's Medicare effective coverage end date"
}
},
"required": [
"type",
"start_date"
]
}
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"middle_name": {
"type": "string"
},
"name_prefix": {
"type": "string"
},
"name_suffix": {
"type": [
"string",
"null"
]
},
"owner": {
"type": "boolean",
"description": "Is the member an owner of the business?"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"other",
"beeper",
"mobile",
"fax",
"home",
"work"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"president": {
"enum": [
"president",
"vice_president"
],
"description": "Is the member a president or vice president of the business?",
"type": [
null,
"null"
]
},
"race_ethnicity": {
"enum": [
"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"
]
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"salary_grade": {
"type": "string",
"description": "The member's salary grade"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"union": {
"enum": [
"union",
"non_union"
],
"description": "Is the member a union or non-union employee?"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"work_location": {
"type": "string",
"description": "The member's work location/department within the employer's organization"
}
},
"required": [
"location_id",
"birth_date",
"employment_details",
"external_identifier",
"gender",
"last_name",
"residential_address",
"social_security_number"
]
}
},
"required": [
"subscriber"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"subscriber": {
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"marital_status": "registered_domestic_partner",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"union": "union",
"executive": "executive",
"management": "management",
"administrative": "administrative",
"exempt": "exempt",
"highly_compensated": true,
"key_employee": true,
"bargaining": "bargaining",
"owner": true,
"president": "president",
"work_location": "254A",
"salary_grade": "A",
"dependents": [
{
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"current_qualifying_life_events": [
{
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {
"medical": "Hello, world!",
"dental": "Hello, world!",
"vision": "Hello, world!",
"voluntary_life": "Hello, world!",
"non_voluntary_life": "Hello, world!",
"accidental_death_dismemberment": "Hello, world!",
"voluntary_accidental_death_dismemberment": "Hello, world!",
"life_accidental_death_dismemberment": "Hello, world!",
"voluntary_life_accidental_death_dismemberment": "Hello, world!",
"short_term_disability": "Hello, world!",
"long_term_disability": "Hello, world!",
"hospital_indemnity": "Hello, world!",
"critical_illness": "Hello, world!",
"accident": "Hello, world!",
"cancer": "Hello, world!",
"legal": "Hello, world!"
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"subscriber": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"division": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the division"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A division used to group employees together based on the carrier group's defined account structure"
},
"department": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the department"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A department used to group employees together based on the carrier group's defined account structure"
},
"class": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the class"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"subgroup": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the subgroup"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": [
"string",
"null"
],
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"marital_status": {
"type": "string",
"enum": [
"registered_domestic_partner",
"divorced",
"single",
"married",
"separated",
"widowed"
]
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"type": "string",
"enum": [
"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"
]
},
"citizenship_status": {
"type": "string",
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"union": {
"type": "string",
"enum": [
"union",
"non_union"
],
"description": "Is the member a union or non-union employee?"
},
"executive": {
"type": "string",
"enum": [
"executive",
"non_executive"
],
"description": "Is the member an executive or non-executive employee?"
},
"management": {
"type": "string",
"enum": [
"management",
"non_management"
],
"description": "Is the member a management or non-management employee?"
},
"administrative": {
"type": "string",
"enum": [
"administrative",
"non_administrative"
],
"description": "Is the member an administrative or non-administrative employee?"
},
"exempt": {
"type": "string",
"enum": [
"exempt",
"non_exempt"
],
"description": "Is the member an exempt or non-exempt employee?"
},
"highly_compensated": {
"type": "boolean",
"description": "Is the member a highly compensated employee?"
},
"key_employee": {
"type": "boolean",
"description": "Is the member a key employee?"
},
"bargaining": {
"type": "string",
"enum": [
"bargaining",
"non_bargaining"
],
"description": "Is the member a bargaining or non-bargaining employee?"
},
"owner": {
"type": "boolean",
"description": "Is the member an owner of the business?"
},
"president": {
"type": "string",
"enum": [
"president",
"vice_president"
],
"description": "Is the member a president or vice president of the business?"
},
"work_location": {
"type": "string",
"description": "The member's work location/department within the employer's organization"
},
"salary_grade": {
"type": "string",
"description": "The member's salary grade"
},
"dependents": {
"type": "array",
"description": "Dependents associated with the subscriber"
},
"emails": {
"type": "array"
},
"employment_details": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "The date when the subscriber began full time employment with the group. In the event of a rehire provide the date of the rehire."
},
"end_date": {
"type": "string",
"description": "The date when the subscriber employment ended with the group"
},
"retirement_date": {
"type": "string",
"description": "The date the subscriber ended employment and entered retirement with the group"
},
"status": {
"type": "string",
"enum": [
"active",
"active_military_overseas",
"active_military_usa",
"full_time",
"leave_of_absence",
"part_time",
"retired",
"terminated"
],
"description": "The employment status of the subscriber"
},
"annual_earnings": {
"type": "number",
"description": "The annual earnings of the subscriber in cents Should reflect the annual salary or estimated hourly earnings."
},
"earnings_effective_date": {
"type": "string",
"description": "The date the subscriber's annual salary or estimated hourly earnings is effective"
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to the subscriber"
},
"hours_per_week": {
"type": "number",
"description": "The number of hours worked by the subscriber per week"
},
"compensation": {
"type": "string",
"enum": [
"hourly",
"salary"
],
"description": "Employment compensation is via salary or hourly?"
},
"title": {
"type": "string"
}
},
"required": [
"start_date",
"status"
]
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier for the resource"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"languages": {
"type": "array"
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"type": "string",
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array"
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"phone_numbers": {
"type": "array"
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"current_qualifying_life_events": {
"type": "array"
}
},
"required": [
"location_id",
"social_security_number",
"last_name",
"birth_date",
"gender",
"dependents",
"emails",
"employment_details",
"external_identifier",
"languages",
"phone_numbers",
"current_qualifying_life_events"
]
}
},
"required": [
"subscriber"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a SubscriberPOST/groups/{id}/subscribers
The Subscriber is a representation of the employee. In the response, you will receive an identifier for the Subscriber, as well as each Dependent should you choose to create the Dependents in this call.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
Groups Subscribers By Id ¶
GET /groups/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/subscribers?page=1&
per_page=100
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"subscribers": [
{
"status": "",
"status_datetime": "",
"errors": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": ""
}
],
"subscriber": {
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"marital_status": "registered_domestic_partner",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"union": "union",
"executive": "executive",
"management": "management",
"administrative": "administrative",
"exempt": "exempt",
"highly_compensated": true,
"key_employee": true,
"bargaining": "bargaining",
"owner": true,
"president": "president",
"work_location": "254A",
"salary_grade": "A",
"dependents": [
{
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"current_qualifying_life_events": [
{
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
]
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"subscribers": {
"type": "array",
"description": "The status of the group's subscribers"
}
},
"required": [
"subscribers"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List SubscribersGET/groups/{id}/subscribers{?page,per_page}
This paginated endpoint returns a all Subscribers for a Group. To paginate through the pages, please use the page and per_page path parameters. For more information on pagination, please see the
Pagination section.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
- page
number(optional) Example: 1The page number
- per_page
number(optional) Example: 100The resources returned per page
Subscribers By Id ¶
GET /subscribers/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"status": "",
"status_datetime": "",
"errors": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": ""
}
],
"subscriber": {
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"marital_status": "registered_domestic_partner",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"union": "union",
"executive": "executive",
"management": "management",
"administrative": "administrative",
"exempt": "exempt",
"highly_compensated": true,
"key_employee": true,
"bargaining": "bargaining",
"owner": true,
"president": "president",
"work_location": "254A",
"salary_grade": "A",
"dependents": [
{
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"current_qualifying_life_events": [
{
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"description": "Provide a group ID and receive the current status and subscriber details for each subscriber in the group\n\n- Synced: indicates that the subscriber and the subscriber's dependents are successfully synced and enrolled with the carrier and no errors have been identified by the carrier\n\n- Pending: indicates updates / changes have been received for the subscriber or the subscriber's dependents that have not yet been communicated to the carrier\n\n- Errors: indicates that the carrier has identified one or more errors regarding the transmission of updates / changes for the subscriber or the subscriber's dependents. Specific members that require action are identified and associated to a corresponding set of errors\n\n+ `pending`\n\n+ `synced`\n\n+ `errors`"
},
"status_datetime": {
"type": "string",
"description": "Date and time corresponding to the status"
},
"errors": {
"type": "array",
"description": "A list of errors provided by the carrier associated with the group"
},
"subscriber": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"division": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the division"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A division used to group employees together based on the carrier group's defined account structure"
},
"department": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the department"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A department used to group employees together based on the carrier group's defined account structure"
},
"class": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the class"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"subgroup": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the subgroup"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": [
"string",
"null"
],
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"marital_status": {
"type": "string",
"enum": [
"registered_domestic_partner",
"divorced",
"single",
"married",
"separated",
"widowed"
]
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"type": "string",
"enum": [
"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"
]
},
"citizenship_status": {
"type": "string",
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"union": {
"type": "string",
"enum": [
"union",
"non_union"
],
"description": "Is the member a union or non-union employee?"
},
"executive": {
"type": "string",
"enum": [
"executive",
"non_executive"
],
"description": "Is the member an executive or non-executive employee?"
},
"management": {
"type": "string",
"enum": [
"management",
"non_management"
],
"description": "Is the member a management or non-management employee?"
},
"administrative": {
"type": "string",
"enum": [
"administrative",
"non_administrative"
],
"description": "Is the member an administrative or non-administrative employee?"
},
"exempt": {
"type": "string",
"enum": [
"exempt",
"non_exempt"
],
"description": "Is the member an exempt or non-exempt employee?"
},
"highly_compensated": {
"type": "boolean",
"description": "Is the member a highly compensated employee?"
},
"key_employee": {
"type": "boolean",
"description": "Is the member a key employee?"
},
"bargaining": {
"type": "string",
"enum": [
"bargaining",
"non_bargaining"
],
"description": "Is the member a bargaining or non-bargaining employee?"
},
"owner": {
"type": "boolean",
"description": "Is the member an owner of the business?"
},
"president": {
"type": "string",
"enum": [
"president",
"vice_president"
],
"description": "Is the member a president or vice president of the business?"
},
"work_location": {
"type": "string",
"description": "The member's work location/department within the employer's organization"
},
"salary_grade": {
"type": "string",
"description": "The member's salary grade"
},
"dependents": {
"type": "array",
"description": "Dependents associated with the subscriber"
},
"emails": {
"type": "array"
},
"employment_details": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "The date when the subscriber began full time employment with the group. In the event of a rehire provide the date of the rehire."
},
"end_date": {
"type": "string",
"description": "The date when the subscriber employment ended with the group"
},
"retirement_date": {
"type": "string",
"description": "The date the subscriber ended employment and entered retirement with the group"
},
"status": {
"type": "string",
"enum": [
"active",
"active_military_overseas",
"active_military_usa",
"full_time",
"leave_of_absence",
"part_time",
"retired",
"terminated"
],
"description": "The employment status of the subscriber"
},
"annual_earnings": {
"type": "number",
"description": "The annual earnings of the subscriber in cents Should reflect the annual salary or estimated hourly earnings."
},
"earnings_effective_date": {
"type": "string",
"description": "The date the subscriber's annual salary or estimated hourly earnings is effective"
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to the subscriber"
},
"hours_per_week": {
"type": "number",
"description": "The number of hours worked by the subscriber per week"
},
"compensation": {
"type": "string",
"enum": [
"hourly",
"salary"
],
"description": "Employment compensation is via salary or hourly?"
},
"title": {
"type": "string"
}
},
"required": [
"start_date",
"status"
]
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier for the resource"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"languages": {
"type": "array"
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"type": "string",
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array"
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"phone_numbers": {
"type": "array"
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"current_qualifying_life_events": {
"type": "array"
}
},
"required": [
"location_id",
"social_security_number",
"last_name",
"birth_date",
"gender",
"dependents",
"emails",
"employment_details",
"external_identifier",
"languages",
"phone_numbers",
"current_qualifying_life_events"
],
"description": "The subscriber record"
}
},
"required": [
"status",
"status_datetime",
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Retrieve a SubscriberGET/subscribers/{id}
This endpoint returns a particular Subscriber resource.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the subscriber
PUT /subscribers/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"subscriber": {
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"marital_status": "registered_domestic_partner",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"union": "union",
"executive": "executive",
"management": "management",
"administrative": "administrative",
"exempt": "exempt",
"highly_compensated": true,
"key_employee": true,
"bargaining": "bargaining",
"owner": true,
"president": "president",
"work_location": "254A",
"salary_grade": "A",
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"external_identifier": "ABC-132A54",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
}
}
}Schema
{
"type": "object",
"properties": {
"subscriber": {
"type": "object",
"properties": {
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": [
"string",
"null"
],
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"marital_status": {
"enum": [
"registered_domestic_partner",
"divorced",
"single",
"married",
"separated",
"widowed"
]
},
"gender": {
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"enum": [
"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"
]
},
"citizenship_status": {
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"union": {
"enum": [
"union",
"non_union"
],
"description": "Is the member a union or non-union employee?"
},
"executive": {
"enum": [
"executive",
"non_executive"
],
"description": "Is the member an executive or non-executive employee?"
},
"management": {
"enum": [
"management",
"non_management"
],
"description": "Is the member a management or non-management employee?"
},
"administrative": {
"enum": [
"administrative",
"non_administrative"
],
"description": "Is the member an administrative or non-administrative employee?"
},
"exempt": {
"enum": [
"exempt",
"non_exempt"
],
"description": "Is the member an exempt or non-exempt employee?"
},
"highly_compensated": {
"type": "boolean",
"description": "Is the member a highly compensated employee?"
},
"key_employee": {
"type": "boolean",
"description": "Is the member a key employee?"
},
"bargaining": {
"enum": [
"bargaining",
"non_bargaining"
],
"description": "Is the member a bargaining or non-bargaining employee?"
},
"owner": {
"type": "boolean",
"description": "Is the member an owner of the business?"
},
"president": {
"enum": [
"president",
"vice_president"
],
"description": "Is the member a president or vice president of the business?"
},
"work_location": {
"type": "string",
"description": "The member's work location/department within the employer's organization"
},
"salary_grade": {
"type": "string",
"description": "The member's salary grade"
},
"class": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the class"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"department": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the department"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A department used to group employees together based on the carrier group's defined account structure"
},
"division": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the division"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A division used to group employees together based on the carrier group's defined account structure"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"personal",
"work",
"other"
],
"description": "The type of email"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"employment_details": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "The date when the subscriber began full time employment with the group. In the event of a rehire provide the date of the rehire."
},
"end_date": {
"type": "string",
"description": "The date when the subscriber employment ended with the group"
},
"retirement_date": {
"type": "string",
"description": "The date the subscriber ended employment and entered retirement with the group"
},
"status": {
"enum": [
"active",
"active_military_overseas",
"active_military_usa",
"full_time",
"leave_of_absence",
"part_time",
"retired",
"terminated"
],
"description": "The employment status of the subscriber"
},
"annual_earnings": {
"type": "number",
"description": "The annual earnings of the subscriber in cents Should reflect the annual salary or estimated hourly earnings."
},
"earnings_effective_date": {
"type": "string",
"description": "The date the subscriber's annual salary or estimated hourly earnings is effective"
},
"wage_frequency": {
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to the subscriber"
},
"hours_per_week": {
"type": "number",
"description": "The number of hours worked by the subscriber per week"
},
"compensation": {
"enum": [
"hourly",
"salary"
],
"description": "Employment compensation is via salary or hourly?"
},
"title": {
"type": "string"
}
},
"required": [
"start_date",
"status"
]
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Member language name"
},
"language_proficiency": {
"enum": [
"reading",
"writing",
"speaking",
"native_language"
],
"description": "Member's proficiency of use for the given language: reading, writing, speaking, native_language"
}
},
"description": "Member language and proficiency if not English"
}
},
"location_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"medical",
"prescription",
"hospital",
"medicare_advantage"
],
"description": "The member's Medicare type"
},
"start_date": {
"type": "string",
"description": "The member's Medicare effective coverage start date"
},
"end_date": {
"type": "string",
"description": "The member's Medicare effective coverage end date"
}
},
"required": [
"type",
"start_date"
]
}
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"other",
"beeper",
"mobile",
"fax",
"home",
"work"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"subgroup": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the subgroup"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
}
},
"required": [
"social_security_number",
"last_name",
"birth_date",
"gender",
"employment_details",
"external_identifier",
"location_id",
"residential_address"
],
"description": "The subscriber electing to enroll or waive coverage"
}
},
"required": [
"subscriber"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Resource Updated Successfully
Headers
Content-Type: application/jsonBody
{
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"marital_status": "registered_domestic_partner",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"union": "union",
"executive": "executive",
"management": "management",
"administrative": "administrative",
"exempt": "exempt",
"highly_compensated": true,
"key_employee": true,
"bargaining": "bargaining",
"owner": true,
"president": "president",
"work_location": "254A",
"salary_grade": "A",
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"external_identifier": "ABC-132A54",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": [
"string",
"null"
],
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"marital_status": {
"type": "string",
"enum": [
"registered_domestic_partner",
"divorced",
"single",
"married",
"separated",
"widowed"
]
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"type": "string",
"enum": [
"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"
]
},
"citizenship_status": {
"type": "string",
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"union": {
"type": "string",
"enum": [
"union",
"non_union"
],
"description": "Is the member a union or non-union employee?"
},
"executive": {
"type": "string",
"enum": [
"executive",
"non_executive"
],
"description": "Is the member an executive or non-executive employee?"
},
"management": {
"type": "string",
"enum": [
"management",
"non_management"
],
"description": "Is the member a management or non-management employee?"
},
"administrative": {
"type": "string",
"enum": [
"administrative",
"non_administrative"
],
"description": "Is the member an administrative or non-administrative employee?"
},
"exempt": {
"type": "string",
"enum": [
"exempt",
"non_exempt"
],
"description": "Is the member an exempt or non-exempt employee?"
},
"highly_compensated": {
"type": "boolean",
"description": "Is the member a highly compensated employee?"
},
"key_employee": {
"type": "boolean",
"description": "Is the member a key employee?"
},
"bargaining": {
"type": "string",
"enum": [
"bargaining",
"non_bargaining"
],
"description": "Is the member a bargaining or non-bargaining employee?"
},
"owner": {
"type": "boolean",
"description": "Is the member an owner of the business?"
},
"president": {
"type": "string",
"enum": [
"president",
"vice_president"
],
"description": "Is the member a president or vice president of the business?"
},
"work_location": {
"type": "string",
"description": "The member's work location/department within the employer's organization"
},
"salary_grade": {
"type": "string",
"description": "The member's salary grade"
},
"class": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the class"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"department": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the department"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A department used to group employees together based on the carrier group's defined account structure"
},
"division": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the division"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A division used to group employees together based on the carrier group's defined account structure"
},
"emails": {
"type": "array"
},
"employment_details": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "The date when the subscriber began full time employment with the group. In the event of a rehire provide the date of the rehire."
},
"end_date": {
"type": "string",
"description": "The date when the subscriber employment ended with the group"
},
"retirement_date": {
"type": "string",
"description": "The date the subscriber ended employment and entered retirement with the group"
},
"status": {
"type": "string",
"enum": [
"active",
"active_military_overseas",
"active_military_usa",
"full_time",
"leave_of_absence",
"part_time",
"retired",
"terminated"
],
"description": "The employment status of the subscriber"
},
"annual_earnings": {
"type": "number",
"description": "The annual earnings of the subscriber in cents Should reflect the annual salary or estimated hourly earnings."
},
"earnings_effective_date": {
"type": "string",
"description": "The date the subscriber's annual salary or estimated hourly earnings is effective"
},
"wage_frequency": {
"type": "string",
"enum": [
"weekly",
"biweekly",
"semimonthly",
"monthly",
"daily",
"annually",
"hourly",
"quarterly",
"semiannually",
"unknown"
],
"description": "The frequency of wages paid to the subscriber"
},
"hours_per_week": {
"type": "number",
"description": "The number of hours worked by the subscriber per week"
},
"compensation": {
"type": "string",
"enum": [
"hourly",
"salary"
],
"description": "Employment compensation is via salary or hourly?"
},
"title": {
"type": "string"
}
},
"required": [
"start_date",
"status"
]
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"languages": {
"type": "array"
},
"location_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"type": "string",
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array"
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"phone_numbers": {
"type": "array"
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"subgroup": {
"type": [
"object",
"null"
],
"properties": {
"employment_classification_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"effective_date": {
"type": "string",
"description": "The effective date the subscriber became a part of the subgroup"
}
},
"required": [
"employment_classification_id",
"effective_date"
],
"description": "A class used to group employees together based on the carrier group's defined account structure"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"social_security_number",
"last_name",
"birth_date",
"gender",
"emails",
"employment_details",
"external_identifier",
"location_id",
"residential_address",
"id"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a SubscriberPUT/subscribers/{id}
Update a Subscriber resource. Note that only Subscriber details can be updated in this endpoint. To update Dependent information, use the Update Dependents endpoint. To update coverage, use the Create Qualifying Life Events endpoint.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the subscriber
Dependents ¶
Subscribers Dependents By Id ¶
POST /subscribers/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/dependents
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"dependent": {
"external_identifier": "ABC-132A54",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"social_security_number": "222222222",
"gender": "male",
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"handicapped": true,
"subscriber_relationship": "child",
"student_status": "full_time",
"birth_date": "1980-01-01",
"height": 62,
"weight": 123,
"tobacco_use": false,
"substance_abuse": true,
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
}Schema
{
"type": "object",
"properties": {
"dependent": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier to uniquely identify the resource"
},
"first_name": {
"type": "string"
},
"middle_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"name_prefix": {
"type": "string"
},
"name_suffix": {
"type": [
"string",
"null"
]
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"gender": {
"enum": [
"male",
"female",
"unknown"
]
},
"race_ethnicity": {
"enum": [
"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"
]
},
"citizenship_status": {
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"handicapped": {
"type": "boolean"
},
"subscriber_relationship": {
"enum": [
"child",
"grandchild",
"registered_domestic_partner",
"spouse",
"court_ordered_dependent"
]
},
"student_status": {
"enum": [
"full_time",
"not_a_student",
"part_time"
],
"description": "The student status of the member"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Member language name"
},
"language_proficiency": {
"enum": [
"reading",
"writing",
"speaking",
"native_language"
],
"description": "Member's proficiency of use for the given language: reading, writing, speaking, native_language"
}
},
"description": "Member language and proficiency if not English"
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"personal",
"work",
"other"
],
"description": "The type of email"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"other",
"beeper",
"mobile",
"fax",
"home",
"work"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"medical",
"prescription",
"hospital",
"medicare_advantage"
],
"description": "The member's Medicare type"
},
"start_date": {
"type": "string",
"description": "The member's Medicare effective coverage start date"
},
"end_date": {
"type": "string",
"description": "The member's Medicare effective coverage end date"
}
},
"required": [
"type",
"start_date"
]
}
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"schools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"work",
"fax"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"name": {
"type": "string",
"description": "The name of the member's school"
}
},
"required": [
"name"
]
}
}
},
"required": [
"external_identifier",
"last_name",
"gender",
"subscriber_relationship",
"birth_date"
]
}
},
"required": [
"dependent"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"dependent": {
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"dependent": {
"type": "object",
"properties": {
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": "string",
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"subscriber_relationship": {
"type": "string",
"enum": [
"child",
"grandchild",
"registered_domestic_partner",
"spouse",
"court_ordered_dependent"
]
},
"student_status": {
"type": "string",
"enum": [
"full_time",
"not_a_student",
"part_time"
],
"description": "The student status of the member"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"type": "string",
"enum": [
"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"
]
},
"citizenship_status": {
"type": "string",
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"emails": {
"type": "array"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"languages": {
"type": "array"
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"type": "string",
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array"
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"phone_numbers": {
"type": "array"
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"schools": {
"type": "array",
"description": "A list of the school(s) associated with the member"
}
},
"required": [
"last_name",
"birth_date",
"subscriber_relationship",
"gender",
"emails",
"external_identifier",
"id",
"languages",
"medicare",
"phone_numbers",
"schools"
]
}
},
"required": [
"dependent"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a DependentPOST/subscribers/{id}/dependents
Use a qualifying life event to add a new dependent to an existing subscriber
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the subscriber
Dependents By Id ¶
PUT /dependents/b37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"dependent": {
"external_identifier": "ABC-132A54",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
],
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien"
}
}Schema
{
"type": "object",
"properties": {
"dependent": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier for the resource"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Member language name"
},
"language_proficiency": {
"enum": [
"reading",
"writing",
"speaking",
"native_language"
],
"description": "Member's proficiency of use for the given language: reading, writing, speaking, native_language"
}
},
"description": "Member language and proficiency if not English"
},
"description": "Member language(s) and proficiency if not English"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"personal",
"work",
"other"
],
"description": "The type of email"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"other",
"beeper",
"mobile",
"fax",
"home",
"work"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"medical",
"prescription",
"hospital",
"medicare_advantage"
],
"description": "The member's Medicare type"
},
"start_date": {
"type": "string",
"description": "The member's Medicare effective coverage start date"
},
"end_date": {
"type": "string",
"description": "The member's Medicare effective coverage end date"
}
},
"required": [
"type",
"start_date"
]
}
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"schools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contact": {
"type": "string",
"description": "The email for the corresponding to the contact type"
}
},
"required": [
"type",
"contact"
]
}
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"work",
"fax"
],
"description": "The type of number provided"
},
"contact": {
"type": "string",
"description": "A phone number based on E.164 phone number formatting: [+][country code][subscriber number including area code]. Note: some issuers do not support international numbers, currently only facilitating domestic numbers"
}
},
"required": [
"type",
"contact"
]
}
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"zip"
]
},
"name": {
"type": "string",
"description": "The name of the member's school"
}
},
"required": [
"name"
]
},
"description": "A list of the school(s) associated with the member"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": "string",
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"subscriber_relationship": {
"enum": [
"child",
"grandchild",
"registered_domestic_partner",
"spouse",
"court_ordered_dependent"
]
},
"student_status": {
"enum": [
"full_time",
"not_a_student",
"part_time"
],
"description": "The student status of the member"
},
"gender": {
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"enum": [
"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"
]
},
"citizenship_status": {
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
}
},
"required": [
"external_identifier",
"last_name",
"birth_date",
"subscriber_relationship",
"gender"
]
}
},
"required": [
"dependent"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Resource Updated Successfully
Headers
Content-Type: application/jsonBody
{
"dependent": {
"external_identifier": "ABC-132A54",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
],
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"dependent": {
"type": "object",
"properties": {
"external_identifier": {
"type": "string",
"description": "A platform defined identifier for the resource"
},
"languages": {
"type": "array",
"description": "Member language(s) and proficiency if not English"
},
"emails": {
"type": "array"
},
"phone_numbers": {
"type": "array"
},
"residential_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"mailing_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address line 1"
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "Street address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "Two Letter State/Territory Abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
},
"fips_county_code": {
"type": [
"string",
"null"
],
"description": "Five-digit Federal Information Processing Standards (FIPS) code uniquely identifying counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states"
},
"country_code": {
"type": "string",
"enum": [
"USA"
],
"description": "ISO 3166-1 alpha3 country code. If not provided, defaults to USA."
}
},
"required": [
"address_line_1",
"city",
"state",
"zip"
]
},
"medicare": {
"type": "object",
"properties": {
"medicare_beneficiary_identifier": {
"type": "string",
"description": "The member's Medicare Beneficiary Identifier (MBI)"
},
"eligibility": {
"type": "string",
"enum": [
"age",
"disability",
"end_stage_renal_disease",
"not_eligible"
],
"description": "The member's primary reason for Medicare eligibility"
},
"eligibility_start_date": {
"type": "string",
"description": "The date the member first becomes eligible for Medicare"
},
"enrolled": {
"type": "boolean",
"description": "A member is currently enrolled in Medicare."
},
"coverages": {
"type": "array"
}
},
"required": [
"coverages"
],
"description": "Does the member have Medicare coverage?"
},
"schools": {
"type": "array",
"description": "A list of the school(s) associated with the member"
},
"social_security_number": {
"type": "string",
"description": "Social security number (SSN)"
},
"first_name": {
"type": "string",
"description": "The member's first name"
},
"middle_name": {
"type": "string",
"description": "The member's middle name or middle initial"
},
"last_name": {
"type": "string",
"description": "The member's last name"
},
"name_prefix": {
"type": "string",
"description": "The member's name prefix"
},
"name_suffix": {
"type": "string",
"description": "The member's name suffix"
},
"birth_date": {
"type": "string",
"description": "Date of birth"
},
"subscriber_relationship": {
"type": "string",
"enum": [
"child",
"grandchild",
"registered_domestic_partner",
"spouse",
"court_ordered_dependent"
]
},
"student_status": {
"type": "string",
"enum": [
"full_time",
"not_a_student",
"part_time"
],
"description": "The student status of the member"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"unknown"
],
"description": "The member's gender"
},
"handicapped": {
"type": "boolean",
"description": "Indicate the member's disability or handicap status"
},
"tobacco_use": {
"type": [
"boolean",
"null"
],
"description": "Indicate if the member uses nicotine/tobacco products as defined by a carrier's underwriting guidelines. For states and plans that do not allow tobacco rating, indicate false."
},
"substance_abuse": {
"type": "boolean",
"description": "Does the member have a history of substance abuse?"
},
"height": {
"type": "number",
"description": "Member height in inches"
},
"weight": {
"type": "number",
"description": "Member weight in pounds (lbs)"
},
"race_ethnicity": {
"type": "string",
"enum": [
"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"
]
},
"citizenship_status": {
"type": "string",
"enum": [
"alien",
"alien_non_resident",
"alien_resident",
"illegal_alien",
"us_citizen",
"us_citizen_non_resident",
"us_citizen_resident"
]
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
}
},
"required": [
"external_identifier",
"last_name",
"birth_date",
"subscriber_relationship",
"gender",
"id"
]
}
},
"required": [
"dependent"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a DependentPUT/dependents/{id}
Update a Dependent resource.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the dependent
Qualifying Life Events ¶
Subscribers Qualifying Life Events By Id ¶
POST /subscribers/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/qualifying_life_events
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"qualifying_life_event": {
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {
"medical": "Hello, world!",
"dental": "Hello, world!",
"vision": "Hello, world!",
"voluntary_life": "Hello, world!",
"non_voluntary_life": "Hello, world!",
"accidental_death_dismemberment": "Hello, world!",
"voluntary_accidental_death_dismemberment": "Hello, world!",
"life_accidental_death_dismemberment": "Hello, world!",
"voluntary_life_accidental_death_dismemberment": "Hello, world!",
"short_term_disability": "Hello, world!",
"long_term_disability": "Hello, world!",
"hospital_indemnity": "Hello, world!",
"critical_illness": "Hello, world!",
"accident": "Hello, world!",
"cancer": "Hello, world!",
"legal": "Hello, world!"
}
}
}Schema
{
"type": "object",
"properties": {
"qualifying_life_event": {
"type": "object",
"properties": {
"event": {
"enum": [
"birth",
"cobra",
"divorce",
"initial_enrollment",
"loss_of_coverage",
"marriage",
"new_hire",
"newly_eligible",
"open_enrollment",
"termination_of_employment",
"re_hire"
],
"description": "Event which triggered this coverage change"
},
"date": {
"type": "string",
"description": "The date associated with the qualifying life event (QLE) or life status change"
},
"received_date": {
"type": "string",
"description": "The date the subscriber submitted the enrollment form / request"
},
"enrollment_signature_date": {
"type": "string",
"description": "The date the subscriber signed the enrollment form / request"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"eligibility_start_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"eligibility_end_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"plan_elections": {
"type": "object",
"properties": {
"medical": {
"type": "string"
},
"dental": {
"type": "string"
},
"vision": {
"type": "string"
},
"voluntary_life": {
"type": "string"
},
"non_voluntary_life": {
"type": "string"
},
"accidental_death_dismemberment": {
"type": "string"
},
"voluntary_accidental_death_dismemberment": {
"type": "string"
},
"life_accidental_death_dismemberment": {
"type": "string"
},
"voluntary_life_accidental_death_dismemberment": {
"type": "string"
},
"short_term_disability": {
"type": "string"
},
"long_term_disability": {
"type": "string"
},
"hospital_indemnity": {
"type": "string"
},
"critical_illness": {
"type": "string"
},
"accident": {
"type": "string"
},
"cancer": {
"type": "string"
},
"legal": {
"type": "string"
}
},
"description": "The plan elections for each product line"
}
},
"required": [
"event",
"date",
"eligibility_start_date",
"coverage_period_id",
"plan_elections"
]
}
},
"required": [
"qualifying_life_event"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"qualifying_life_event": {
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {
"medical": "Hello, world!",
"dental": "Hello, world!",
"vision": "Hello, world!",
"voluntary_life": "Hello, world!",
"non_voluntary_life": "Hello, world!",
"accidental_death_dismemberment": "Hello, world!",
"voluntary_accidental_death_dismemberment": "Hello, world!",
"life_accidental_death_dismemberment": "Hello, world!",
"voluntary_life_accidental_death_dismemberment": "Hello, world!",
"short_term_disability": "Hello, world!",
"long_term_disability": "Hello, world!",
"hospital_indemnity": "Hello, world!",
"critical_illness": "Hello, world!",
"accident": "Hello, world!",
"cancer": "Hello, world!",
"legal": "Hello, world!"
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"qualifying_life_event": {
"type": "object",
"properties": {
"event": {
"type": "string",
"enum": [
"birth",
"cobra",
"divorce",
"initial_enrollment",
"loss_of_coverage",
"marriage",
"new_hire",
"newly_eligible",
"open_enrollment",
"termination_of_employment",
"re_hire"
],
"description": "Event which triggered this coverage change"
},
"date": {
"type": "string",
"description": "The date associated with the qualifying life event (QLE) or life status change"
},
"received_date": {
"type": "string",
"description": "The date the subscriber submitted the enrollment form / request"
},
"enrollment_signature_date": {
"type": "string",
"description": "The date the subscriber signed the enrollment form / request"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"eligibility_start_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"eligibility_end_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"plan_elections": {
"type": "object",
"properties": {
"medical": {
"type": "string"
},
"dental": {
"type": "string"
},
"vision": {
"type": "string"
},
"voluntary_life": {
"type": "string"
},
"non_voluntary_life": {
"type": "string"
},
"accidental_death_dismemberment": {
"type": "string"
},
"voluntary_accidental_death_dismemberment": {
"type": "string"
},
"life_accidental_death_dismemberment": {
"type": "string"
},
"voluntary_life_accidental_death_dismemberment": {
"type": "string"
},
"short_term_disability": {
"type": "string"
},
"long_term_disability": {
"type": "string"
},
"hospital_indemnity": {
"type": "string"
},
"critical_illness": {
"type": "string"
},
"accident": {
"type": "string"
},
"cancer": {
"type": "string"
},
"legal": {
"type": "string"
}
},
"description": "The plan elections for each product line"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"status": {
"type": "string",
"enum": [
"pending",
"submitted",
"synced",
"errors",
"superseded"
],
"description": "Status of this QLE with regards to delivery to the carrier"
}
},
"required": [
"event",
"date",
"eligibility_start_date",
"coverage_period_id",
"plan_elections",
"id",
"status"
]
}
},
"required": [
"qualifying_life_event"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Create a QLEPOST/subscribers/{id}/qualifying_life_events
A Qualifying Life Event includes the coverage elections for a Subscriber and their family. Ideon uses this information to discern what coverages to pass along to the carrier.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the subscriber
GET /subscribers/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/qualifying_life_events
Responses
Subscriber Qualifying Life Events Request Received
Headers
Content-Type: application/jsonBody
{
"qualifying_life_events": [
{
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {
"medical": "Hello, world!",
"dental": "Hello, world!",
"vision": "Hello, world!",
"voluntary_life": "Hello, world!",
"non_voluntary_life": "Hello, world!",
"accidental_death_dismemberment": "Hello, world!",
"voluntary_accidental_death_dismemberment": "Hello, world!",
"life_accidental_death_dismemberment": "Hello, world!",
"voluntary_life_accidental_death_dismemberment": "Hello, world!",
"short_term_disability": "Hello, world!",
"long_term_disability": "Hello, world!",
"hospital_indemnity": "Hello, world!",
"critical_illness": "Hello, world!",
"accident": "Hello, world!",
"cancer": "Hello, world!",
"legal": "Hello, world!"
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"qualifying_life_events": {
"type": "array"
}
},
"required": [
"qualifying_life_events"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List QLEsGET/subscribers/{id}/qualifying_life_events
This endpoint lists all Qualifying Life Events passed for a Subscriber in descending order from when they were created. Qualifying Life Events returned will span Coverage Periods in which the Subsciber has coverage.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the subscriber
Qualifying Life Events By Id ¶
PUT /qualifying_life_events/b37ecd06-5d97-46e4-9b4e-dcde6a03246f
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"qualifying_life_event": {
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {
"medical": "Hello, world!",
"dental": "Hello, world!",
"vision": "Hello, world!",
"voluntary_life": "Hello, world!",
"non_voluntary_life": "Hello, world!",
"accidental_death_dismemberment": "Hello, world!",
"voluntary_accidental_death_dismemberment": "Hello, world!",
"life_accidental_death_dismemberment": "Hello, world!",
"voluntary_life_accidental_death_dismemberment": "Hello, world!",
"short_term_disability": "Hello, world!",
"long_term_disability": "Hello, world!",
"hospital_indemnity": "Hello, world!",
"critical_illness": "Hello, world!",
"accident": "Hello, world!",
"cancer": "Hello, world!",
"legal": "Hello, world!"
}
}
}Schema
{
"type": "object",
"properties": {
"qualifying_life_event": {
"type": "object",
"properties": {
"event": {
"enum": [
"birth",
"cobra",
"divorce",
"initial_enrollment",
"loss_of_coverage",
"marriage",
"new_hire",
"newly_eligible",
"open_enrollment",
"termination_of_employment",
"re_hire"
],
"description": "Event which triggered this coverage change"
},
"date": {
"type": "string",
"description": "The date associated with the qualifying life event (QLE) or life status change"
},
"received_date": {
"type": "string",
"description": "The date the subscriber submitted the enrollment form / request"
},
"enrollment_signature_date": {
"type": "string",
"description": "The date the subscriber signed the enrollment form / request"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"eligibility_start_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"eligibility_end_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"plan_elections": {
"type": "object",
"properties": {
"medical": {
"type": "string"
},
"dental": {
"type": "string"
},
"vision": {
"type": "string"
},
"voluntary_life": {
"type": "string"
},
"non_voluntary_life": {
"type": "string"
},
"accidental_death_dismemberment": {
"type": "string"
},
"voluntary_accidental_death_dismemberment": {
"type": "string"
},
"life_accidental_death_dismemberment": {
"type": "string"
},
"voluntary_life_accidental_death_dismemberment": {
"type": "string"
},
"short_term_disability": {
"type": "string"
},
"long_term_disability": {
"type": "string"
},
"hospital_indemnity": {
"type": "string"
},
"critical_illness": {
"type": "string"
},
"accident": {
"type": "string"
},
"cancer": {
"type": "string"
},
"legal": {
"type": "string"
}
},
"description": "The plan elections for each product line"
}
},
"required": [
"event",
"date",
"eligibility_start_date",
"coverage_period_id",
"plan_elections"
]
}
},
"required": [
"qualifying_life_event"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"qualifying_life_event": {
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {
"medical": "Hello, world!",
"dental": "Hello, world!",
"vision": "Hello, world!",
"voluntary_life": "Hello, world!",
"non_voluntary_life": "Hello, world!",
"accidental_death_dismemberment": "Hello, world!",
"voluntary_accidental_death_dismemberment": "Hello, world!",
"life_accidental_death_dismemberment": "Hello, world!",
"voluntary_life_accidental_death_dismemberment": "Hello, world!",
"short_term_disability": "Hello, world!",
"long_term_disability": "Hello, world!",
"hospital_indemnity": "Hello, world!",
"critical_illness": "Hello, world!",
"accident": "Hello, world!",
"cancer": "Hello, world!",
"legal": "Hello, world!"
},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"qualifying_life_event": {
"type": "object",
"properties": {
"event": {
"type": "string",
"enum": [
"birth",
"cobra",
"divorce",
"initial_enrollment",
"loss_of_coverage",
"marriage",
"new_hire",
"newly_eligible",
"open_enrollment",
"termination_of_employment",
"re_hire"
],
"description": "Event which triggered this coverage change"
},
"date": {
"type": "string",
"description": "The date associated with the qualifying life event (QLE) or life status change"
},
"received_date": {
"type": "string",
"description": "The date the subscriber submitted the enrollment form / request"
},
"enrollment_signature_date": {
"type": "string",
"description": "The date the subscriber signed the enrollment form / request"
},
"external_identifier": {
"type": "string",
"description": "A platform defined identifier"
},
"eligibility_start_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"eligibility_end_date": {
"type": "string",
"description": "Start date of the subscriber's eligibility"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"plan_elections": {
"type": "object",
"properties": {
"medical": {
"type": "string"
},
"dental": {
"type": "string"
},
"vision": {
"type": "string"
},
"voluntary_life": {
"type": "string"
},
"non_voluntary_life": {
"type": "string"
},
"accidental_death_dismemberment": {
"type": "string"
},
"voluntary_accidental_death_dismemberment": {
"type": "string"
},
"life_accidental_death_dismemberment": {
"type": "string"
},
"voluntary_life_accidental_death_dismemberment": {
"type": "string"
},
"short_term_disability": {
"type": "string"
},
"long_term_disability": {
"type": "string"
},
"hospital_indemnity": {
"type": "string"
},
"critical_illness": {
"type": "string"
},
"accident": {
"type": "string"
},
"cancer": {
"type": "string"
},
"legal": {
"type": "string"
}
},
"description": "The plan elections for each product line"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"status": {
"type": "string",
"enum": [
"pending",
"submitted",
"synced",
"errors",
"superseded"
],
"description": "Status of this QLE with regards to delivery to the carrier"
}
},
"required": [
"event",
"date",
"eligibility_start_date",
"coverage_period_id",
"plan_elections",
"id",
"status"
]
}
},
"required": [
"qualifying_life_event"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Update a QLEPUT/qualifying_life_events/{id}
A Qualifying Life Event includes the coverage elections for a Subscriber and their family. Ideon uses this information to discern what coverages to pass along to the carrier. Use this endpoint to update an existing Qualifying Life Event. Please note that this endpoint should not be used to add new coverages to a Subscriber, but rather in the rare scenario in which you need to alter the past. The main use case for this endpoint is for Group Installments, in which you are trying to apply for insurance for the first time with a carrier.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the subscriber
Enrollment Problems ¶
Coverage Periods Errors By Id ¶
GET /coverage_periods/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/errors?status=&
assignee=
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "Hello, world!",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the coverage period"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List Enrollment ProblemsGET/coverage_periods/{id}/errors{?status,assignee}
An Enrollment Problem, or Coverage Period error, is a reconciliation issue that should be addressed by either the partner or Ideon. Each Enrollment Problem has an assigned severity, which helps indicate the level of importance.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
- status
string(optional)The resolution status of the error
Choices:
unresolvedresolved- assignee
string(optional)The assignee of the error
Choices:
vericredpartner
Errors Comments By Id ¶
POST /errors/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/comments
Requests
Headers
Content-Type: application/jsonBody
{
"comment": {
"message": "We are working with the group to retrieve this information."
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"comment": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
},
"required": [
"comment"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"comment": {
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"comment": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"error_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"sent_by": {
"type": "string"
},
"created_at": {
"type": "string"
}
},
"required": [
"message"
]
}
},
"required": [
"comment"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Comment on an Enrollment ProblemPOST/errors/{id}/comments
This endpoint allows you to respond with a comment to an Enrollment Problem.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the Enrollment Problem
Errors Resolution By Id ¶
POST /errors/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/resolution
Requests
Headers
Content-Type: application/jsonBody
{
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The message indicating what was done to resolve the error"
}
},
"required": [
"message"
]
}Responses
Resource Created Successfully
Headers
Content-Type: application/jsonBody
{
"error": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "Hello, world!",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"member_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"plan_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"census_requests": {
"type": "array"
},
"severity": {
"type": "string",
"enum": [
"info",
"warning",
"failure"
],
"description": "The severity of the error"
},
"message": {
"type": "string",
"description": "A clear description of the error message"
},
"assignee": {
"type": "string",
"enum": [
"partner",
"vericred"
],
"description": "The party assigned to resolve the error"
},
"discrepancy": {
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"social_security_number",
"birth_date",
"gender",
"marital_status",
"employment_start_date",
"employment_end_date",
"annual_earnings",
"wage_frequency",
"employment_status",
"residential_address",
"primary_care_provider",
"plan_id",
"plan_start_date",
"plan_end_date",
"subscriber",
"dependent",
"coverage",
"plan_volume"
],
"description": "Census request field that contains discrepancy"
},
"carrier": {
"type": [
"string",
"null"
],
"description": "Ops input carrier value"
},
"platform": {
"type": [
"string",
"null"
],
"description": "Ops input platform value"
}
},
"required": [
"parameter",
"carrier",
"platform"
]
},
"status": {
"type": "string",
"enum": [
"resolved",
"unresolved",
"returned"
],
"description": "The resolution status of the error"
},
"resolution": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The message indicating what was done to resolve the error"
},
"created_at": {
"type": "string",
"description": "The date the error was resolved"
},
"resolved_by": {
"type": "string",
"enum": [
"partner",
"vericred"
],
"description": "The party that resolved the error"
}
},
"required": [
"message",
"created_at"
],
"description": "The resolution details for a resolved error"
},
"comments": {
"type": "array",
"description": "A list of comments about the error"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"coverage_period_id",
"message",
"status",
"created_at"
]
}
},
"required": [
"error"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Resolve an Enrollment ProblemPOST/errors/{id}/resolution
This endpoint allows you mark an Enrollment Problem problem as resolved and provide a resolution message for the record.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the enrollment problem
Supporting Documents ¶
Coverage Periods Supporting Documents ¶
GET /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/supporting_documents
Responses
Coverage Period Supporting Documents Returned
Headers
Content-Type: application/jsonBody
{
"supporting_documents": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "unsubmitted",
"document_type": "form",
"created_at": "2022-01-01",
"qualifying_life_event_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"qualifying_life_event_type": "birth",
"incomplete_document_url": "https://example.com",
"completed_document_url": "https://example.com"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"supporting_documents": {
"type": "array",
"description": "List of supporting documents"
}
},
"required": [
"supporting_documents"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List Supporting DocumentsGET/coverage_periods/{id}/supporting_documents
This endpoint returns a all Supporting Documents for a Coverage Period.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Supporting Documents Current By Id ¶
PUT /supporting_documents/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/current
Requests
Headers
Content-Type: <<Add Header Value>>Body
{
"supporting_document": {
"file": "BASE64 FILE",
"filename": "Group Application",
"data": {
"signatures": {
"group": {
"name": "Jane Doe",
"title": "Chief Financial Officer",
"date": "2022-01-01"
},
"member": {
"name": "Jane Doe",
"title": "Chief Financial Officer",
"date": "2022-01-01"
},
"broker": {
"name": "Jane Doe",
"title": "Chief Financial Officer",
"date": "2022-01-01"
}
}
}
}
}Schema
{
"type": "object",
"properties": {
"supporting_document": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Base64-encoded file contents"
},
"filename": {
"type": "string",
"description": "Name of the file being uploaded"
},
"data": {
"type": "object",
"properties": {
"signatures": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of signatory"
},
"title": {
"type": "string",
"description": "Title of signatory"
},
"date": {
"type": "string",
"description": "Date of signing"
}
},
"required": [
"name",
"date"
]
},
"member": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of signatory"
},
"title": {
"type": "string",
"description": "Title of signatory"
},
"date": {
"type": "string",
"description": "Date of signing"
}
},
"required": [
"name",
"date"
]
},
"broker": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of signatory"
},
"title": {
"type": "string",
"description": "Title of signatory"
},
"date": {
"type": "string",
"description": "Date of signing"
}
},
"required": [
"name",
"date"
]
}
}
}
}
}
},
"required": [
"file",
"filename"
]
}
},
"required": [
"supporting_document"
],
"description": "The current representation of our supporting document",
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Coverage Period Supporting Documents Returned
Headers
Content-Type: application/jsonBody
{
"filename": "Hello, world!",
"data": {
"signatures": {
"group": {
"name": "Jane Doe",
"title": "Chief Financial Officer",
"date": "2022-01-01"
},
"member": {
"name": "Jane Doe",
"title": "Chief Financial Officer",
"date": "2022-01-01"
},
"broker": {
"name": "Jane Doe",
"title": "Chief Financial Officer",
"date": "2022-01-01"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "Name of the file being uploaded"
},
"data": {
"type": "object",
"properties": {
"signatures": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of signatory"
},
"title": {
"type": "string",
"description": "Title of signatory"
},
"date": {
"type": "string",
"description": "Date of signing"
}
},
"required": [
"name",
"date"
]
},
"member": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of signatory"
},
"title": {
"type": "string",
"description": "Title of signatory"
},
"date": {
"type": "string",
"description": "Date of signing"
}
},
"required": [
"name",
"date"
]
},
"broker": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of signatory"
},
"title": {
"type": "string",
"description": "Title of signatory"
},
"date": {
"type": "string",
"description": "Date of signing"
}
},
"required": [
"name",
"date"
]
}
}
}
}
}
},
"required": [
"filename"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Attach Signed Supporting DocumentPUT/supporting_documents/{id}/current
Use this endpoint to attach a final version of a supporting document. This, for example, could be a signed version of the original document.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the supporting document
Census Requests ¶
Census Requests By Id ¶
GET /census_requests/a37ecd06-5d97-46e4-9b4e-dcde6a03246f
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"census_request": {
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00",
"errors": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "Hello, world!",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": "Hello, world!"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"census_request": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"status": {
"type": "string",
"enum": [
"pending",
"errors",
"synced"
],
"description": "Status of the census request"
},
"coverage_period_id": {
"type": "string",
"description": "Ideon generated unique identifier to be used for maintaining the resource"
},
"created_at": {
"type": "string"
},
"errors": {
"type": "array",
"description": "A list of errors provided by the carrier associated with the census request"
}
},
"required": [
"id",
"status",
"coverage_period_id",
"created_at",
"errors"
]
}
},
"required": [
"census_request"
]
}Request Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Retrieve a Census RequestGET/census_requests/{id}
This endpoint can be used to check the status of a Census Request.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the census request
Census Requests Subscribers By Id ¶
GET /census_requests/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/subscribers
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"subscribers": [
{
"status": "",
"status_datetime": "",
"errors": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"census_requests": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"severity": "info",
"message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
"assignee": "partner",
"discrepancy": {
"parameter": "social_security_number",
"carrier": "123456789",
"platform": "0123455678"
},
"status": "resolved",
"resolution": {
"message": "Child dependent John Smith has been added with medical coverage starting 08/01/2020",
"created_at": "",
"resolved_by": "partner"
},
"comments": [
{
"message": "We are working with the group to retrieve this information.",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"error_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_by": "partner",
"created_at": "2022-05-03T09:00:00-04:00"
}
],
"created_at": ""
}
],
"subscriber": {
"location_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"division": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"department": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"class": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"subgroup": {
"employment_classification_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"effective_date": "2022-01-01"
},
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"marital_status": "registered_domestic_partner",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"union": "union",
"executive": "executive",
"management": "management",
"administrative": "administrative",
"exempt": "exempt",
"highly_compensated": true,
"key_employee": true,
"bargaining": "bargaining",
"owner": true,
"president": "president",
"work_location": "254A",
"salary_grade": "A",
"dependents": [
{
"social_security_number": "222222222",
"first_name": "John",
"middle_name": "M",
"last_name": "Smith",
"name_prefix": "MR",
"name_suffix": "JR",
"birth_date": "1980-01-01",
"subscriber_relationship": "child",
"student_status": "full_time",
"gender": "male",
"handicapped": true,
"tobacco_use": false,
"substance_abuse": true,
"height": 62,
"weight": 123,
"race_ethnicity": "not_provided",
"citizenship_status": "alien",
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"schools": [
{
"emails": [
{
"type": "work",
"contact": "[email protected]"
}
],
"phone_numbers": [
{
"type": "work",
"contact": "5555555555"
}
],
"address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"name": "Yorktown High School"
}
]
}
],
"emails": [
{
"type": "personal",
"contact": "[email protected]"
}
],
"employment_details": {
"start_date": "2020-01-01",
"end_date": "2022-06-31",
"retirement_date": "2022-06-31",
"status": "active",
"annual_earnings": 300000,
"earnings_effective_date": "2020-01-01",
"wage_frequency": "weekly",
"hours_per_week": 40,
"compensation": "hourly",
"title": "Senior Director of Sales"
},
"external_identifier": "ABC-132A54",
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"languages": [
{
"language": "zulu",
"language_proficiency": "reading"
}
],
"mailing_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"medicare": {
"medicare_beneficiary_identifier": "23A0123A921",
"eligibility": "age",
"eligibility_start_date": "2022-01-01",
"enrolled": true,
"coverages": [
{
"type": "medical",
"start_date": "2022-01-01",
"end_date": "2022-12-31"
}
]
},
"phone_numbers": [
{
"type": "other",
"contact": "5555555555"
}
],
"residential_address": {
"address_line_1": "50 Orchard Street",
"address_line_2": "Apt 4H",
"city": "Kansas City",
"state": "MO",
"zip": "64108",
"fips_county_code": "29085",
"country_code": "USA"
},
"current_qualifying_life_events": [
{
"event": "birth",
"date": "2022-01-01",
"received_date": "2022-01-01",
"enrollment_signature_date": "2022-01-01",
"external_identifier": "ABC-132A54",
"eligibility_start_date": "2022-01-01",
"eligibility_end_date": "2022-12-31",
"coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"plan_elections": {},
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"status": "pending"
}
]
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"subscribers": {
"type": "array",
"description": "The status of the group's subscribers"
}
},
"required": [
"subscribers"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List Census Request SubscribersGET/census_requests/{id}/subscribers
This endpoint returns the Subscribers pulled from the carrier as part of the Census Request. Ideon uses this data to reconcile against the data provided to automatically surface Enrollment Problems. This information could be of use to perform checks or fill in data in your system on the Group.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the census request
Reporting ¶
Coverage Periods Coverage Transmissions ¶
GET /coverage_periods/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/coverage_transmissions
Responses
Coverage Period Coverage Transmissions Returned
Headers
Content-Type: application/jsonBody
{
"coverage_transmissions": [
{
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"type": "subscriber",
"elections": {
"medical": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"dental": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"vision": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"voluntary_life": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"non_voluntary_life": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"voluntary_accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"life_accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"voluntary_life_accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"short_term_disability": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"long_term_disability": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"hospital_indemnity": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"critical_illness": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"accident": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"cancer": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"legal": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_transmissions": {
"type": "array",
"description": "List of coverage transmissions"
}
},
"required": [
"coverage_transmissions"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List Coverage TransmissionsGET/coverage_periods/{id}/coverage_transmissions
This endpoint lists the Coverage Transmissions for Subscribers as part of a Coverage Period. A Coverage Transmission is a representation of the information passed about a particular coverage for a Subscriber. This resource can be thought of as a “receipt” of a delivery of data to the carrier for the particular coverage.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
Members Coverage Transmissions By Id ¶
GET /members/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/coverage_transmissions
Responses
Member Coverage Transmissions Returned
Headers
Content-Type: application/jsonBody
{
"coverage_transmissions": [
{
"product_line": "medical",
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"sent_at": "Hello, world!",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_transmissions": {
"type": "array",
"description": "List of coverage transmissions"
}
},
"required": [
"coverage_transmissions"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List Member Coverage TransmissionsGET/members/{id}/coverage_transmissions
This endpoint lists the Coverage Transmissions for a particular Member, a Subscriber or Dependent. A Coverage Transmission is a representation of the information passed about a particular coverage for a Subscriber. This resource can be thought of as a “receipt” of a delivery of data to the carrier for the particular coverage.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the member
Coverage Periods File Deliveries By Id ¶
GET /coverage_periods/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/file_deliveries
Responses
Request Successful
Headers
Content-Type: application/jsonBody
{
"file_deliveries": [
{
"id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"file_name": "EnrollmentFile.txt",
"sent_at": "2022-05-03T09:00:00-04:00"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"file_deliveries": {
"type": "array",
"description": "A list of coverage period transmission file deliveries"
}
},
"required": [
"file_deliveries"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.required_parameter_missing",
"message": "The parameter is missing and is required",
"parameter": "subscriber.[<index>].social_security_number",
"datetime": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.resource_not_found",
"message": "The requested resource could not be found",
"parameter": "id"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List File DeliveriesGET/coverage_periods/{id}/file_deliveries
This endpoint lists the File Deliveries for a Coverage Period, ordered descending by send date. This endpoint can be used to track the different file delieveries to carriers transmitted by Ideon on the Group’s behalf.
As implied by the name of the resource, this is only relevant for information transmitted via file (not those transmitted via API). To discern whether this endpoint is relevant for a Coverage Period, you can use the delivery_method field on a Coverage Period.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the coverage period
File Deliveries Coverage Transmissions ¶
GET /file_deliveries/b37ecd06-5d97-46e4-9b4e-dcde6a03246f/coverage_transmissions
Responses
File Delivery Coverage Transmissions Returned
Headers
Content-Type: application/jsonBody
{
"coverage_transmissions": [
{
"member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"file_delivery_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"type": "subscriber",
"elections": {
"medical": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"dental": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"vision": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"voluntary_life": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"non_voluntary_life": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"voluntary_accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"life_accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"voluntary_life_accidental_death_dismemberment": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"short_term_disability": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"long_term_disability": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"hospital_indemnity": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"critical_illness": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"accident": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"cancer": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
},
"legal": {
"plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
"last_sent_at": "2022-05-03T09:00:00-04:00",
"benefit_status": "employer_sponsored",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"volume": 8000000,
"requested_volume": 8000000
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coverage_transmissions": {
"type": "array",
"description": "List of coverage transmissions"
}
},
"required": [
"coverage_transmissions"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
List File Coverage TransmissionsGET/file_deliveries/{id}/coverage_transmissions
This endpoint lists the Coverage Transmissions delivered within files to carriers on each Member’s behalf, ordered descending by send date. This endpoint can be used to track the coverages sent for a particular file delievery to a carrier transmitted by Ideon on the Group’s behalf.
As implied by the name of the resource, this is only relevant for information transmitted via file (not those transmitted via API). To discern whether this endpoint is relevant for a Coverage Period, you can use the delivery_method field on a Coverage Period.
URI Parameters
- id
string(required) Example: b37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the file delivery
Hooks ¶
Groups Hooks By Id ¶
POST /groups/a37ecd06-5d97-46e4-9b4e-dcde6a03246f/hooks
Requests
Headers
Content-Type: application/jsonBody
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Responses
Body
Resource Created SuccessfullyRequest Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Authorization Information Missing or Invalid
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unauthorized Request
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Resource Not Found
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}Unprocessable Entity
Headers
Content-Type: application/jsonBody
{
"errors": [
{
"error_type": "invalid_request.unauthorized",
"message": "API key not recognized",
"parameter": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "A list of errors related to the enrollment transaction"
}
},
"required": [
"errors"
]
}
Subscribe to Group UpdatesPOST/groups/{id}/hooks
This webhook creates a subscription to updates for particular events for a Group. The two events that are retured are: 1. Changes to the state of a Coverage Period, which is used to track the progress of getting data live with
the carrier. 2. The creation of new Enrollment Problems, or reconciliation issues, for any of the Group’s Coverage Periods.
URI Parameters
- id
string(required) Example: a37ecd06-5d97-46e4-9b4e-dcde6a03246fIdeon generated unique identifier for the group
Rsp ¶
POST /rsp
Requests
Headers
Content-Type: application/x-www-form-urlencodedResponses
Body
OKBody
Bad request - Payload rejected.Body
Unauthorized - action requires user authentication.Body
Forbidden - user does not have permission to upload this payload.Body
Not Found - resource not found.Body
Not Allowed - method not allowed on this resource.Body
Unacceptable - payload content type is not supported.Body
Length Required - server needs to know the size of the entity body. Specify in Content-Length header.Body
Payload too large - payload exceeds size limit (too many employees or too many employers).Body
Unsupported media type - payload type unsupported.Body
Unprocessable entity - request body failed business validation.Body
Too many requests - number of requests exceeds limit.Body
Internal Server Error - fatal error during processing of request.Body
Not implemented - RSP upload is not supported.Body
Bad Gateway - the server received an invalid response from an upstream server.Body
Service Unavailable - unable to process request at this time. Try again later.
RspPOSTPOST/rsp
Processing response of LDExBEM transmission in LDExRSP standard