> For the complete documentation index, see [llms.txt](https://ideonapi.gitbook.io/enrollment/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ideonapi.gitbook.io/enrollment/implementation-resources/mapping-guides/groups.md).

# 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| producers\_of\_record                      | <p><em>P<strong>roducers\_of\_record is Required for ICHRA unless one value is used for all enrollment on the Account.</strong></em></p><p></p><p>Optional object that allows you to list one or more brokers or producers of record for this group. This includes the elements: ( \* = required)</p><ul><li>first\_name</li><li>last\_name\*</li><li>national\_producer\_number\* - this is the NPN, a core identifier for the producer/broker </li><li>social\_security\_number</li><li>fein </li><li>state\_license\_number - this is a state specific license number, if applicable</li><li>carrier\_producer\_identifier </li><li>commission\_split\* - number field with minimum: 0, maximum: 100</li><li>signature\_date\*</li><li>emails\* </li><li>phone\_numbers\*</li><li>primary - true/false field </li></ul> |
| producer\_agency                           | <p></p><p>Optional object that allows you to list the producer agency for this group. This includes the elements:  ( \* = required)</p><ul><li>name\* </li><li>national\_producer\_number\*</li><li>social\_security\_number</li><li>fein</li><li>state\_license\_number</li><li>carrier\_producer\_identifier</li><li>address </li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| general\_agency                            | <p></p><p>Optional object that allows you to list the general agency for this group. This includes the elements:  ( \* = required)</p><ul><li>name\* </li><li>representative - includes a required last\_name element and first\_name element</li><li>national\_producer\_number\*</li><li>social\_security\_number</li><li>fein</li><li>state\_license\_number</li><li>carrier\_producer\_identifier</li><li>address </li></ul>                                                                                                                                                                                                                                                                                                                                                                                           |

### Additional ICHRA Required Fields

| Ideon                                                     | Usage and Mapping                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>primary\_location\* </p><p>benefit\_administrator </p> | <p>This is used to collect information on a Group level contact for ICHRA admistration. The following elements are required:</p><ul><li>first\_name\*</li><li>last\_name\*</li><li>emails\*</li><li>phone\_numbers\*</li></ul>                                                                                                                                                  |
| producers\_of\_record                                     | <p>This object is where you can list broker specific information relevant to an ICHRA application. </p><p>The required elements are: </p><ul><li>last\_name\*</li><li>national\_producer\_number\*</li><li>state\_license\_number - required by Carrier's if present</li><li>commission\_split\*</li><li>signature\_date\* </li><li>emails\*</li><li>phone\_numbers\*</li></ul> |

### 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.                                                                                                                                                                                                                                                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ideonapi.gitbook.io/enrollment/implementation-resources/mapping-guides/groups.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.