Download Document
The download-document endpoint is tailored for retrieving and downloading documents directly from our platform. It supports fetching documents by their unique identifiers and types, providing a streamlined process for accessing specific documents as needed.
POST
/document-api/v1/download-document
Request
- Schema
- Example
Attribute | Type | Required |
---|---|---|
documentTypeName | string | ✔️ |
documentId | string | ✔️ |
{
"documentTypeName": "New Accounts Documents",
"documentId": "7de94c49-a3a8-4339-b9b5-b13000d086f5"
}
Response
The response will be a file. Depending on your implementation, you might need to:
- Directly display the file in a user interface.
- Prompt the user to download the file.
- Automatically save the file to a predefined location.