Provides an overview of the Documents module
What is Documents
Use the Documents module to receive all data related to documents uploaded by drivers. Drivers can upload documents either as part of structured workflows (while providing feedback) or on an ad-hoc basis through the “Documents” module. The document data includes:
- contextual information to understand what the document is about and who uploaded it
- the files themselves, which are available for download as JPEG images or PDF files. The documents module offers a fast, secure, error prone and automated document gathering solution to improve the way of working for both drivers and dispatchers.
| Base URL | https://documents.api.eu1.scalar.zf.com |
| Audience | DOCAPI |
| Supported Versions | V1 |
Why Use the Documents
Purpose I: Get a grip on all your documents
The documents module offers a centralized place to retrieve all digital documents uploaded by drivers in a unified way and format (jpeg or pdf). This reduces the time to receive documents from drivers and deal with them in the backoffice. As an integrator you can retrieve all documents that were uploaded by drivers during a certain time period.
Purpose II: Get all details about documents
For each uploaded document the following details specifying the ID) are provided:
- Document type
- Document uploaded by (asset and driver)
- Document upload timestamp
- Upload location
- Context of the document upload, such as activity and scheduled trip
Purpose III: Download images and PDFs
You can download the uploaded photos, scans, and signatures either as jpeg images or as pdf file(s) whatever suits best in your business flow.