Generate a tenant-branded document

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/documents/generate

Generates a branded document (e.g. an Account Confirmation Letter) for a customer/wallet of the tenant. The requested document type must be enabled and have an active template and branding configured for the tenant. The document is returned as a flattened, non-editable, Base64 encoded PDF.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Body Params

A request to generate a tenant-branded document (e.g. an Account Confirmation Letter) for a customer/wallet. The generation is template and configuration driven so new document types can be added purely via configuration, with no API or code change.

additionalData

array of objects

Optional loosely-typed data required only by certain document types, e.g. transactionId for PROOF_OF_PAYMENT or dateFrom/dateTo for STATEMENT.

additionalData

customerId

int64

required

The customer the document is generated for. Must exist under the tenant and be active.

documentType

string

required

\S

The type of document to generate, e.g. ACCOUNT_CONFIRMATION_LETTER. Must appear in the tenant's generate.document.supported.types configuration and have an active reporting query and Handlebars template configured; any name can be enabled this way, with no fixed list of values.

requestedBy

string

Identifier of the channel/user requesting generation. Recorded on the audit trail.

walletId

int64

required

The wallet the document is generated for. Must exist under the tenant, be active and belong to the customer.

Responses

200OK

400Validation failed

500Internal Server Error