List archive links
List the archive links of a company, newest first. Use it to follow the status of a link until it is READY.
Endpoint
| Property | Value |
|---|---|
| URL | GET /archive-link/list/{{companyId}} |
| Method | GET |
| Auth | R-Auth: <company-jwt> |
| Base URL | Stage Environment https://api-fr-stage.docnova.ai/ Production Environment https://api-fr.docnova.ai/ |
Example Request
curl --location '{{baseUrl}}/archive-link/list/{{companyId}}?page=0&size=20' \
--header 'R-Auth: {{companyJwt}}'
Path and query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
companyId | UUID | Yes | Company UUID (path) |
page | number | No | Page number, starting from 0 |
size | number | No | Page size |
Response
{
"content": [
{
"token": "1bb56def-1031-4fbb-bb8c-69b49691f482",
"status": "READY",
"createdTime": "2026-07-01T09:15:42",
"country": "FR",
"dateFrom": "2026-01-01",
"dateTo": "2026-06-30",
"documentCount": 128,
"paymentRequired": false,
"failureReason": null,
"daysRemaining": 9,
"fileCount": 133,
"undatedDocumentCount": 0,
"unprovableDocumentCount": 0
}
],
"totalElements": 1,
"totalPages": 1,
"number": 0,
"size": 20
}
The response is a standard paged object. The fields below describe each item in content.
Response fields
| Field | Description |
|---|---|
token | Archive link UUID. Used in Download archive link |
status | Link status. See Link statuses |
createdTime | Timestamp when the link was requested |
country | Country of the company, for example FR |
dateFrom / dateTo | Requested date range |
documentCount | Number of documents selected for the zip |
paymentRequired | Always false for white label partner companies |
failureReason | Reason of the failure when status is FAILED, otherwise null |
daysRemaining | Days left before the link expires. null until the zip is generated |
fileCount | Number of files in the zip: the documents plus the index, hash list, audit trail and readme files. null until the zip is built |
undatedDocumentCount | Archived documents of the company with no provable business date, so not selectable by the range |
unprovableDocumentCount | Invoices in the range whose original could not be proven. They are listed in MISSING_ORIGINALS.csv inside the zip but are not included |
note
The response also contains payment fields (clientSecret, paid, amount, taxAmount). They are not used for white label partner companies.
Link statuses
| Value | Description |
|---|---|
PENDING | Waiting in the queue for the zip build |
PROCESSING | The zip is being built |
READY | The zip is ready to download |
FAILED | The zip build failed. See failureReason |
EXPIRED | The link has expired. Create a new one |
A link stays valid for 10 days after the zip is generated.
Errors
| HTTP | Description |
|---|---|
401 | Missing or expired JWT |
403 | The user is not allowed to manage archive links for this company |