Participant APIs | REST

Selected Version:
Download Open API File

Get the details of a FAQ

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

Retrieve detailed information about a specific FAQ entry using its unique identifiers. This operation is useful for displaying FAQ content in the WealthCare Portal or Mobile applications.

Request

  • 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. Valid options are "es" for Spanish, "en" for English, and "fr" for French. If not specified or an invalid value is provided, the response defaults to English. Note that if a requested translation is unavailable, the English text will be returned.

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

    The unique identifier for the portal information entry. This key is required to fetch the specific FAQ details.

  • 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

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

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