Embed CII XML into a PDF
embed_xmlRead-onlyIdempotent
Combine a visual PDF you already have with CII XML into one Factur-X PDF/A-3.
Use for an existing visual invoice; use generate_invoice to render invoice data or produce UBL.
Match the PDF's parties, lines and totals to xml yourself: check examines only XML and cannot detect
disagreement with the visible PDF. The embedded profile comes from xml; neither check nor language
changes it. language does not translate the PDF.
Invalid input or failed rules return a tool error with no file; rule errors include ids. For a
findings report use validate_invoice. Success returns a JSON summary (profile, size_bytes, warning
count) and a base64 PDF/A-3 resource. Requires a trial, prepaid or subscription allowance via OAuth or key; success consumes one document, errors
consume none. Nothing is stored or sent.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| xml | Yes | Unencoded CII XML text (Factur-X / EN 16931); UBL is not supported. | |
| check | No | XML validation rules: fr-ctc adds French BR-FR-* to EN 16931; base uses EN 16931 only. | fr-ctc |
| language | No | Language written in the PDF metadata: fr (default) or en. | fr |
| pdf_base64 | Yes | Standard base64 of PDF bytes starting with %PDF-. Not a URL or data-URI. |