Participant APIs | REST

Version:
Download Open API Specification

Get the details of a FAQ

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

Retrieve detailed information about a specific FAQ entry identified by the TPA ID and Info Key. This operation is useful for displaying FAQ content in the WealthCare Portal or Mobile applications.

  • tpaId string Required

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

  • Accept-Language enum<string>

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

    Possible values: es en fr
  • infoKey integer <int32> Required

    The unique identifier for the FAQ entry, used to retrieve specific information about that FAQ.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

  • 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.