Skip to navigation

Get Generated PDF Document

View as Markdown

Retrieves the status and result of a document generation request. The response includes the request status (success or failed), the generated document’s ID and name, the queue and user involved, and error details if generation or scanning failed. Poll this endpoint after creating a document to confirm it has been generated.

Singapore e-invoice status

This is also the status-polling endpoint for Singapore e-invoices. Poll it with the requestId returned by POST /v2/einvoice/ar/{qid}. For e-invoice requests the response additionally carries:

  • peppolSendStatus — Peppol delivery state: PENDING, SENT_SUCCESSFULLY, FAILED_TO_SEND, INVALID_XML_FORMAT, CONSUMER_NOT_FOUND (or null for IRAS-only flows that never send over Peppol).
  • irasTaxSubmissionStatus — IRAS tax reporting state: NOT_SUBMITTED, SUBMITTED / SUCCESSFUL_IRAS_SUBMISSION, FAILED_TO_SUBMIT / REJECTED_IRAS_SUBMISSION, INVALID_XML_FORMAT, NETWORK_TRANSMISSION_ERROR (or null when the flow does not report tax).

Both channels are asynchronous — keep polling until they reach a terminal state.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Path parameters

requestIdstringRequired

Response

OK