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

# Groups

| Ideon                                           | Usage and Mapping                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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\*                                      | <p>This contains information about the Employer. i.e., Name and EIN.</p><p></p><p>This object is required. </p>                                                                                                                                                                                                                                                                                                                        |
|       employer . organization\_name\*           | <p>The legal name of the employer - </p><p></p><p><strong>Note: Ideon Operations can associate a DBA name with a created group if desired.</strong> </p>                                                                                                                                                                                                                                                                               |
|      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\*                             | <p>This is the address of the group location - the headquarters of the group, for tax and eligibility purposes.</p><p></p><p>This object is required.</p>                                                                                                                                                                                                                                                                              |
|      primary\_location . type\*                 | default to `physical`                                                                                                                                                                                                                                                                                                                                                                                                                  |
|      primary\_location . employer\_address\*    | <p><strong>Required</strong> - </p><ul><li>address_line_1</li><li>city</li><li>zip</li></ul><p><em><strong>Should be provided if available:</strong></em></p><ul><li>address_line_2</li><li>state</li><li>fips_county_code </li></ul><p><code>country_code</code> <em>can be defaulted to USA (will be if not provided)</em></p><p></p><p><strong>Note: Ideon currently only supports domestic addresses for enrollments</strong> </p> |
|      primary\_location . external\_identifier\* | a Platform generated identifier that is related to this resource                                                                                                                                                                                                                                                                                                                                                                       |





### Employer&#x20;

`employer` is a required object in the API call to create a `group`.&#x20;

There are several required, and many optional elements on the `group` request.&#x20;

Here is a full listing of relevant optional fields alongside required elements.&#x20;

|                                                                |                                                                                                                                                                                                                                                                                                   |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| organization\_name\*                                           | <p><strong>This element is Required</strong>. This is the most accurate legal business name of the group. </p><p></p><p>We can also accept a doing-business-as name if the Policy is affiliated with a specific group name. </p>                                                                  |
| fein\*                                                         | <p><strong>This element is Required</strong>. This is the current federally recognized Employer Identification Number (EIN) for the employer</p><p></p><p>This value must be numeric and 9 characters in length.</p>                                                                              |
| 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                                                         | <p>Optional, not required for enrollment.  </p><p></p><p>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.</p><p></p><p>This is used in New Group Installment.</p>                   |
| 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                                                | <p>Optional, not required for enrollment.  </p><p></p><p>This is the Group level wage frequency value.</p><p></p><p>This is often variable across employees and classes; in which case it is then provided at the employee level in <code>Subscriber.employment_details.wage_frequency</code></p> |
| 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.                                                                                                                                                                                                                                                            |



