Groups
Detailed mapping of the fields used in a POST request to create a group. The schema below is used in the /groups endpoint. The Required Fields are listed in a smaller initial table:
external_identifier*
This is an identifier that your system can use - or has generated - to identify the group. This is in addition to Ideon's id for a group.
employer*
This contains information about the Employer. i.e., Name and EIN.
This object is required.
employer . organization_name*
The legal name of the employer -
Note: Ideon Operations can associate a DBA name with a created group if desired.
employer . fein*
The Employer Identification Number - in the case of use employers, this is often referred to as the Federal EIN or EIN
primary_location*
This is the address of the group location - the headquarters of the group, for tax and eligibility purposes.
This object is required.
primary_location . type*
default to physical
primary_location . employer_address*
Required -
address_line_1
city
zip
Should be provided if available:
address_line_2
state
fips_county_code
country_code can be defaulted to USA (will be if not provided)
Note: Ideon currently only supports domestic addresses for enrollments
primary_location . external_identifier*
a Platform generated identifier that is related to this resource
producers_of_record
Producers_of_record is Required for ICHRA unless one value is used for all enrollment on the Account.
Optional object that allows you to list one or more brokers or producers of record for this group. This includes the elements: ( * = required)
first_name
last_name*
national_producer_number* - this is the NPN, a core identifier for the producer/broker
social_security_number
fein
state_license_number - this is a state specific license number, if applicable
carrier_producer_identifier
commission_split* - number field with minimum: 0, maximum: 100
signature_date*
emails*
phone_numbers*
primary - true/false field
producer_agency
Optional object that allows you to list the producer agency for this group. This includes the elements: ( * = required)
name*
national_producer_number*
social_security_number
fein
state_license_number
carrier_producer_identifier
address
general_agency
Optional object that allows you to list the general agency for this group. This includes the elements: ( * = required)
name*
representative - includes a required last_name element and first_name element
national_producer_number*
social_security_number
fein
state_license_number
carrier_producer_identifier
address
Additional ICHRA Required Fields
primary_location*
benefit_administrator
This is used to collect information on a Group level contact for ICHRA admistration. The following elements are required:
first_name*
last_name*
emails*
phone_numbers*
producers_of_record
This object is where you can list broker specific information relevant to an ICHRA application.
The required elements are:
last_name*
national_producer_number*
state_license_number - required by Carrier's if present
commission_split*
signature_date*
emails*
phone_numbers*
Employer
employer is a required object in the API call to create a group.
There are several required, and many optional elements on the group request.
Here is a full listing of relevant optional fields alongside required elements.
organization_name*
This element is Required. This is the most accurate legal business name of the group.
We can also accept a doing-business-as name if the Policy is affiliated with a specific group name.
fein*
This element is Required. This is the current federally recognized Employer Identification Number (EIN) for the employer
This value must be numeric and 9 characters in length.
standard_industrial_classification_code
Optional, not required for enrollment. This value is the SIC code that is assigned to a given employer.
established_date
Optional, not required for enrollment. This value is the date that a company/employer was established.
employer_type
Optional, not required for enrollment.
census
Optional, not required for enrollment.
This field is an array of counts, of employees, full_time_equivalent_employees, and eligible_employees. This is a snapshot at the time the policy was created.
This is used in New Group Installment.
member_of_association
Optional, not required for enrollment.
subject_to_family_medical_leave_act
Optional, not required for enrollment.
leave_of_absence_medical_coverage_months
Optional, not required for enrollment.
leave_of_absence_personal_coverage_months
Optional, not required for enrollment.
wage_frequency
Optional, not required for enrollment.
This is the Group level wage frequency value.
This is often variable across employees and classes; in which case it is then provided at the employee level in Subscriber.employment_details.wage_frequency
hours_required_for_eligibility
Optional, not required for enrollment.
employed_20_or_more_for_half_of_previous_year
Optional, not required for enrollment.
employed_20_or_more_for_twenty_weeks_of_previous_year
Optional, not required for enrollment.
current_coverages
Optional, not required for enrollment.
Last updated
Was this helpful?