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 FieldsData TypesField Descriptions
form_completionsrole objectForm completions role object. Define fields and their values within this role object
decisionsrole objectDecisions role object. Define fields and their values within this role object
subscriber_idstringUnique ID for subscriber. Used as a parameter in endpoint URL
idintegerUnique ID for subscriber retrieved when making a GET call
first_namestringFirst Name
last_namestringLast Name
middle_namestringMiddle Name
ssnstringSSN
benefitsstringBenefits
completedstringCompleted. Either "true" or "false"
expiration_datestringExpiration Date
reference_numberstringReference Number
benefit_namestringBenefit Name
benefit_lookup_codestringBenefit Lookup Code
plan_namestringPlan Name
coverage_idintegerCoverage ID
coverage_line_idintegerCoverage Line ID
volumenumberVolume
req_volumenumberRequested Volume
req_plan_namestringRequested Plan Name
eoi_volumenumberEOI Volume
gi_volumenumberGI Volume
eoi_formstringEOI Form. Either Complete of Incomplete
original_effective_datestringOriginal Effective Date
change_effective_datestringChange Effective Date
dependentsarrayDependents
(within array dependents) idintegerID for dependent
(within array dependents) first_namestringFirst Name of dependent
(within array dependents) last_namestringLast Name of dependent
(within array dependents) middle_namestringMiddle Name of dependent
(within array dependents) ssnstringSSN of dependent
valid_countnumberValid Count
failed_countnumberFailed Count
failed_rowsarrayFailed Rows
actionstringAction for Processing
approved_volumenumberApproved Volume
effective_datestringEffective Date