EOI Fields

EOI

Listed below are the data fields that can be accessed for EOI data using PlanSource's API. Each field is described as being "optional". That is because developers are not required to fill out every data field in order to make the API call. Although that is the case, PlanSource does require certain data fields to be entered in order to PUT/GET EOI data. What is required can be changed manually within the PlanSource Benefits Admin site by utilizing the Data Field Security configuration.

📘
NOTE: Some of these fields are list validated fields. To learn what that means, visit the Guide on List Validated Fields.

EOI Fields	Data Types	Field Descriptions
form_completions	role object	Form completions role object. Define fields and their values within this role object
decisions	role object	Decisions role object. Define fields and their values within this role object
subscriber_id	string	Unique ID for subscriber. Used as a parameter in endpoint URL
id	integer	Unique ID for subscriber retrieved when making a GET call
first_name	string	First Name
last_name	string	Last Name
middle_name	string	Middle Name
ssn	string	SSN
benefits	string	Benefits
completed	string	Completed. Either "true" or "false"
expiration_date	string	Expiration Date
reference_number	string	Reference Number
benefit_name	string	Benefit Name
benefit_lookup_code	string	Benefit Lookup Code
plan_name	string	Plan Name
coverage_id	integer	Coverage ID
coverage_line_id	integer	Coverage Line ID
volume	number	Volume
req_volume	number	Requested Volume
req_plan_name	string	Requested Plan Name
eoi_volume	number	EOI Volume
gi_volume	number	GI Volume
eoi_form	string	EOI Form. Either Complete of Incomplete
original_effective_date	string	Original Effective Date
change_effective_date	string	Change Effective Date
dependents	array	Dependents
(within array dependents) id	integer	ID for dependent
(within array dependents) first_name	string	First Name of dependent
(within array dependents) last_name	string	Last Name of dependent
(within array dependents) middle_name	string	Middle Name of dependent
(within array dependents) ssn	string	SSN of dependent
valid_count	number	Valid Count
failed_count	number	Failed Count
failed_rows	array	Failed Rows
action	string	Action for Processing
approved_volume	number	Approved Volume
effective_date	string	Effective Date