Field Dictionary

Every field you can send to the Partner API, with plain-English names, allowed values, and the exact rules from our schemas. Search it, or download the whole thing.

Download CSV Download JSON OpenAPI spec

Required only239 fields

Create Employer

POST /employers/

7 of 7 fields · 7 required

Field	Type	Req.	Allowed values
`name` Employer name	string	required	—
`url` Company website	string	required	—
`size` Eligible employee count	string	required	—
`naics_codes` NAICS industry codes	array<string>	required	—
`location_states` Location states	array<string>	required	—
`other_filters` Applied filters	array<string>	required	—
`division` Division ID	string	required	—

Create Medical Plan

POST /plans/medical/

74 of 74 fields · 41 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`funding` Funding type	string	required	`FUNDING_FULLYFUNDING_LEVELFUNDING_SELF`
`t1_ee` Tier 1 employee contribution (PEPY)	integer	required	—
`t2_ee` Tier 2 employee contribution (PEPY)	integer	required	—
`t3_ee` Tier 3 employee contribution (PEPY)	integer	required	—
`t4_ee` Tier 4 employee contribution (PEPY)	integer	required	—
`t1_gross` Tier 1 total cost (PEPY)	integer	required	—
`t2_gross` Tier 2 total cost (PEPY)	integer	required	—
`t3_gross` Tier 3 total cost (PEPY)	integer	required	—
`t4_gross` Tier 4 total cost (PEPY)	integer	required	—
`type` Plan type	string	required	`PPOPOSEPOHMOHDHP`
`in_ded_single` In-network deductible (single)	integer	required	—
`in_ded_family` In-network deductible (family)	integer	required	—
`in_max_single` In-network max out-of-pocket (single)	integer	required	—
`in_max_family` In-network max out-of-pocket (family)	integer	required	—
`in_coin` In-network coinsurance	integer	required	—
`out_ded_single` Out-of-network deductible (single)	integer	optional	—
`out_ded_family` Out-of-network deductible (family)	integer	optional	—
`out_max_single` Out-of-network max out-of-pocket (single)	integer	optional	—
`out_max_family` Out-of-network max out-of-pocket (family)	integer	optional	—
`out_coin` Out-of-network coinsurance	integer	optional	—
`rx_ded_single` Rx deductible (single, if separate)	integer	optional	—
`rx_ded_family` Rx deductible (family, if separate)	integer	optional	—
`rx_max_single` Rx max out-of-pocket (single, if separate)	integer	optional	—
`rx_max_family` Rx max out-of-pocket (family, if separate)	integer	optional	—
`rx_coin` Rx coinsurance	integer	optional	—
`pcp_ded_apply` Primary care: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`sp_ded_apply` Specialist: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`er_ded_apply` Emergency room: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`uc_ded_apply` Urgent care: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`lx_ded_apply` Lab & X-ray: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`ip_ded_apply` Inpatient: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`op_ded_apply` Outpatient: deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`rx1_ded_apply` Rx tier 1 (generic): deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`rx2_ded_apply` Rx tier 2 (preferred brand): deductible/coinsurance applies	string	required	`FALSEFALSE_COINTRUETRUE_COIN`
`rx3_ded_apply` Rx tier 3 (non-preferred brand): deductible/coinsurance applies	string	optional	`FALSEFALSE_COINTRUETRUE_COIN`
`rx4_ded_apply` Rx tier 4 (specialty): deductible/coinsurance applies	string	optional	`FALSEFALSE_COINTRUETRUE_COIN`
`rx1_mail_ded_apply` Rx tier 1 mail order: deductible/coinsurance applies	string	optional	`FALSEFALSE_COINTRUETRUE_COIN`
`rx2_mail_ded_apply` Rx tier 2 mail order: deductible/coinsurance applies	string	optional	`FALSEFALSE_COINTRUETRUE_COIN`
`rx3_mail_ded_apply` Rx tier 3 mail order: deductible/coinsurance applies	string	optional	`FALSEFALSE_COINTRUETRUE_COIN`
`rx4_mail_ded_apply` Rx tier 4 mail order: deductible/coinsurance applies	string	optional	`FALSEFALSE_COINTRUETRUE_COIN`
`pcp_copay` Primary care copay	integer	optional	—
`sp_copay` Specialist copay	integer	optional	—
`er_copay` Emergency room copay	integer	optional	—
`uc_copay` Urgent care copay	integer	optional	—
`lx_copay` Lab & X-ray copay	integer	optional	—
`ip_copay` Inpatient copay	integer	optional	—
`op_copay` Outpatient copay	integer	optional	—
`rx1_copay` Rx tier 1 (generic) copay	integer	optional	—
`rx2_copay` Rx tier 2 (preferred brand) copay	integer	optional	—
`rx3_copay` Rx tier 3 (non-preferred brand) copay	integer	optional	—
`rx4_copay` Rx tier 4 (specialty) copay	integer	optional	—
`rx1_mail_copay` Rx tier 1 mail-order copay	integer	optional	—
`rx2_mail_copay` Rx tier 2 mail-order copay	integer	optional	—
`rx3_mail_copay` Rx tier 3 mail-order copay	integer	optional	—
`rx4_mail_copay` Rx tier 4 mail-order copay	integer	optional	—
`hra` HRA offered	boolean	required	—
`hsa` HSA offered	boolean	required	—
`fsa` FSA offered	boolean	required	—
`age_rated` Age-rated premiums	boolean	required	—
`salary_banding` Salary-banded contributions	boolean	required	—
`tobacco_surcharge` Tobacco surcharge (PEPY)	integer	required	—
`spousal_surcharge` Spousal surcharge (PEPY)	integer	required	—
`t1_ercdhp` Tier 1 employer HSA/CDHP funding	integer	required	—
`t2_ercdhp` Tier 2 employer HSA/CDHP funding	integer	required	—
`t3_ercdhp` Tier 3 employer HSA/CDHP funding	integer	required	—
`t4_ercdhp` Tier 4 employer HSA/CDHP funding	integer	required	—

