Skip to main content
Version: 1.0.1

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​

PropertyValue
URLGET /archive-link/list/{{companyId}}
MethodGET
AuthR-Auth: <company-jwt>
Base URLStage 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​

ParameterTypeRequiredDescription
companyIdUUIDYesCompany UUID (path)
pagenumberNoPage number, starting from 0
sizenumberNoPage 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​

FieldDescription
tokenArchive link UUID. Used in Download archive link
statusLink status. See Link statuses
createdTimeTimestamp when the link was requested
countryCountry of the company, for example FR
dateFrom / dateToRequested date range
documentCountNumber of documents selected for the zip
paymentRequiredAlways false for white label partner companies
failureReasonReason of the failure when status is FAILED, otherwise null
daysRemainingDays left before the link expires. null until the zip is generated
fileCountNumber of files in the zip: the documents plus the index, hash list, audit trail and readme files. null until the zip is built
undatedDocumentCountArchived documents of the company with no provable business date, so not selectable by the range
unprovableDocumentCountInvoices 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.

ValueDescription
PENDINGWaiting in the queue for the zip build
PROCESSINGThe zip is being built
READYThe zip is ready to download
FAILEDThe zip build failed. See failureReason
EXPIREDThe link has expired. Create a new one

A link stays valid for 10 days after the zip is generated.

Errors​

HTTPDescription
401Missing or expired JWT
403The user is not allowed to manage archive links for this company