Skip to navigation

Attach documents to an invoice PDF

Embeds one or more files as attachments into an invoice PDF (visible in the Acrobat Attachments pane). For PDF/A-3 carriers (ZUGFeRD/Factur-X) the result stays PDF/A-3 conformant; the relationship defaults to Supplement.

Authentication

AuthorizationBearer

API Key authentication. Use sk_live_* for production or sk_test_* for testing.

Request

Request body for embedding attachments into a PDF
pdfstringRequired>=1 character

Base64-encoded carrier PDF to embed the attachments into

attachmentslist of objectsRequired
Files to embed into the PDF

Response

PDF with embedded attachments
successtrue
datastring

Base64-encoded result PDF with the attachments embedded

pdfA3Conformantboolean

True if the carrier was PDF/A-3 and conformance was preserved

attachmentCountdouble
Number of attachments embedded

Errors

400
Bad Request Error
403
Forbidden Error
413
Content Too Large Error
429
Too Many Requests Error