Create Dental Plan

POST /plans/dental/

38 of 38 fields · 21 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`funding` Funding type	string	required	`FUNDING_FULLYFUNDING_LEVELFUNDING_SELF`
`t1_ee` Tier 1 employee contribution (PEPY)	integer	required	—
`t2_ee` Tier 2 employee contribution (PEPY)	integer	required	—
`t3_ee` Tier 3 employee contribution (PEPY)	integer	required	—
`t4_ee` Tier 4 employee contribution (PEPY)	integer	required	—
`t1_gross` Tier 1 total cost (PEPY)	integer	required	—
`t2_gross` Tier 2 total cost (PEPY)	integer	required	—
`t3_gross` Tier 3 total cost (PEPY)	integer	required	—
`t4_gross` Tier 4 total cost (PEPY)	integer	required	—
`type` Plan type	string	required	`DPPODMO`
`in_ded_single` In-network deductible (single)	integer	required	—
`in_ded_family` In-network deductible (family)	integer	required	—
`in_max` In-network annual maximum	integer	required	—
`in_max_ortho` In-network orthodontia maximum	integer	optional	—
`out_ded_single` Out-of-network deductible (single)	integer	optional	—
`out_ded_family` Out-of-network deductible (family)	integer	optional	—
`out_max` Out-of-network annual maximum	integer	optional	—
`out_max_ortho` Out-of-network orthodontia maximum	integer	optional	—
`prev_ded_apply` Deductible applies to preventive care	boolean	required	—
`basic_ded_apply` Deductible applies to basic care	boolean	required	—
`major_ded_apply` Deductible applies to major care	boolean	optional	—
`ortho_ded_apply` Deductible applies to orthodontia	boolean	optional	—
`in_prev_coin` In-network preventive coinsurance	integer	optional	—
`in_basic_coin` In-network basic coinsurance	integer	optional	—
`in_major_coin` In-network major coinsurance	integer	optional	—
`in_ortho_coin` In-network orthodontia coinsurance	integer	optional	—
`out_prev_coin` Out-of-network preventive coinsurance	integer	optional	—
`out_basic_coin` Out-of-network basic coinsurance	integer	optional	—
`out_major_coin` Out-of-network major coinsurance	integer	optional	—
`out_ortho_coin` Out-of-network orthodontia coinsurance	integer	optional	—

Create Vision Plan

POST /plans/vision/

33 of 33 fields · 19 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`funding` Funding type	string	required	`FUNDING_FULLYFUNDING_LEVELFUNDING_SELF`
`t1_ee` Tier 1 employee contribution (PEPY)	integer	required	—
`t2_ee` Tier 2 employee contribution (PEPY)	integer	required	—
`t3_ee` Tier 3 employee contribution (PEPY)	integer	required	—
`t4_ee` Tier 4 employee contribution (PEPY)	integer	required	—
`t1_gross` Tier 1 total cost (PEPY)	integer	required	—
`t2_gross` Tier 2 total cost (PEPY)	integer	required	—
`t3_gross` Tier 3 total cost (PEPY)	integer	required	—
`t4_gross` Tier 4 total cost (PEPY)	integer	required	—
`exam_frequency` Exam frequency (months)	integer	required	—
`lenses_frequency` Lenses frequency (months)	integer	required	—
`frames_frequency` Frames frequency (months)	integer	required	—
`contacts_frequency` Contacts frequency (months)	integer	required	—
`exam_copay` Exam copay (in-network)	integer	optional	—
`lenses_copay` Lenses copay (in-network)	integer	optional	—
`frames_copay` Frames copay (in-network)	integer	optional	—
`contacts_copay` Contacts copay (in-network)	integer	optional	—
`exam_allowance` Exam allowance (in-network)	integer	optional	—
`lenses_allowance` Lenses allowance (in-network)	integer	optional	—
`frames_allowance` Frames allowance (in-network)	integer	optional	—
`contacts_allowance` Contacts allowance (in-network)	integer	optional	—
`exam_out_allowance` Exam allowance (out-of-network)	integer	optional	—
`lenses_out_allowance` Lenses allowance (out-of-network)	integer	optional	—
`frames_out_allowance` Frames allowance (out-of-network)	integer	optional	—
`contacts_out_allowance` Contacts allowance (out-of-network)	integer	optional	—

