Participant APIs | REST

Version:
Download Open API Specification

Get disclose document details

https://api.wealthcare.com/participant/services/hsainvestment/disclosure/document/{tpaId}

Retrieve detailed information about a specific disclosure document associated with a given TPA ID. This endpoint is typically used to access document metadata for compliance or informational purposes.

Request

  • tpaId string Required

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

  • trustPlanIdKey integer <int32> Required

    The unique identifier for the trust plan associated with the document. This parameter is required to filter the document results based on the specific trust plan.

  • fileKey integer <int32> Required

    The unique key that identifies the specific file within the system. This parameter is essential for retrieving the correct document 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
  • FileKey integer <int32>
  • FileFormat enum<string>
    Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
  • FileType enum<string>
    Possible values: All Unknown BatchImport BatchExport BatchResults AllEft CheckExport CheckPrinting DirectDepositExport CheckSignature Report CardStockImage ReceiptNotification LogoImage DirectDepositNacha TpsForm ReminderNotification RnImage DenialLetter DenialImage ReimbursementLetter ThermalLogoImage FTP DownloadableForm UploadedReceiptClaim UploadedReceiptPOS AutomaticDirectDeposit EmployerFundingNachaClaimBased EmployerFundingNachaOnDemand ParticipantExpenseReceipt ParticipantInteractionDocument TrustPlanDisclosureDocuments EmployerInteractionDocument EmployerDocuments PositivePayFiles WcaHsaStmtLogo LetterCommunicationFiles DataPartnerCheckLogo DataPartnerCheckSignature TpaLogo TpaSignature ReimbusmentCheck HSACheck EmprNonHSAPayrollFundingNACHA PayrollExport DocumentManagement DataPartnerCustomEStatementOptInPDF SFTPDocumentQueue EmployerFundingNachaHSAAdv EmployeeDocuments HSACheckReimbursementCsv HSACheckReimbursementResponseCsv
  • FileName string
  • UploadedDate string <date-time>
  • DocumentData string <byte>

AI Assistant Preview

Generating response...