Deeplink Mapping

This page is a companion to the Application Deeplink V2 guide. It covers every field that moved, was renamed, or was restructured between V1 and V2.


Root-Level Fields

pediatric is renamed to pediatric_dental. tpa_slug moves from applicants.primary.hra.tpa_slug to the root. desired_effective_date and american_indian_or_alaskan_native_in_household are new.

All other root fields (plan_hios_id, plan_year, _agent_id, external_id, skip) are unchanged.


Agent of Record

Flat agent_of_record_* fields become a nested agent_of_record object. npn becomes national_producer_number, cpc becomes carrier_producer_code, tin is merged into carrier_producer_code. Address, fax, and signature are new.

V1

{
  "_agent_id": "HS_SLUG",
  "agent_of_record_first_name": "James",
  "agent_of_record_last_name": "Bond",
  "agent_of_record_npn": "12342132",
  "agent_of_record_cpc": "CPC123",
  "agent_of_record_tin": "ABCDEFGHYZ",
  "agent_of_record_phone_number": "9172312312",
  "agent_of_record_email_address": "[email protected]",
  "agent_of_record_state_license": ""
}

V2

{
  "_agent_id": "HS_SLUG",
  "agent_of_record": {
    "first_name": "James",
    "last_name": "Bond",
    "national_producer_number": "12342132",
    "carrier_producer_code": "ABCDEFGHYZ",
    "email": "[email protected]",
    "phone": "9172312312",
    "fax_number": "",
    "state_license_number": "",
    "address": {
      "street_address_1": "123 Main St",
      "city": "Austin",
      "state": "TX",
      "zip_code": "78701"
    },
    "signature": ""
  }
}

Contact Fields

email, phone_number, phone_type, language_spoken, and language_written move from root into applicants.primary. phone_number is renamed to phone.


Addresses

Flat address fields become nested residential_address and mailing_address objects. Three renames apply to all address types:

  • street_address becomes street_address_1

  • street_address_unit_number becomes street_address_2

  • fip_code becomes fips_code

V1

V2

The same rename pattern applies to mailing, employer, agent, responsible party, and alternate addresses. mailing_address also adds different_from_home_address and billing_use_only.


SEP

sep_reason becomes special_enrollment_period.event_type, sep_reason_date becomes special_enrollment_period.event_date.

V1

V2


Spouse & Domestic Partner

applicants.spouse and applicants.domestic_partner are removed as top-level keys. Both move into the applicants.dependents array with a relationship field.

V1

V2


Existing Coverage

Flat existing_coverage_* fields on each applicant become a nested existing_coverage object. existing_coverage_type becomes type, existing_coverage_insurer becomes insurer, existing_coverage_policy_id becomes policy_id, existing_coverage_term_date becomes term_date. New fields: policyholder_name, start_date, will_continue.


HRA & Employer

HRA moves from applicants.primary.hra to a top-level hra object. Employer fields are further nested under hra.employer. tpa_slug moves to the root.

V1

V2

hra_used_for_spousal_or_family_premiums is renamed to used_for_spousal_or_family_premiums. New fields: hra.employer.external_id, hra.employer.fips_code.


UTM

utm_source, utm_medium, utm_campaign, utm_term, utm_content move from root into an analytics object. No renames.


Removed Fields

V1 Field
Notes

agent_of_record_tin

Use agent_of_record.carrier_producer_code instead

applicants.primary.hra.offered_hra_unknown

Removed

Last updated