Create Basic Life Plan

POST /plans/basiclife/

13 of 13 fields · 8 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`type` Benefit amount basis	string	required	`MULTIPLE_OF_SALARYFLAT_AMOUNT`
`multiple` Salary multiple	number	optional	—
`multiple_max` Salary-multiple benefit cap	number	optional	—
`flat_amount` Flat benefit amount	number	optional	—
`add` AD&D included	boolean	required	—

Create Voluntary Life Plan

POST /plans/voluntarylife/

13 of 13 fields · 9 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`max` Maximum employee benefit	number	required	—
`guarantee_issue` Guarantee issue amount	number	required	—
`max_spouse` Maximum spouse benefit	number	optional	—
`max_children` Maximum child benefit	number	optional	—
`add` AD&D included	boolean	required	—

Create STD Plan

POST /plans/std/

14 of 14 fields · 12 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`cost_share` Cost-share model	string	required	`EMPLOYER_PAIDEMPLOYEE_COST_SHAREVOLUNTARY`
`percentage` Income replacement percentage	integer	required	—
`weekly_max` Weekly benefit maximum	integer	required	—
`waiting_days_injury` Waiting period, injury (days)	integer	required	—
`waiting_days_sick` Waiting period, illness (days)	integer	required	—
`duration_weeks` Benefit duration (weeks)	integer	required	—

Create LTD Plan

POST /plans/ltd/

12 of 12 fields · 10 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`pt` Offered to part-time employees	boolean	required	—
`cost_share` Cost-share model	string	required	`EMPLOYER_PAIDEMPLOYEE_COST_SHAREVOLUNTARY`
`percentage` Income replacement percentage	integer	required	—
`monthly_max` Monthly benefit maximum	integer	required	—
`waiting_weeks` Waiting period (weeks)	integer	required	—

Create Stop Loss Plan

POST /plans/stoploss/

12 of 12 fields · 9 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`spec_ded` Specific deductible	integer	required	—
`spec_rate_single` Specific rate (single)	integer	required	—
`spec_rate_family` Specific rate (family)	integer	required	—
`num_lasers` Lasered individuals	integer	required	—
`agg_rate` Aggregate rate	integer	optional	—

Create Supplemental Plan

POST /plans/supplemental/

15 of 15 fields · 13 required

Field	Type	Req.	Allowed values
`employer` Employer ID	string	required	—
`title` Plan title	string	required	—
`carrier` Carrier / ASO provider	string	required	—
`start_date` Plan start date	string	required	—
`end_date` Plan end date	string	required	—
`from_plan` Prior-year plan ID	string	optional	—
`from_action` Prior-year relationship	string	optional	`RENEWEDCONVERTED`
`critical_illness` Critical illness offered	boolean	required	—
`hospital_indemnity` Hospital indemnity offered	boolean	required	—
`accident` Accident offered	boolean	required	—
`cancer` Cancer offered	boolean	required	—
`pet` Pet insurance offered	boolean	required	—
`legal_assist` Legal assistance offered	boolean	required	—
`credit_protection` Credit protection offered	boolean	required	—
`tuition_reimburse` Tuition reimbursement offered	boolean	required	—

Create User

POST /users/

4 of 4 fields · 4 required

Field	Type	Req.	Allowed values
`email` Work email	string	required	—
`first_name` First name	string	required	—
`last_name` Last name	string	required	—
`division_ids` Division IDs	array<string>	required	—

Create Division

POST /divisions/

3 of 3 fields · 3 required

Field	Type	Req.	Allowed values
`name` Name	string	required	—
`users` User emails	array<string>	required	—
`employer_ids` Employer IDs	array<string>	required	—

Add User to Division

POST /divisions/{divisionID}/addUser/

1 of 1 fields · 1 required

Field	Type	Req.	Allowed values
`email` Work email	string	required	—