Payload Jobs (PDF + Word)

This page documents the payload-based job creation endpoints and the required channelIdentifiers per task and add-on.

These endpoints allow clients to submit jobs by providing structured payload data and, depending on the workflow input source, an optional document file.

For the full request and response schema, see:

• Create Payload PDF Job

• Create Payload Word Job

Use POST /jobs/payload-pdf when the workflow input source is PAYLOAD_PDF.

The endpoint stores the payload and returns a fileUploadUrl.

Upload the PDF using HTTP PUT to the returned fileUploadUrl, with the raw PDF binary as the request body.

The job remains in AWAITING_FILE_UPLOAD for up to 2 hours. If no file is uploaded during that period, the job expires.

The filename must end with .pdf. Other extensions return 415 Unsupported Media Type.

Use POST /jobs/payload-word when the workflow input source is PAYLOAD_WORD.

The endpoint stores the payload and creates the job immediately. No file upload step is required.

The payload must include templateData, which is used to generate the final document.

The workflow must:

• exist;
• be enabled;
• be validated;
• be accessible for the caller’s departments;
• use the input source matching the endpoint.

For POST /jobs/payload-pdf, the filename must end with .pdf.

Other file extensions return:

415 Unsupported Media Type

If the workflow contains a print task, either EASY_PRINT or EASY_PRINT_FR, payload workflows must provide structured address identifiers.

Unstructured address identifiers are not allowed for payload workflows.

The following identifier is not allowed for payload workflows:

Missing required structured address identifiers returns:

400 Bad Request

For structured address identifiers:

• empty structured address identifiers are ignored;
• structured fields have maximum length limits;
• ADDRESS_COUNTRY_CODE is uppercased.

The rules below apply to the payload.channelIdentifiers array.

When multiple identifiers are listed with AND, all listed identifiers are required.

When a group is described as “at least one of”, one valid option from the group is required.

Requires structured address identifiers.

See Structured address requirements.

Requires structured address identifiers.

See Structured address requirements.

Required identifier:

• EMAIL_ADDRESS

Required identifier:

• EMAIL_ADDRESS

Required identifiers:

• EMAIL_ADDRESS

And at least one of:

• COMPANY_IDENTIFICATION_NUMBER

• FIRST_NAME, LAST_NAME, and BIRTH_DATE

At least one of:

• NATIONAL_REGISTER_NUMBER

• COMPANY_IDENTIFICATION_NUMBER and EBOX_RECIPIENT_PARTITION

Required identifiers:

• DOCCLE_TOKEN_SET_VALUE1

• DOCCLE_TOKEN_SET_VALUE2

Optional identifiers for payload workflows:

• EMAIL_ADDRESS

• DOCCLE_RECEIVER_ID

PEPPOL is not supported for payload workflows.

Structured address requirements apply only to:

• EASY_PRINT
• EASY_PRINT_FR

The following identifiers are always required:

At least one of the following identity options is required:

At least one of the following location options is required:

When hasPom is true, the following identifiers are required:

Notes:

• INVOICE_DESCRIPTION is optional for payload-based workflows.
• INVOICE_DESCRIPTION is not validated as a required field.
• INVOICE_DUE_DATE is always required when payment collection is enabled.

When invoice tracking is enabled, the following identifiers are required:

All channelIdentifiers and extraInfoIdentifiers accept an optional isEncrypted flag.

The system encrypts values when:

• isEncrypted is set to true; or
• the identifier kind is NATIONAL_REGISTER_NUMBER.

NATIONAL_REGISTER_NUMBER is always encrypted, regardless of the value of isEncrypted.