Skip to main content

Technical documentation

OpenAPI documentation

The OpenAPI documentation for axesSense is available here. Please use an online Swagger editor to display it in a human friendly format.

Release Notes

New Endpoints

  • v2/apiKey/usage can be used to determine the usage of your API key (number of pages).

Changes

Jobs POST /v2/jobs

  v1 v2
Defective PDF documents Returns a 422 unprocessable entity status code Only the respective check and its subordinate checks are terminated, resulting in Severity = terminated
Transmission base64 Json application/pdf or application/octet-stream
File size limit 20 MB
(As of September 9, 2025)
80 MB

Summary report GET /v2/jobs/{jobId}/report/summary

  v1 v2
Check node ID name "id" "checkId"
Issues   Added "issueId"

Detailed report GET /v2/jobs/{jobId}/report/details

  v1 v2
Check node ID name "id" "checkId"
Issues   Added "issueId"

Report Retention

All reports are stored for 60 days and can be accessed during this period. After that, they are permanently deleted.

Discontinuation of V1 endpoints

The V1 endpoints will be discontinued on March 31, 2026. Please migrate to the V2 endpoints by this date.