Application Deeplink API
The Application Deeplink allows for platforms to enroll ICHRA participants through their HealthSherpa application.
The Application Deeplink API in Production does not require or make use of the API Key in the header. However, when testing in Staging, Basic Auth is required for it to work. Please reach out to your onboarding representative for the Staging credentials.
Environments:
Staging
https://staging.healthsherpa.com
Production
https://www.healthsherpa.com
Public endpoint for initiating an ICHRA off-exchange application with prefilled fields. Prefill behavior is controlled via query parameters. 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.
HIOS ID of the selected plan
97667AZ0110014Slug of the agent of record
TestAgent2ZIP code for the applicant's address (must be exactly 5 digits)
85001Pattern: ^\d{5}$County code (FIPS) for the applicant's address (must be exactly 5 digits)
04013Pattern: ^\d{5}$Email for the application (required if phone_number is not provided)
[email protected]Phone number for the application (required if email is not provided). Must be 10 digits and cannot start with 0, 1, or 9. Can be all digits (5625551212) or with dashes (562-555-1212)
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$Type of phone number provided (optional).
cellPossible values: Email address of the agent of record. If not provided, the email address associated with the _agent_id will be used.
[email protected]First name of the agent of record. If not provided, the first name associated with the _agent_id will be used.
JohnPattern: ^[A-Za-z\s'-]+$Last name of the agent of record. If not provided, the last name associated with the _agent_id will be used.
DoePattern: ^[A-Za-z\s'-]+$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.
1234567890Pattern: ^[1-9]\d{0,9}$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).
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$State license of the agent of record. This will not be taken from the _agent_id.
1234567890Passing a true for this parameter will allow you to skip further into the application instead of starting at the beginning.
Plan year (defaults to current year if not provided)
^[A-Za-z0-9\s\'\-\.]+$Must be letters, digits and spaces only
^[\w\d\s]+$^[A-Za-z\s'-]+$Street address for mailing if different from residential address
^[A-Za-z0-9\s\'\-\.]+$City for mailing if different from residential address
^[A-Za-z\s'-]+$State for mailing if different from residential address
ZIP code for mailing if different from residential address
^\d{5}$The below values are the default values. Please see the carrier configurations list for any carrier-specific values.
YYYY-MM-DDWhether pediatric dental product purchased separately or there are no children under the age of 19 on the application
^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDSocial Security Number (must be exactly 9 digits, no dashes)
123456789Pattern: ^\d{9}$truePossible values: issuertruePossible values: Blue Cross Blue ShieldPattern: ^[A-Za-z\s'-]+$ABC1234567892024-12-31Pattern: YYYY-MM-DDMonthly contribution amount from the applicant's employer
The below values are the default values. Please see the carrier configurations list for any carrier-specific values.
YYYY-MM-DDCompany name of the employer providing the HRA benefit
Acme CorporationPattern: ^[A-Za-z\s'-]+$Phone number of the employer providing the HRA benefit. Must be 10 digits and cannot start with 0, 1, or 9.
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$Street address of the employer providing the HRA benefit
^[A-Za-z0-9\s\'\-\.]+$City of the employer providing the HRA benefit
^[A-Za-z\s'-]+$State of the employer providing the HRA benefit
ZIP code of the employer providing the HRA benefit
^\d{5}$Federal Employer Identification Number (FEIN) of the employer providing the HRA benefit (must be exactly 9 digits)
123456789Pattern: ^\d{9}$Who pays the premium for the HRA benefit
Household size for HRA benefit calculation
4Annual household income for HRA benefit determination
75000Method used to determine the annual household income
Whether HRA was offered to the applicant
Whether the HRA offering status is unknown
Name of the Third Party Administrator (TPA) for the HRA benefit
TPA Services IncPattern: ^[A-Za-z\s'-]+$Phone number of the TPA. Must be 10 digits and cannot start with 0, 1, or 9. Can be all digits (5625551212) or with dashes (562-555-1212)
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$Street address of the TPA
^[A-Za-z0-9\s\'\-\.]+$Street address unit number of the TPA. Must be letters, digits and spaces only
^[\w\d\s]+$City of the TPA
^[A-Za-z\s'-]+$State of the TPA
ZIP code of the TPA (must be exactly 5 digits)
85001Pattern: ^\d{5}$County of the TPA
^[A-Za-z\s'-]+$TPA slug for auto-filling TPA information from the database
First name of the guardian (optional)
^[A-Za-z\s'-]+$Middle name of the guardian (optional)
^[A-Za-z\s'-]+$Last name of the guardian (optional)
^[A-Za-z\s'-]+$Gender of the guardian (optional)
Relationship of the guardian to the applicant (optional)
^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDSocial Security Number (must be exactly 9 digits, no dashes)
123456789Pattern: ^\d{9}$falsePossible values: issuerfalsePossible values: AetnaPattern: ^[A-Za-z\s'-]+$XYZ9876543212024-11-30Pattern: YYYY-MM-DD^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDtruePossible values: issuertruePossible values: UnitedHealthcarePattern: ^[A-Za-z\s'-]+$UHC4567890122024-10-15Pattern: YYYY-MM-DD^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDSocial Security Number (must be exactly 9 digits, no dashes)
123456789Pattern: ^\d{9}$falsePossible values: issuerfalsePossible values: HumanaPattern: ^[A-Za-z\s'-]+$HUM7890123452024-09-30Pattern: YYYY-MM-DDRedirect to off_ex_apply with provided parameters
Plan not available for off-ex marketplace, missing required parameters, or malformed input
POST /public/ichra/off_ex?plan_hios_id=text&_agent_id=text&zip_code=text&fip_code=text&applicants[primary][hra][offered_hra]=true HTTP/1.1
Host:
Accept: */*
No content
Public endpoint for initiating an ICHRA off-exchange application with prefilled fields. Prefill behavior is controlled via query parameters. 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.
Important: For dependent parameters in the GET request, use empty brackets in the actual implementation (e.g., applicants[dependents][][first_name]) instead of the indexed format shown in the parameter names below.
HIOS ID of the selected plan
97667AZ0110014Slug of the agent of record
TestAgent2ZIP code for the applicant's address (must be exactly 5 digits)
85001Pattern: ^\d{5}$County code (FIPS) for the applicant's address (must be exactly 5 digits)
04013Pattern: ^\d{5}$Email for the application (required if phone_number is not provided)
[email protected]Phone number for the application (required if email is not provided). Must be 10 digits and cannot start with 0, 1, or 9. Can be all digits (5625551212) or with dashes (562-555-1212)
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$Type of phone number provided (optional).
cellPossible values: Email address of the agent of record. If not provided, the email address associated with the _agent_id will be used.
[email protected]First name of the agent of record. If not provided, the first name associated with the _agent_id will be used.
JohnPattern: ^[A-Za-z\s'-]+$Last name of the agent of record. If not provided, the last name associated with the _agent_id will be used.
DoePattern: ^[A-Za-z\s'-]+$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.
1234567890Pattern: ^[1-9]\d{0,9}$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).
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$State license of the agent of record. This will not be taken from the _agent_id.
1234567890Passing a true for this parameter will allow you to skip further into the application instead of starting at the beginning.
Plan year (defaults to current year if not provided)
^[A-Za-z0-9\s\'\-\.]+$Must be letters, digits and spaces only
^[\w\d\s]+$^[A-Za-z\s'-]+$Street address for mailing if different from residential address
^[A-Za-z0-9\s\'\-\.]+$City for mailing if different from residential address
^[A-Za-z\s'-]+$State for mailing if different from residential address
ZIP code for mailing if different from residential address
^\d{5}$Indicates the reason the applicant qualifies for a Special Enrollment Period (SEP), allowing them to enroll outside of the standard Open Enrollment window. Required when the enrollment is submitted during a Special Enrollment Period.
YYYY-MM-DDWhether pediatric dental product purchased separately or there are no children under the age of 19 on the application
^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDtruePossible values: issuertruePossible values: Blue Cross Blue ShieldPattern: ^[A-Za-z\s'-]+$ABC1234567892024-12-31Pattern: YYYY-MM-DDMonthly contribution amount from the applicant's employer
YYYY-MM-DDCompany name of the employer providing the HRA benefit
Acme CorporationPattern: ^[A-Za-z\s'-]+$Phone number of the employer providing the HRA benefit. Must be 10 digits and cannot start with 0, 1, or 9.
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$Street address of the employer providing the HRA benefit
^[A-Za-z0-9\s\'\-\.]+$City of the employer providing the HRA benefit
^[A-Za-z\s'-]+$State of the employer providing the HRA benefit
ZIP code of the employer providing the HRA benefit
^\d{5}$Federal Employer Identification Number (FEIN) of the employer providing the HRA benefit (must be exactly 9 digits)
123456789Pattern: ^\d{9}$Who pays the premium for the HRA benefit
Household size for HRA benefit calculation
4Annual household income for HRA benefit determination
75000Method used to determine the annual household income
Whether HRA was offered to the applicant
Whether the HRA offering status is unknown
Name of the Third Party Administrator (TPA) for the HRA benefit
TPA Services IncPattern: ^[A-Za-z\s'-]+$Phone number of the TPA. Must be 10 digits and cannot start with 0, 1, or 9. Can be all digits (5625551212) or with dashes (562-555-1212)
5625551212Pattern: ^[2-8]\d{9}$|^[2-8]\d{2}-\d{3}-\d{4}$Street address of the TPA
^[A-Za-z0-9\s\'\-\.]+$Street address unit number of the TPA. Must be letters, digits and spaces only
^[\w\d\s]+$City of the TPA
^[A-Za-z\s'-]+$State of the TPA
ZIP code of the TPA (must be exactly 5 digits)
85001Pattern: ^\d{5}$County of the TPA
^[A-Za-z\s'-]+$TPA slug for auto-filling TPA information from the database
First name of the guardian (optional)
^[A-Za-z\s'-]+$Middle name of the guardian (optional)
^[A-Za-z\s'-]+$Last name of the guardian (optional)
^[A-Za-z\s'-]+$Gender of the guardian (optional)
Relationship of the guardian to the applicant (optional)
^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDfalsePossible values: issuerfalsePossible values: AetnaPattern: ^[A-Za-z\s'-]+$XYZ9876543212024-11-30Pattern: YYYY-MM-DD^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$^[A-Za-z\s'-]+$YYYY-MM-DDtruePossible values: issuertruePossible values: UnitedHealthcarePattern: ^[A-Za-z\s'-]+$UHC4567890122024-10-15Pattern: YYYY-MM-DDFirst name of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][first_name]
^[A-Za-z\s'-]+$Middle name of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][middle_name]
^[A-Za-z\s'-]+$Last name of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][last_name]
^[A-Za-z\s'-]+$Suffix of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][suffix]
Date of birth of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][date_of_birth]
YYYY-MM-DDGender of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][gender]
US citizenship status of dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][us_citizen]
Social Security Number (must be exactly 9 digits, no dashes). Note: The actual parameter name should use empty brackets: applicants[dependents][][ssn]
123456789Pattern: ^\d{9}$Whether dependent has existing coverage. Note: The actual parameter name should use empty brackets: applicants[dependents][][has_existing_coverage]
falsePossible values: Type of existing coverage for dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][existing_coverage_type]
issuerWhether plan replaces existing coverage for dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][plan_replaces_existing_coverage]
falsePossible values: Existing coverage insurer for dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][existing_coverage_insurer]
HumanaPattern: ^[A-Za-z\s'-]+$Existing coverage policy ID for dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][existing_coverage_policy_id]
HUM789012345Existing coverage termination date for dependent. Note: The actual parameter name should use empty brackets: applicants[dependents][][existing_coverage_term_date]
2024-09-30Pattern: YYYY-MM-DDRedirect to off_ex_apply with provided parameters
Plan not available for off-ex marketplace, missing required parameters, or malformed input
GET /public/ichra/off_ex?plan_hios_id=text&_agent_id=text&zip_code=text&fip_code=text&applicants[primary][hra][offered_hra]=true HTTP/1.1
Host:
Accept: */*
No content
Last updated