Participant APIs | REST

Selected Version:
Download Open API File

Add a downloadable form

https://api.wealthcare.com/participant/services/portalinfo/downloadableform

Allows you to add a downloadable form to the portal, enabling participants to access important documents and resources. This operation is typically used when new forms need to be made available or existing forms need to be updated.

Request

Request body

Request body page anchor
  • FileDetails object

    Contains details about the file requested for download.

    • FileKey integer <int32>

      File Key

    • FileFormat enum<string>
      Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
    • ContentLength integer <int32>

      The file length, in bytes.

    • ContentType string

      The MIME content type of the uploaded file.

    • FileName string

      The name of the client's file, including the directory path.

    • InputStream string <byte>

      A System.IO.Stream pointing to a file.

    • Base64 string

      The string representation in Base 64 of the file content.

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

  • FileDetails object

    Contains details about the file requested for download.

    • FileKey integer <int32>

      File Key

    • FileFormat enum<string>
      Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
    • ContentLength integer <int32>

      The file length, in bytes.

    • ContentType string

      The MIME content type of the uploaded file.

    • FileName string

      The name of the client's file, including the directory path.

    • InputStream string <byte>

      A System.IO.Stream pointing to a file.

    • Base64 string

      The string representation in Base 64 of the file content.

  • 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

Response body

Response body page anchor
  • FileDetails object

    Contains details about the file requested for download.

    • FileKey integer <int32>

      File Key

    • FileFormat enum<string>
      Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
    • ContentLength integer <int32>

      The file length, in bytes.

    • ContentType string

      The MIME content type of the uploaded file.

    • FileName string

      The name of the client's file, including the directory path.

    • InputStream string <byte>

      A System.IO.Stream pointing to a file.

    • Base64 string

      The string representation in Base 64 of the file content.

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

  • FileDetails object

    Contains details about the file requested for download.

    • FileKey integer <int32>

      File Key

    • FileFormat enum<string>
      Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
    • ContentLength integer <int32>

      The file length, in bytes.

    • ContentType string

      The MIME content type of the uploaded file.

    • FileName string

      The name of the client's file, including the directory path.

    • InputStream string <byte>

      A System.IO.Stream pointing to a file.

    • Base64 string

      The string representation in Base 64 of the file content.

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

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...