Demographic Fields

Listed below are the data fields that can be accessed for Demographic 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 POST/PUT/GET Demographic 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.

Subscriber

Subscriber Fields	Data Types	Field Descriptions
payroll_schedules	array	Payroll Schedules
(within array payroll schedules) id	integer	ID of payroll schedule
(within array payroll schedules) name	string	Name of payroll schedule
(within array payroll schedules) lookup_code	string	Lookup code of payroll schedule
termination_reason	array	Termination Reason
(within array termination reason) lookup_code	string	Lookup code of termination reason
(within array termination reason) name	string	Name of termination reason
(within array termination reason) description	string	Description of termination reason
id	integer	Unique ID assigned to Subscriber
organization_id	integer	Organization ID
first_name	string	First Name
last_name	string	Last Name
middle_name	string	Middle Name
address_1	string	Address 1
address_2	string	Address 2
city	string	City
state	string	State
county	string	County
zip_code	string	Zip Code
country	string	Country
home_phone	string	Home Phone
work_phone	string	Work/Office Phone
cell_phone	string	Cell Phone
email	string	E-Mail
email2	string	Alternative E-mail
gender	string	Gender
hire_date	string	Hire Date
rehire_date	string	Rehire Date
birthdate	string	Birth Date
original_effective_date	string	Original Effective Date
change_effective_date	string	Change Effective Date
termination_date	string	Termination Date
termination_reason_id	string	Termination Reason ID
employment_level	string	Level of employment (Full or Part Time)
pay_type	string	Type of Pay (Salaried, Hourly, etc.)
user_id	string	ID Number For Employee
pay_rate	string	Pay Rate
org_payroll_id	string	Payroll ID
employee_number	string	Employee Number
enc_ssn	string	ENC SSN
public_id	string	Subscriber ID
marital_status	string	Marital Status
division	string	Division
location	string	Location
org_class	string	Class (manager, admin, etc.)
business_title	string	Business Title
union_code	string	Union
ee_code	string	External Private ID
subscriber_code	string	API-SSO Lookup Code
benefit_company	string	Benefit Company
original_hire_date	string	Original Hire Date
seniority_date	string	Seniority Date
employment_status	string	Employment Status
employment_status_starts_on	string	Employment Status Start Date
employment_status_ends_on	string	Employment Status End Date
employee_type	string	Employment Type
current_salary_effective_on	string	Current Salary Effective On
current_salary	string	Current Salary
benefit_deduction_group	string	Deduction Group
highly_compensated	string	Highly Compensated
vip	string	VIP
fmla	string	FMLA
name_suffix	string	Name Suffix
udef_1	string	User Defined Field 1
udef_2	string	User Defined Field 2
udef_3	string	User Defined Field 3
udef_4	string	User Defined Field 4
udef_5	string	User Defined Field 5
udef_6	string	User Defined Field 6
udef_7	string	User Defined Field 7
udef_8	string	User Defined Field 8
udef_9	string	User Defined Field 9
udef_10	string	User Defined Field 10
udef_11	string	User Defined Field 11
udef_12	string	User Defined Field 12
udef_13	string	User Defined Field 13
udef_14	string	User Defined Field 14
udef_15	string	User Defined Field 15
udef_16	string	User Defined Field 16
udef_17	string	User Defined Field 17
udef_18	string	User Defined Field 18
udef_19	string	User Defined Field 19
udef_20	string	User Defined Field 20
udef_21	string	User Defined Field 21
udef_22	string	User Defined Field 22
udef_23	string	User Defined Field 23
udef_24	string	User Defined Field 24
udef_25	string	User Defined Field 25
udef_26	string	User Defined Field 26
udef_27	string	User Defined Field 27
udef_28	string	User Defined Field 28
udef_29	string	User Defined Field 29
udef_30	string	User Defined Field 30
benefits_start_date	string	Eligibility Period Start Date
benefits_end_date	string	Eligibility Period End Date
parent_dependent_id	string	Parent Subscriber
ssn	string	SSN
org_admin_enroll_reason_id	string	Admin Enroll Reason
is_voluntary_termination	string	Voluntary Termination
shareholder	string	Shareholder
owner	string	Owner
anthem_hcid	string	Anthem HCID
anthem_member_code	string	Anthem Member Code
anthem_emp_dept_code	string	Anthem Employee Department Code
written_language	string	Preferred Written Language
spoken_language	string	Preferred Spoken Language
anthem_sub_id	string	Anthem Sub ID
hours_per_week	string	Hours Per Week
medicare_reason	string	Medicare Reason
medicare_plan	string	Medicare Plan
medicare_effective_date	string	Medicare Begin Date
medicare_termination_date	string	Medicare Termination Date
is_smoker	string	Tobacco User. Valid values are YES or NO
is_aca_full_time_for_enrollment	string	Is ACA full time for enrollment

Dependent

Dependent Fields	Data Types	Field Descriptions
first_name	string	First Name
middle_name	string	Middle Name
last_name	string	Last Name
birthdate	string	Birth Date
gender	string	Gender
relationship_code	string	Relationship Code
address_1	string	Address 1
address_2	string	Address 2
city	string	City
state	string	State
zip_code	string	Zip Code
country	string	Country
ssn	string	SSN
qmsco	string	QMSCO
name_suffix	string	Name Suffix
verified	string	Verified
verification_expires_on	string	Verification Expires On
anthem_member_code	string	Anthem Member Code
medicare_reason	string	Medicare Reason
medicare_plan	string	Medicare Plan
medicare_effective_date	string	Medicare Effective Date
medicare_termination_date	string	Medicare Termination Date
is_smoker	string	Is Smoker
udef_1	string	User Defined Field 1
udef_2	string	User Defined Field 2
udef_3	string	User Defined Field 3
udef_4	string	User Defined Field 4
udef_5	string	User Defined Field 5
udef_6	string	User Defined Field 6
udef_7	string	User Defined Field 7
udef_8	string	User Defined Field 8
udef_9	string	User Defined Field 9
udef_10	string	User Defined Field 10
termination_reasons	string	Termination Reasons
relationships	string	Relationships
name	string	Name
lookup_code	string	Lookup Code
id	integer	ID
subscriber_id	string	Subscriber ID

Beneficiary

Beneficiary Fields	Data Types	Field Descriptions
subscriber_id	string	Subscriber ID
termination_reasons	string	Termination Reasons
id	integer	ID
name	string	Name
lookup_code	string	Lookup Code
relationship	string	Relationship
allocation	integer	Allocation
primary_beneficiary	boolean	Primary Beneficiary
coverage_line_id	integer	Coverage Line ID
address_1	string	Address 1
address_2	string	Address 2
city	string	City
state	string	State
country	string	Country
zip_code	string	Zip Code
udef_1	string	User Defined Field 1
coverage_id	integer	Coverage ID

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

Subscriber

Dependent

Beneficiary