Participant APIs | REST

Selected Version:
Download Open API File

Get HSA Statement PDF

https://api.wealthcare.com/participant/services/documents/HSAStatements/{tpaId}/{employerId}/{participantId}/pdf

Retrieve the HSA statement PDF for a specific participant, identified by their TPA ID, Employer ID, and Participant ID. This operation is typically used to obtain the latest HSA statement for review or record-keeping 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.

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • participantId string Required

    Unique identifier for the participant user whose feature information is being retrieved.

  • flexAcctId string Required

    A unique identifier for the flex account, used to specify which account's HSA statement is being requested.

  • documentKey integer <int32> Required

    An integer key representing the specific document to retrieve. This key is essential for identifying the correct HSA statement.

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

  • statementOption integer <int32>

    Options for the HSA statement retrieval, where each integer value corresponds to a specific action or state of the statement (e.g., 0 for None, 1 for WCHSAStatement, etc.). This parameter influences the type of statement returned.

Response

Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...