Forms Document Services API (2024.05-experimental)

Download OpenAPI specification:Download

Document Conversion

Convert various source formats to/from PDF

Converts a PDF document to an XDP.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data
required
HttpUrl (string) or InlineDocument (string)

A PDF which needs to be converted to XDP.

Responses
200

Operation successful. The XDP obtained after converting the supplied PDF document is included in the response.

202

The request is accepted and the result can be checked at the location specified in the header.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/convert/pdftoxdp
Request samples
Response samples
application/problem+json
{}

Document Extraction

Extract information or data from a PDF

Gets the properties of a PDF document.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data
required
HttpUrl (string) or InlineDocument (string)

A PDF whose properties are to be fetched.

object (PropertiesRequested)

The properties to be retrieved from the supplied PDF document.

Responses
200

Operation successful. The requested properties of the supplied PDF document are included in the response.

202

The request is accepted and the result can be checked at the location specified in the header.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/extract/pdfproperties
Request samples
Response samples
application/json
{
  • "properties": {
    }
}

Retrieves the usage rights enabled in a PDF document.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data
required
HttpUrl (string) or InlineDocument (string)

A PDF document to be checked for Adobe Acrobat Reader extensibility and if eligible, whose enabled usage rights are to be fetched.

OpenPassword (string) or PermissionsPassword (string) (UnlockPassword)

The password required for opening an encrypted PDF document. Typically, this is the document open password but if the PDF document is additionally protected by a permissions password, either may be used to open it.

Responses
200

Operation successful. The usage rights enabled in the supplied PDF document are included in the response.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/extract/usagerights
Request samples
Response samples
application/json
{
  • "message": "This PDF has usage rights enabled.",
  • "invalidAfter": "2024-06-30T00:00:00.000Z",
  • "invalidBefore": "2023-11-01T00:00:00.000Z",
  • "usageRights": {
    }
}

Returns the metadata located within a PDF document.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data

A multipart request representing a metadata export operation.

required
HttpUrl (string) or InlineDocument (string)

A PDF document whose metadata is to be extracted.

type
string (MetadataType)

The type of metadata.

Enum: "PDF" "XMP"
Responses
200

Operation successful. The requested metadata of the supplied PDF document is included in the response.

202

The request is accepted and the result can be checked at the location specified in the header.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/extract/metadata
Request samples
Response samples
{
  • "author": "string",
  • "title": "string",
  • "subject": "string",
  • "keywords": [
    ],
  • "creator": "string",
  • "producer": "string"
}

Exports the data from a PDF form or XDP template or XFA form.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data
required

A multipart request representing a data export operation.

required
HttpUrl (string) or InlineDocument (string)

A PDF form or XDP template or XFA form from which to extract data.

format
string (DataFormat)
Default: "AUTO"

The format of data exported from a PDF form or XDP template or XFA form.

AUTO Export data in an automatically inferred format (one of the below).
XDP Export data in XDP format.
XML Export data in XML format.

Enum: "AUTO" "XDP" "XML"
Responses
200

Operation successful.
The data exported from the supplied PDF form or XDP template is included in the response.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/extract/data
Request samples
Response samples
application/problem+json
{}

Document Transformation

Manipulate, augment or modify a PDF or data

Replace the metadata located within a PDF document.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data

A multipart request representing a metadata import operation.

required
HttpUrl (string) or InlineDocument (string)

A PDF document whose metadata is to be replaced.

type
required
string (MetadataType)

The type of metadata.

Enum: "PDF" "XMP"
required
PdfMetadata (object) or XmpMetadata (object)

New metadata intended to replace any existing metadata in the supplied PDF document.

XMP metadata is replaced in entirety. If the new metadata is empty, the Metadata key is removed from the PDF document's catalog.

PDF metadata is replaced on a per-key basis. Keys missing from the new metadata are removed from the PDF document's trailer.

Responses
200

Operation successful. The updated PDF document containing the supplied metadata is included in the response.

202

The request is accepted and the result can be checked at the location specified in the header.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/transform/metadata
Request samples
Response samples
application/problem+json
{}

Document Assurance

Digital signature, usage rights and encryption-related operations with PDF documents.

Apply Usage Rights to the supplied PDF document.

Existing usage rights on the document are replaced with the provided usage rights. If no usage rights are provided, this effectively removes any existing usage rights from the document.

SecurityBearerAuth
Request
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data
required

A multipart request representing usage rights application operation.

required
HttpUrl (string) or InlineDocument (string)

A PDF document to be extended for Adobe Acrobat Reader by applying usage rights. Use content-type as "text/plain" to specify a URL.

required
object (UsageRights)

The set of usage rights representing capabilities applicable to a PDF document within Adobe Acrobat Reader.

object (ApplyRightsOptions)

Specifies options to control the usage rights application operation.

Responses
200

Operation successful. The reader extended PDF document is included in the response.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/assure/usagerights
Request samples
Response samples
application/problem+json
{}

Document Generation

Produce a PDF from a source template, optionally with data merging

Generates a fillable PDF form from an XDP or PDF template, optionally with data merging.

SecurityBearerAuth
Request
header Parameters
Prefer
string

This header may be used by a client to indicate its request processing preferences to the service. Stating the respond-async preference allows the service to prefer asynchronous processing. Stating the wait preference allows the service to decide whether to respond synchronously if the request can be processed within a specified period (seconds). A service may choose to ignore these preferences altogether and decide how to respond at its discretion.

Example: Prefer: respond-async, wait=10
X-Adobe-Accept-Experimental
required
integer
Value: 1
Request Body schema: multipart/form-data
required

A multipart request representing a PDF form generation operation.

required
HttpUrl (string) or InlineDocument (string) or (RepoDocument (RepoPath (string) or RepoUrl (string)))

The template defines the appearance and behavior of the resultant PDF form.
Either an XDP or an existing PDF form can be used as a template to generate
the PDF form.

HttpUrl (string) or InlineDocument (string)

An optional XML file containing the data to be merged with the template to generate a pre-filled PDF form.

object (PdfFormOptions)

Options to govern PDF form generation and behavior.

Responses
200

Operation successful.
The generated PDF form is included in the response.

202

The request is accepted and the location specified in the header
may be polled for information about the result.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/generate/pdfform
Request samples
Response samples
application/json
{}

Check the processing status of an asynchronous request to generate a PDF form.

SecurityBearerAuth
Request
path Parameters
id
required
string <uuid>

The job ID provided by the server when the PDF form generation request was accepted for asynchronous processing.

header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Responses
200

Information about the processing state of an asynchronous request.

303

See Other. Indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

404

Not Found

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

503

The service is temporarily unavailable. Please try again later.

get/generate/pdfform/jobs/{id}/status
Request samples
Response samples
application/json
{}

Retrieve the result of a completed asynchronous request to generate a PDF form.

SecurityBearerAuth
Request
path Parameters
id
required
string <uuid>

The result ID provided by the server when the asynchronous PDF form generation request finished processing.

header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
Responses
200

Operation successful.
The generated PDF form is included in the response.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

404

Not Found

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

get/generate/pdfform/jobs/{id}/result
Request samples
Response samples
application/problem+json
{}