Participant APIs | REST

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

Participant Id

Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

The name of the employee’s medical insurance carrier.

The annual deductible for this employee’s medical insurance.

The amount the employee has paid toward his deductible in the current plan year.

If Direct Deposit Bank Account doesn't exist for the Employee, then 0 will be returned. If the Direct Deposit Bank Account Validation feature is Not Enabled for the TPA and a Direct Deposit Bank Account exists, then 2 will be returned. If the Direct Deposit Bank Account Validation feature is Enabled for the TPA and a Direct Deposit Bank Account exists, then a value ranging from 1 to 7 will be returned.

If Direct Deposit Bank Account doesn't exist for the Employee, then status description will be blank. If the Direct Deposit Bank Account Validation feature is Not Enabled for the TPA and a Direct Deposit Bank Account exists, then Active will be returned. If the Direct Deposit Bank Account Validation feature is Enabled for the TPA and a Direct Deposit Bank Account exists, then the status description will be returned as follows: 1 - New; 2 - Active; 3 - Temporarily Inactive; 4 - Permanently Inactive; 5 - Pending Validation; 6 - Validation Required; 7 - Validation Failed

Title for employee, such as Mr., Mrs., Ms., Dr., or Rev

Employee’s last name.

Employee’s first name.

Employee’s middle initial.

Employee’s phone number, including area code.

Employee’s mobile phone number including area code.

First line of the employee’s mailing address.

Second line of the employee’s mailing address.

City associated with the employee’s mailing address.

Two-character state code associated with the employee’s mailing address.

ZIP code associated with the employee’s mailing address.

Country associated with the employee’s mailing address, usually US.

Reimbursement Method for reimbursing an employee or dependent.

Employee’s email address.

You can define this field. WCA does not use it.

Activity status for the employee.

Marital status of the employee.

First line of the employee’s shipping address.

Second line of the employee’s shipping address.

City associated with an employee’s shipping address.

The 2-character state code associated with the employee’s shipping address.

ZIP code associated with the employee’s shipping address.

Country associated with the employee’s shipping address.

Employee's Date of birth.

Bank Routing number of employee direct deposit account.

Employee's bank account number for direct deposit reimbursements.

Employee's bank account type.

Bank Name of employee direct deposit account.

Any comments about the employee. Note: This is field is for information only.

Employee’s social security number.

An assigned ID for the employee’s health plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.

An assigned ID for the employee’s dental plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.

An assigned ID for the employee’s vision plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.

An assigned ID for the pharmacy benefits management (PBM) organization handling pharmaceutical benefits for employees. Note: You can use this field for TPS matching but cannot use it to search for an employee.

Date when the employee was hired.

Last date the employee demographic data was modified.

Benefits Card number of the employee.

Employee's Date of Termination.

Division to which employee is assigned, if division functionality is in use.

Name of employer for whom employee works.

Coverage ID that is associated with an employee’s primary Healthcare Coverage. The employee will be linked to all healthcare coverage types—Medical, Pharmacy, Dental, Hospital, and Vision and/or Hearing copays—associated with this Healthcare Coverage option.

Coverage ID that is associated with the Medical Coverage type and links the employee to the copays for this coverage type.

Coverage ID that is associated with the Pharmacy Coverage type and links the employee to the copays for this coverage type.

Coverage ID that is associated with the Dental Coverage type and links the employee to the copays for this coverage type. Note 1: Providing a Coverage ID for Dental Coverage takes priority over the default Healthcare Coverage for this type. Note 2: The Coverage ID is required in order for employee-level co-pay amounts to be associated with this particular coverage.

Coverage ID that is associated with the Hospital Coverage type and links the employee to the copays for this coverage type.

Coverage ID that is associated with the Vision Coverage type and links the employee to the copays for this coverage type.

Coverage ID that is associated with the Hearing. Coverage type and links the employee to the copays for this coverage type.

Flag indicating whether the employee is eligible for an High Deductible Health Plan. 0 = No 1 = Yes

Employee Driver’s License Number.

Employee's mother’s maiden name.

Indicates participant as a Medicare beneficiary.

This value is the active covered individual’s/beneficiary’s health insurance claim number.

This is the processing notes entered by the administrator for the specified individual.

This code is used to identify specific individuals on a policy for Medicare Reporting. The values are established by the insurer. May also be known as a Dependent Code.

Indicates whether the participant has ESRD for Medicare Reporting. 0 = No, this person does not have ESRD 1 = Yes, this person has ESRD

If the Employer is eligible for Card and has got a CRA Plan, then True, Otherwise False.

List of available reimbursement methods for employee to choose.