Skip to content
PDF/UA API

Validate PDF

POST
/validate
 
curl --request POST \
  --url http://localhost:8080/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/pdf' \
  --data binary

Validates a PDF against PDF/A-3a and PDF/UA-1 standards using veraPDF. Send PDF binary as request body.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/pdf
string format: binary

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Validation result

Media type application/json
ValidationResponse
object
isCompliant
required
boolean
profiles
required
Array<object>
ProfileResult
object
profile
required
string
specification
required
string
isCompliant
required
boolean
totalChecks
required
integer
passedChecks
required
integer
failedChecks
required
integer
summary
required
ValidationSummary
object
totalChecks
required
integer
passedChecks
required
integer
failedChecks
required
integer
categories
Array<object>
CategoryResult
object
category
required
string
passedChecks
required
integer
failedChecks
required
integer
documentInfo
One of:
DocumentInfo
object
pages
required
integer
tagged
required
boolean
language
string | null
structureElements
required
integer
fonts
required
Array<object>
FontInfo
object
name
required
string
embedded
required
boolean
type
required
string
images
required
integer
failures
Array<object>
ValidationFailure
object
profile
required
string
clause
required
string
testNumber
required
integer
category
required
string
message
required
string
location
string | null
errorDetails
string | null
metadata
One of:
PdfMetadata
object
title
string | null
subject
string | null
author
string | null
creator
string | null
producer
string | null
creationDate
string | null
Example generated
{
  "isCompliant": true,
  "profiles": [
    {
      "profile": "example",
      "specification": "example",
      "isCompliant": true,
      "totalChecks": 1,
      "passedChecks": 1,
      "failedChecks": 1
    }
  ],
  "summary": {
    "totalChecks": 1,
    "passedChecks": 1,
    "failedChecks": 1,
    "categories": [
      {
        "category": "example",
        "passedChecks": 1,
        "failedChecks": 1
      }
    ]
  },
  "documentInfo": {
    "pages": 1,
    "tagged": true,
    "language": "example",
    "structureElements": 1,
    "fonts": [
      {
        "name": "example",
        "embedded": true,
        "type": "example"
      }
    ],
    "images": 1
  },
  "failures": [
    {
      "profile": "example",
      "clause": "example",
      "testNumber": 1,
      "category": "example",
      "message": "example",
      "location": "example",
      "errorDetails": "example"
    }
  ],
  "metadata": {
    "title": "example",
    "subject": "example",
    "author": "example",
    "creator": "example",
    "producer": "example",
    "creationDate": "example"
  }
}

400

Section titled “400 ”

PDF content is empty

500

Section titled “500 ”

Validation service error