Sign in

v1

latestOpenAPI 3.0.02026-07-231358118.3 KB
Deeplinking

Apply for ICHRA off-exchange coverage via deeplink

Public endpoint for initiating an ICHRA off-exchange application with prefilled fields. Prefill behavior is controlled via request body. Requires plan_hios_id, _agent_id, zip_code, fip_code, and either phone_number or email.

Note: If any applicants other than primary are included (e.g., spouse, domestic_partner, dependents), then the primary applicant is required.

Authentication:

  • Production: You may optionally send an x-api-key header. Providing a valid API key will automatically allowlist any valid _agent_id included in your request, allowing agents not associated with an agency to proceed. _agent_id remains required in all cases.
  • Staging: Basic Auth is required. Please contact your onboarding representative for credentials.
post/public/ichra/off_ex

Headers

x-api-keystring

Optional API key used in Production. When provided and valid, it allows use of a valid _agent_id that is not associated with an agency. _agent_id is still required. In Staging, this header is not used; Basic Auth is required instead.

Request body

plan_hios_idstring required

HIOS ID of the selected plan

_agent_idstring required

Slug of the agent of record

agent_of_record_cpcstring

Carrier Producer Code of the agent of record

agent_of_record_tinstring

Tax Identification Number of the agent of record or agency, if preferred.

agent_of_record_email_addressstring email

Email address of the agent of record. If not provided, the email address associated with the _agent_id will be used.

agent_of_record_first_namestring

First name of the agent of record. If not provided, the first name associated with the _agent_id will be used.

agent_of_record_last_namestring

Last name of the agent of record. If not provided, the last name associated with the _agent_id will be used.

agent_of_record_npnstring

NPN of the agent of record. Must be 1-10 digits and not start with 0. If not provided, the NPN associated with the _agent_id will be used.

agent_of_record_phone_numberstring

Phone number of the agent of record. Must be 10 digits and cannot start with 0, 1, or 9. Can be all digits (5625551212) or with dashes (562-555-1212).

agent_of_record_state_licensestring

State license of the agent of record. This will not be taken from the _agent_id.

emailstring email

Email for the application (required if phone_number is not provided)

phone_numberstring

Phone number for the application (required if email is not provided)

phone_type'cell' | 'home' | 'work'

Type of phone number provided

external_idstring

External identifier for the application

utm_sourcestring

UTM source parameter for tracking

utm_mediumstring

UTM medium parameter for tracking

utm_campaignstring

UTM campaign parameter for tracking

utm_termstring

UTM term parameter for tracking

utm_contentstring

UTM content parameter for tracking

ljsstring

LJS parameter

callstring

Call parameter

plan_yearinteger

Plan year (defaults to current year if not provided)

street_addressstring

Street address

street_address_unit_numberstring

Street address unit number

citystring

City

state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'DC'

State

zip_codestring required

ZIP code (must be exactly 5 digits)

fip_codestring required

County code (FIPS) (must be exactly 5 digits)

mailing_street_addressstring

Mailing street address (if different from residential)

mailing_citystring

Mailing city (if different from residential)

mailing_state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'DC'

Mailing state (if different from residential)

mailing_zip_codestring

Mailing ZIP code (if different from residential)

mailing_fip_codestring

Mailing county code (FIPS) (if different from residential)

sep_reason'birth' | 'adoption' | 'death' | 'divorce' | 'marriage' | 'domestic_partnership' | 'child_support' | 'loss_of_mec' | 'loss_of_dependent' | 'dependent_lost_coverage' | 'loss_of_pregnancy_coverage' | 'end_of_non_calendar_year_policy' | 'change_in_household_status' | 'lost_aptc' | 'relocation' | 'nj_county_change' | 'offered_ichra' | 'offered_qsehra' | 'mandated_covered_dependent' | 'released_from_incarceration' | 'returning_active_duty' | 'provider_not_participating_in_prior_plan' | 'issuer_violated_contract' | 'misinformed' | 'domestic_abuse' | 'family_care_app_ineligible' | 'pregnancy' | 'other'

Special enrollment period reason

sep_reason_datestring date

Special enrollment period reason date

language_spoken'english' | 'spanish' | 'arabic' | 'chinese' | 'french_creole' | 'french' | 'german' | 'gujarati' | 'hindi' | 'korean' | 'polish' | 'portuguese' | 'russian' | 'tagalog' | 'urdu' | 'vietnamese' | 'other'

The preferred spoken language of the applicant.

language_written'english' | 'spanish' | 'arabic' | 'chinese' | 'french_creole' | 'french' | 'german' | 'gujarati' | 'hindi' | 'korean' | 'polish' | 'portuguese' | 'russian' | 'tagalog' | 'urdu' | 'vietnamese' | 'other'

The preferred written language of the applicant.

skipboolean

Whether to skip to the latest possible step in the application

pediatric'purchased_separately' | 'not_applicable'

Pediatric dental coverage status