Get a list of documents

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

Retrieve a list of documents associated with a specific TPA ID. This endpoint is useful for fetching documents relevant to participants based on various retrieval options.

Request

Path parameters

tpaId string Required

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

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference for the response. Valid values include "es" for Spanish, "en" for English, and "fr" for French. If not specified or if an invalid value is sent, the response defaults to English.

Possible values: es en fr

Query parameters

retrieveOptions enum<string>

Defines the criteria for document retrieval. Options include: Hidden = 1, AllEmployer = 2, SelectedEmployer = 3, DocumentAudience = 4, All = 10. Each option affects which documents are returned based on the specified context.

Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All
employerId string

Unique identifier for the employer, required when retrieve options is set to AllEmployer (2). The employer ID is assigned a 3-character prefix by WealthCare Admin, followed by user-defined characters.
audienceId string

Identifier for the audience, required when retrieve options is set to DocumentAudience (4). This parameter helps filter documents based on the intended audience.
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

Response body

array <object>
- DocumentKey integer <int32>
- TpaId string
- DocumentId string
- DocumentName string
- Description string
- DocumentPostDate string <date-time>
- ExpireDate string <date-time>
- CategoryId string
- CategoryName string
- DisplayOrder integer <int32>
- AudienceId string
- AudienceName string
- DocumentFileKey integer <int32>
- FileDetails object
  - DocumentFileKey integer <int32>
  - ContentLength integer <int32>
  - ContentType string
  - FileName string
  - InputStream string <byte>
  - Base64 string
  - FileFormat enum<string>
    
    Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
- LastUpdateDate string <date-time>
- Employers array <object>
  - TpaId string
  - EmprId string
  - EmprName string
- isLegacyDocument boolean
- AssignedOption enum<string>
  
  Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All

Participant APIs | REST