Participant APIs | REST

Selected Version:
Download Open API File

Get a list of FAQs

https://api.wealthcare.com/participant/services/portalinfo/faq/{tpaId}/{employerId}

Retrieve a list of frequently asked questions (FAQs) for a specific TPA and employer combination, allowing participants to access relevant information easily.

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.

  • Accept-Language enum<string>

    Specify the participant’s language preference. The response will return text in the specified language, defaulting to English if not provided or if an invalid value is sent. If Spanish or French is requested and a particular field lacks a translated value, the English text will be returned.

    Possible values: es en fr
  • 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

      Unique id of the TPA

    • InfoKey integer <int32>

      Portal Info Key

    • InfoName string

      Portal Info Name

    • InfoDesc string

      Portal Info Description

    • InfoDate string <date-time>

      Portal Info Date

    • ExpireDate string <date-time>

      Portal Info Expiration Date

    • LastUpdateDate string <date-time>

      Date in which Portal Info was last updated

    • EmployerIdList array <string>

      List of Employer IDs

    • VisibilityIsGlobal boolean

      Global Visibility. True = Visible to the participant. False = Not visible to the participant.

    • VisibilityIsNone boolean

      No Visibility. True = Not visible to the participant. False = Visible to the participant.

  • array <object>
    • TpaId string

      Unique id of the TPA

    • InfoKey integer <int32>

      Portal Info Key

    • InfoName string

      Portal Info Name

    • InfoDesc string

      Portal Info Description

    • InfoDate string <date-time>

      Portal Info Date

    • ExpireDate string <date-time>

      Portal Info Expiration Date

    • LastUpdateDate string <date-time>

      Date in which Portal Info was last updated

    • EmployerIdList array <string>

      List of Employer IDs

    • VisibilityIsGlobal boolean

      Global Visibility. True = Visible to the participant. False = Not visible to the participant.

    • VisibilityIsNone boolean

      No Visibility. True = Not visible to the participant. False = Visible to the participant.

Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...