Sign PDF

The file parameter allows you to select a local PDF file to be uploaded to pdfRest's processing server for signing.

The id parameter allows you to submit a resource ID for a PDF file already on the processing server. Each of our API Tools assigns a unique resource ID to all uploaded input files and generated output files and returns these IDs in the response to each API Call. This allows you to store the IDs from one call and submit them to the next, chaining requests together without having to download intermediate files between requests.

For example, you can convert a Word document to PDF using our Convert to PDF tool, then pass the output ID you receive to the Sign PDF API to apply a digital signature.

A JSON-formatted string that defines the properties and visual appearance of the signature to be applied. This is a required parameter.

Example Schema

{
        "type": "new",
        "name": "esignature",
        "logo_opacity": 0.8,
        "location": {
            "bottom_left": { "x": 0, "y": 0 },
            "top_right": { "x": 216, "y": 72 },
            "page": 1
        },
        "display": {
            "include_distinguished_name": false,
            "include_datetime": false,
            "contact": "Name of Contact",
            "location": "Name of Location",
            "name": "Name",
            "reason": "Because!"
        }
}

Internal Parameters

• type (string, required)
  • Description: Specifies whether to apply the signature to a new field or an existing one.
  • Allowed Values: "new" or "existing".
  • Example: "type": "new"
• name (string, required)
  • Description: The name of the signature field. If type is "new", this will be the name of the new field created. If type is "existing", this must precisely match the name of a pre-existing signature field in the PDF.
  • Example: "name": "signatureField1"
• logo_opacity (float, optional)
  • Description: Sets the opacity of any background image (like a logo or scanned signature) applied to the signature field.
  • Range: 0.0 (fully transparent) to 1.0 (fully opaque).
  • Example: "logo_opacity": 0.75
• location (dictionary, optional)
  • Description: Defines the position and size for a new signature box. This parameter is only considered when type is "new".
  • bottom_left (dictionary): The coordinates for the bottom-left corner of the new signature box.
    • x (float): Horizontal position in PDF units.
    • y (float): Vertical position in PDF units.
    • Example: "bottom_left": { "x": 50, "y": 100 }
  • top_right (dictionary): The coordinates for the top-right corner of the new signature box.
    • x (float): Horizontal position in PDF units.
    • y (float): Vertical position in PDF units.
    • Example: "top_right": { "x": 250, "y": 200 }
  • page (int): The page number on which to insert the new signature box. Page numbers start from 1.
    • Example: "page": 1
• display (dictionary, optional)
  • Description: Contains various options for the visual information displayed on the signature's appearance.
  • include_distinguished_name (boolean): If true, the distinguished name (DN) from the digital credential or certificate file will be automatically displayed on the signature.
    • Example: "include_distinguished_name": true
  • include_datetime (boolean): If true, the date and time when the signature was applied will be automatically displayed on the signature.
    • Example: "include_datetime": true
  • contact (string): Custom contact information to display on the signature. Set to an empty string ("") to omit this field.
    • Example: "contact": "support@example.com"
  • location (string): Custom location information (e.g., "Chicago, IL") to display on the signature. Set to an empty string ("") to omit.
    • Example: "location": "Corporate HQ"
  • name (string): A custom name to display on the signature. This can be used for typed names or custom labels. Set to an empty string ("") to omit.
    • Example: "name": "A. Signature"
  • reason (string): A custom reason for signing (e.g., "I approve this document") to display on the signature. Set to an empty string ("") to omit.
    • Example: "reason": "Document Approved"

The .pfx or .p12 formatted file containing your digital certificate and private key. This file is provided directly in the request.

The resource ID of a previously uploaded .pfx or .p12 formatted credential file. Use this if the credential file is already in pdfRest's storage.

A .txt file containing the passphrase (password) required to unlock your PFX credential file. This file is provided directly in the request.

The resource ID of a previously uploaded .txt file containing the passphrase for your PFX credential. Use this if the passphrase file is already in pdfRest's storage.

The .pem or .der formatted certificate file (containing the public key certificate). This file is provided directly in the request.

The resource ID of a previously uploaded .pem or .der formatted certificate file. Use this if the certificate file is already in pdfRest's storage.

The .pem or .der formatted private key file associated with the provided certificate. This file is provided directly in the request.

The resource ID of a previously uploaded .pem or .der formatted private key file. Use this if the private key file is already in pdfRest's storage.

logo_file is a parameter to upload an image file (PNG, JPG) to be displayed on the signature as a logo, hand-written signature, or other associated image.

logo_id is a parameter with a resource ID of an image file (PNG, JPG) to be displayed on the signature as a logo.