Get coverage periods details

https://api.wealthcare.com/participant/services/participant/accounts/coverageperiod/{tpaId}/{employerId}/{participantId}/{flexAcctId}

Provides a list of coverage periods associated with a particular benefit account.

Path parameters

tpaId string Required

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

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

Participant Id
flexAcctId string Required

A 10-character string representing an internal key assigned to a benefit account in the WCA system, used to uniquely identify the account. This value is left-padded with 0s, i.e., "0001699940".

Header parameters

Accept-Language enum<string>

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.

Possible values: es en fr

Query parameters

cardHolderType enum<string>

Indicates the cardholder you want coverage period details returned for: 0 - All, 1 - Employee, 2 - Dependent

Possible values: All Employee Dependent
dependentId string

The dependent ID for the dependent.
decrypt integer <int32>

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

Response

array <object>
- AcctHolderTypeCde integer
  
  Indicates employee vs dependent on the coverage period: 0 = employee, 2 = dependent
- AcctHolderId string
  
  The Dependent ID for any coverage periods returned for a dependent. Blank for coverage periods associated with an employee.
- AcctKey integer <int32>
  
  A unique identifier representing the flex account that was created by WCA when the account was first inserted. Commonly referred to as FlexAcctKey on other services.
- Coveragekey integer <int32>
  
  A unique identifier for the coverage period, which is generated by WCA when the coverage period was created.
- FirstName string
  
  The First Name of the dependent, for any coverage periods returned for that dependent. Blank for coverage periods associated with an employee.
- LastName string
  
  The Last Name of the dependent, for any coverage periods returned for that dependent. Blank for coverage periods associated with an employee.
- CoveragePeriodStartDate string <date-time>
  
  The coverage period's start date
- CoveragePeriodEndDate string <date-time>
  
  The coverage period's end date
- LifeEventType string
  
  The Life Event Code and Life Event Description associated with the Coverage Period. Format is returned as "XXXX - YYYY…" where XXXX is the Life Event Code and YYYY is the Life Event Description. Ex. "0001 - Marital Status - Marriage"
- AnnualElection number <double>
  
  The Annual Election amount for the coverage period.
- IndividualAmt number <double>
  
  The individual spending limit for the dependent, for any coverage periods returned for that dependent. 0.00 is returned for coverage periods associated with an employee.
- DisbYTD number <double>
  
  Disbursed YTD amount for the coverage period.
- AvailBal number <double>
  
  The Available Balance amount for the coverage period.
- PreauthBal number <double>
  
  The Pre-auth Hold amount for the coverage period.
- DisbBal number <double>
  
  Disbursable Balance amount for the coverage period.
- SuspendActivity boolean
  
  Indicates whether the the Suspend Activity flag is set on the Coverage Period: False = disabled, True = enabled
- RecordType string
  
  The Cover Period Record Type. Family is returned for Coverage Periods associated with Employees, and Individual is returned for Coverage Periods associated with Dependents.