The Session PDF Export API returns a temporary download URL for the PDF report of a completed verification session. The API returns JSON; it does not return the PDF file directly.

Request Example:

curl -X GET \
  'https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf?signatureId=ac66706068e737b5' \
  -H 'X-ACCESS-TOKEN: {Your Access Token}'

Request Url

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf
GET

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf
GET

https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf
GET

https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf
GET

https://my-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf
GET

https://vn-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/export-pdf
GET

Request Header Parameters

Parameter	Required	Description
X-ACCESS-TOKEN	Yes	`string` Please use Token Authentication API to get your access token.

Request Parameters

Parameter	Location	Required	Description
signatureId	Query	Yes	`string` Signature ID of the session whose PDF report you want to export. The session must be in a terminal status.

Response Description

Parameter	Presence	Description
code	Always	Business status code.
transactionId	Always	Request ID. The maximum length is 64 characters.
pricingStrategy	Always	`Deprecated`. Always returns `FREE`.
message	Always	Explanation of the business status code.
data	Always	`string` when `code` is `SUCCESS`; otherwise `null`. The value is a temporary PDF download URL that expires in 1 day. Call this API again to obtain a new URL after it expires.
extra	Always	Additional response information. Usually `null`.

Response Code

Status Code	Message	Description
SUCCESS	OK	The PDF download URL was returned successfully.
PARAMETER_ERROR	Parameter error, please check your request whether has illegal parameters	The request parameter is invalid, or the session is not in a terminal status.
DATA_NOT_FOUND	Data not found	No session data was found for the specified `signatureId`.
RETRY_LATER	Query failed, please retry later	The PDF could not be generated temporarily. Retry the request later.
ERROR	Server error	An unexpected server error occurred.
IAM_FAILED	Access denied due to identity or access management certification failed	Authentication or authorization failed.

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": "https://example.com/session-report.pdf?Expires=1787212800&Signature=example",
  "extra": null,
  "transactionId": "ac66706068e737b5",
  "pricingStrategy": "FREE"
}

PARAMETER_ERROR

{
  "code": "PARAMETER_ERROR",
  "message": "Parameter error, please check your request whether has illegal parameters",
  "data": null,
  "extra": null,
  "transactionId": "ac66706068e737b5",
  "pricingStrategy": "FREE"
}

DATA_NOT_FOUND

{
  "code": "DATA_NOT_FOUND",
  "message": "Data not found",
  "data": null,
  "extra": null,
  "transactionId": "ac66706068e737b5",
  "pricingStrategy": "FREE"
}

RETRY_LATER

{
  "code": "RETRY_LATER",
  "message": "Query failed, please retry later",
  "data": null,
  "extra": null,
  "transactionId": "ac66706068e737b5",
  "pricingStrategy": "FREE"
}

ERROR

{
  "code": "ERROR",
  "message": "Server error",
  "data": null,
  "extra": null,
  "transactionId": "ac66706068e737b5",
  "pricingStrategy": "FREE"
}

IAM_FAILED

{
  "code": "IAM_FAILED",
  "message": "Access denied due to identity or access management certification failed",
  "data": null,
  "extra": null,
  "transactionId": "a2190c8682344303",
  "pricingStrategy": "FREE"
}