Query a Confirmation Letter

Query the status and result of a confirmation letter download task. When the task is complete (SUCCESS), the response includes a pre-signed download URL and its expiry time.
Request Parameters
idstring
required
Unique identifier of the download task, returned by Create a Confirmation Letter. Maximum 64 characters.
Response Parameters
resultResult
See Result.
idstring
Echo of the download task identifier.
statusstring
Task status.

Valid Values:

PROCESSING — The task is being processed.
SUCCESS — The task completed successfully. A downloadUrl is available.
FAILED — The task failed. See failureCode and failureMessage for details.
downloadUrlstring
Pre-signed URL to download the generated PDF. Returned only when status is SUCCESS. Maximum 2,048 characters.
downloadUrlExpiresAtdatetime
Expiry time of the download URL. Returned only when status is SUCCESS. ISO 8601 extended format.
failureCodestring
Business failure reason code. Returned only when status is FAILED.
failureMessagestring
A plain-text description of the failure reason. Returned only when status is FAILED.
createdAtdatetime
Timestamp when the task was created. ISO 8601 extended format (e.g., 2026-04-27T12:08:56+08:00).
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
ORDER_NOT_EXISTFThe specified order does not exist.Verify the ID value. Use the corresponding List endpoint to find valid IDs.
Definition
POST /api/open/v1/confirmationLetters/query
Request
{
"id": "f18d0117-095a-4782-a9f1-eeb16c3b****"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"id": "f18d0117-095a-4782-a9f1-eeb16c3b****",
"status": "SUCCESS",
"downloadUrl": "https://example.com/files/****1234.pdf",
"downloadUrlExpiresAt": "2026-04-28T12:08:56+08:00",
"createdAt": "2026-04-27T12:08:56+08:00"
}