Skip to content
PDF UA API

Convert and validate HTML to PDF

POST
/convert-and-validate
 
curl --request POST \
  --url http://localhost:8080/convert-and-validate \
  --header 'Content-Type: application/json' \
  --data '{ "attachments": [ { "content": "example", "description": "example", "mimeType": "example", "name": "example", "relationship": "example" } ], "baseUrl": "example", "html": "example" }'

Converts HTML to PDF/A-3a and validates the result. Returns validation results and the base64-encoded PDF.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
attachments
Array<object>
object
content
required
string
description
string
mimeType
string
name
required
string
relationship
string
baseUrl
string
html
required
string
Example generated
{
  "attachments": [
    {
      "content": "example",
      "description": "example",
      "mimeType": "example",
      "name": "example",
      "relationship": "example"
    }
  ],
  "baseUrl": "example",
  "html": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Conversion and validation result with base64-encoded PDF

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

400

Section titled “400 ”

Invalid request

500

Section titled “500 ”

Conversion or validation failed