Usage Guide

Generate PDF

$client->generatePdf([
    'html' => '<h1>Hello</h1>',
    'pageSizeType' => 'a4',
    'printBackground' => true,
    'metadata' => ['source' => 'sdk'],
]);

Upload File

If both file and url are passed, uploadFile() prioritizes file and sends multipart form data.

$client->uploadFile([
    'file' => new \CURLFile('/absolute/path/source.pdf', 'application/pdf', 'source.pdf'),
    'preSignedUrlExpiresIn' => 1200,
]);

$client->uploadFile([
    'url' => 'https://example.com/source.pdf',
    'preSignedUrlExpiresIn' => 1200,
]);

Create Envelope

createEnvelope() sends JSON with nested envelope documents and recipients. Optional fields like metadata and recipient role are omitted automatically when set to null.

$envelope = $client->createEnvelope([
    'requesterName' => 'John Doe',
    'documents' => [
        [
            'sourceDocumentId' => '6642381c5c61',
            'name' => 'Employment Agreement',
            'recipients' => [
                [
                    'email' => 'anna@example.com',
                    'name' => 'Anna Smith',
                ],
            ],
        ],
    ],
    'metadata' => ['customerId' => 'cus_123'],
]);

Send Envelope

sendEnvelope() emails each recipient a secure signing link. Links expire after 30 days and recipients must complete OTP verification before entering the signing flow.

$sentEnvelope = $client->sendEnvelope('69c0fa44f83ca6a7015f1c8c');

Get Envelope

getEnvelope() retrieves the current envelope state so you can inspect overall status, document progress, and recipient status details.

$envelope = $client->getEnvelope('69c0fa44f83ca6a7015f1c8c');

Flatten PDF

$client->flattenPdf([
    'documentId' => $id,
    'preSignedUrlExpiresIn' => 1200,
]);

Compress PDF

$client->compressPdf([
    'documentId' => $id,
    'linearize' => true,
]);

Protect PDF

$client->protectPdf([
    'documentId' => $id,
    'algorithm' => 'AES256',
    'ownerPassword' => 'ownerPassword',
    'userPassword' => 'userPassword',
    'disablePrint' => true,
    'disableCopy' => true,
]);

Watermark PDF

watermarkPdf() always sends multipart form data and forces jsonResponse=true.

$client->watermarkPdf([
    'documentId' => $id,
    'type' => 'text',
    'text' => 'Confidential',
    'fontColor' => 'rgb(156, 50, 168)',
    'rotate' => 30,
    'opacity' => 0.2,
]);

$client->watermarkPdf([
    'documentId' => $id,
    'type' => 'image',
    'watermark' => new \CURLFile('/absolute/path/watermark.png'),
    'imageWidth' => 120,
    'imageHeight' => 120,
]);

Extract PDF Form Data

$formData = $client->extractPdfFormData([
    'documentId' => $id,
]);

Get Document Metadata

$document = $client->getDocument($id, [
    'preSignedUrlExpiresIn' => 1200,
]);

Get File Stream

$stream = $client->getFile($id);
$output = fopen('output.pdf', 'wb');
stream_copy_to_stream($stream, $output);
fclose($output);
fclose($stream);

To download generated files, enable Save files for one month in PDFGate Dashboard settings.