Create archive link
Request a zip archive of the company's archived documents for a date range. The zip is built in the background. Track the status with List archive links and download it with Download archive link once it is READY.
Endpoint
| Property | Value |
|---|---|
| URL | POST /archive-link/create |
| Method | POST |
| Auth | R-Auth: <company-jwt> |
| Content-Type | application/json |
| Base URL | Stage Environment https://api-fr-stage.docnova.ai/ Production Environment https://api-fr.docnova.ai/ |
Example Request
curl --location '{{baseUrl}}/archive-link/create' \
--header 'Content-Type: application/json' \
--header 'R-Auth: {{companyJwt}}' \
--data-raw '{
"companyId": "{{companyId}}",
"dateFrom": "2026-01-01",
"dateTo": "2026-06-30",
"documentCount": 128
}'
Request body
{
"companyId": "<companyId>",
"dateFrom": "2026-01-01",
"dateTo": "2026-06-30",
"documentCount": 128
}
| Field | Type | Required | Description |
|---|---|---|---|
companyId | UUID | Yes | Company UUID |
dateFrom | date | Yes | Start date, format YYYY-MM-DD |
dateTo | date | Yes | End date, format YYYY-MM-DD. Must be yesterday or earlier |
documentCount | number | Yes | Document count returned by Count archive documents for the same range. The request is rejected if the count has changed |
The range must not exceed 366 days, and dateFrom must not be after dateTo.
Response
{
"token": "1bb56def-1031-4fbb-bb8c-69b49691f482",
"status": "PENDING",
"createdTime": "2026-07-01T09:15:42",
"country": "FR",
"dateFrom": "2026-01-01",
"dateTo": "2026-06-30",
"documentCount": 128,
"paymentRequired": false,
"failureReason": null,
"daysRemaining": null,
"fileCount": null,
"undatedDocumentCount": 0,
"unprovableDocumentCount": 0
}
Response fields
See List archive links for the description of each field. Keep the token, it identifies the link in the list and download endpoints.
White label partner companies are not charged, so the link starts as PENDING and goes straight to the zip build.
Errors
| HTTP | Description |
|---|---|
400 | Invalid date range, or documentCount does not match the current document count for the range |
401 | Missing or expired JWT |
403 | The user is not allowed to manage archive links for this company |
404 | Company or user not found |