Delete a document

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

Deletes a specified document from the system, identified by its unique TPA ID and document ID. This operation is typically used to remove outdated or unnecessary documents from the document management system.

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.
documentId string Required

Document Id

Query parameters

isLegacyDocument boolean

Indicates whether the document is a legacy document. Set to true if it is a legacy document; otherwise, set to false.
refresh boolean

Determines the response behavior after deletion. Set to true to return the updated list of documents after deletion; set to false to return an empty response.
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

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

Request URL

Authorization Bearer Token

tpaId (Required)

documentId (Required)

isLegacyDocument

refresh

decrypt

No response yet.

No response yet.

Participant APIs | REST