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 only11 fields

Create Medical Plan

POST /plans/medical/

2 of 74 fields match · 41 required

Field	Type	Req.	Allowed values
`funding` Funding type	string	required	`FUNDING_FULLYFUNDING_LEVELFUNDING_SELF`
`type` Plan type	string	required	`PPOPOSEPOHMOHDHP`

Create Dental Plan

POST /plans/dental/

5 of 38 fields match · 21 required

Field	Type	Req.	Allowed values
`funding` Funding type	string	required	`FUNDING_FULLYFUNDING_LEVELFUNDING_SELF`
`type` Plan type	string	required	`DPPODMO`
`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	—

Create Vision Plan

POST /plans/vision/

1 of 33 fields match · 19 required

Field	Type	Req.	Allowed values
`funding` Funding type	string	required	`FUNDING_FULLYFUNDING_LEVELFUNDING_SELF`

Create Basic Life Plan

POST /plans/basiclife/

3 of 13 fields match · 8 required

Field	Type	Req.	Allowed values
`type` Benefit amount basis	string	required	`MULTIPLE_OF_SALARYFLAT_AMOUNT`
`multiple` Salary multiple	number	optional	—
`flat_amount` Flat benefit amount	number	optional	—