Combine PDFs

Combine multiple PDFs from different sources into a single merged document.

Endpoint

POST /api/v1/combined_submissions

Source Types

You can combine PDFs from various sources:

Submissions

Generated PDFs from template submissions:

{ "type": "submission", "id": "sub_1234567890abcdef01" }

Combined Submissions

Previously combined PDFs:

{ "type": "combined_submission", "id": "com_1234567890abcdef01" }

Templates

Original template PDFs (unfilled):

{ "type": "template", "id": "tpl_1234567890abcdef01" }
{ "type": "template", "id": "tpl_1234567890abcdef01", "template_version": "1.2.3" }

Custom Files

Uploaded PDF files:

{ "type": "custom_file", "id": "cfi_1234567890abcdef01" }

URLs

PDFs from external URLs:

{ "type": "url", "url": "https://example.com/document.pdf" }

Example Request

{
  "source_pdfs": [
    { "type": "submission", "id": "sub_1234567890abcdef01" },
    { "type": "template", "id": "tpl_1234567890abcdef01" },
    { "type": "url", "url": "https://example.com/terms.pdf" }
  ],
  "metadata": {
    "document_type": "complete_package",
    "pdf_filename": "complete_contract_package"
  }
}

Key Features

Template Versions

For template sources, specify versions:

• "template_version": "draft" - Use draft version
• "template_version": "latest" - Use latest published version (default)
• "template_version": "1.2.3" - Use specific version

Custom Filename

Set a custom PDF filename via metadata:

{
  "metadata": {
    "pdf_filename": "merged_documents_2024"
  }
}

The download URL becomes: /combined_submissions/{id}/merged_documents_2024.pdf

Filename rules:

• Max 128 characters
• Allowed: 0-9 A-Z a-z - _ .
• Other characters replaced with _

Free to Use

Combining PDFs is free, but source submission PDFs count toward your monthly usage.

Use Cases

Multi-Page Forms

Combine multiple template submissions for complex forms:

{
  "source_pdfs": [
    { "type": "submission", "id": "sub_application_form" },
    { "type": "submission", "id": "sub_supporting_docs" },
    { "type": "template", "id": "tpl_terms_and_conditions" }
  ]
}

Document Packages

Create complete document packages with cover pages, forms, and attachments:

{
  "source_pdfs": [
    { "type": "template", "id": "tpl_cover_page" },
    { "type": "submission", "id": "sub_main_form" },
    { "type": "url", "url": "https://company.com/legal/terms.pdf" }
  ]
}

Addendum Pages

Handle form fields with truncated text by generating additional pages:

{
  "source_pdfs": [
    { "type": "submission", "id": "sub_main_form" },
    { "type": "submission", "id": "sub_addendum_page" }
  ]
}

API Reference: Combine PDFs View all parameters, example requests/responses, and code samples

Related Resources

Generate PDFs Create PDFs from templates before combining them

Custom Files Upload and manage custom PDF files for combining