Participant APIs | REST

Version:
Download Open API Specification

Get Account Coverage Tier

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

Retrieve the coverage tier information for a specific participant's account, identified by TPA ID, Employer ID, and Participant ID. This endpoint is useful for obtaining details about the coverage tier associated with a participant's benefits.

Request

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when 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

    Unique identifier for the participant user whose feature information is being retrieved.

  • flexaccountId string

    Optional identifier for a specific flex account associated with the participant. If provided, it filters the results to that account.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Response

  • array <object>
    • TpaId string

      An internal id assigned to TPA in the WCA system.

    • FlexAcctId string

      An internal id assigned to benefit accounts in the WCA system.

    • CoverageTierId string

      An unique id created under coverage tier type in the WCA system.

    • CoverageTierDesc string

      The description of the coverage tier id which was created under coverage tier type in the WCA system

AI Assistant Preview

Generating response...