Participant APIs | REST

Version:
Download Open API Specification

Get download form

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

Retrieve a downloadable form associated with a specific TPA ID. This operation is typically used to access forms needed for various participant-related processes.

  • tpaId string Required

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

  • fileKey integer <int32> Required

    The unique identifier for the file being requested. This integer value is essential for retrieving the correct file.

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

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