Get a list of documents

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

Retrieve a list of documents associated with a specific TPA ID, allowing users to access relevant documentation based on their preferences and permissions.

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. The API will return text in the specified language, defaulting to English if not provided or if an invalid value is sent. If a requested language lacks a translation for a specific field, the English text will be returned.

Possible values: es en fr

Query parameters

retrieveOptions enum<string>

Defines the source of documents to retrieve. Options include: Hidden = 1, AllEmployer = 2, SelectedEmployer = 3, DocumentAudience = 4, All = 10. The choice of option influences the documents returned based on visibility and audience.

Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All
employerId string

Unique identifier for the employer, assigned by WealthCare Admin. This parameter is required when retrieveOptions is set to 2 (AllEmployer) to filter documents accordingly.
audienceId string

Identifier for the audience. This parameter is mandatory when retrieveOptions is set to 4 (DocumentAudience) to ensure the correct documents are retrieved for the specified audience.
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.

Response

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