Skip to main content
POST
PDF to PDF/A
Full reference: PDF to PDF/A covers parameters, validation states, billing and limits. This operation starts a background job. Use Background Job Check to retrieve the final files.

Authorizations

x-api-key
string
header
required

Body

application/json
url
string<uri>
default:https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf
required

URL to the source file url attribute.

callback
string<uri>

Callback URL notified when the background job finishes. Use it instead of polling.

name
string

Output PDF file name. If omitted, it derives from url when possible.

expiration
integer
default:60

Minutes before temporary output and report URLs expire. The maximum also depends on the subscription plan and cannot exceed seven days.

Response

Background job accepted. File links are returned only in the final job result when those files are produced.

pageCount
integer

Page count reported when the job is accepted; read the output count from the final job result.

error
boolean

False when the job was accepted.

status
integer

HTTP status code of the submission request, not the background job status.

duration
integer

Time to accept the request in milliseconds, excluding conversion and validation.

name
string

Planned converted PDF file name.

validationReportName
string

Planned validation report file name.

jobId
string

Background job identifier. Poll /v1/job/check or use a callback for the final result.

credits
integer

Credits charged for processing the first page only.

remainingCredits
integer

Credits remaining for the account.