Get Signing Result

This endpoint allows the relying party (RP) to actively query the signing results and obtain the signed document after completion.

It is not recommended to use this endpoint for status polling as the webhook is more efficient. RPs do not need to invoke this API if the success signing webhook was captured.

Path

GET /sign-requests/:request_id/signed_doc

Headers

Name
Value

Content-Type

application/json

Authorization

<token>

Authorization token

RP should sign the signature parameter into a JWT token as authorization token.

  • Token Type: Standard JWT (JSON Web Token)

  • Payload:

    • exchange_code: The exchange_code returned when initiate sign request.

    • jti: Standard JWT ID, a unique identifier for the JWT, must be a UUID.

    • iat & exp: Standard Issued At / Expiration timestamp of JWT. Must issued within 2 minutes.

Example:

eyJhbGciOiJFUzI1NiIsImtpZCI6IjEyMDUwMzM5LWUzNTktNGUyYy04YTc2LWY0Nzk0MDZmZDliMyJ9.eyJleGNoYW5nZV9jb2RlIjoiY2JlNzM3MWMtZjExMC00OTEzLWE3YmQtNjQwOTk0YjA4MDczIiwianRpIjoiY2IyYTk5NmQtZjk3ZS00YzJiLWE5ZDAtZDM0NzgxNzhjY2RmIiwiaWF0IjoxNzQ3Mzc3NzIyLCJleHAiOjE3NDczNzc4NDJ9.ZLQTMnSiqRfFE1w2jDjQgOVDKWY2Fv-HTSn976dZXmt2FVNMEzOfTdV8qCWnw8mOE5aJzIi2DQyIDZqwKAFJ4Q

Body

Empty

Response

{
    "signed_doc_url": "XXXX",
    "exp": 1744190335
}
  • signed_doc_url: Where you can download the signed document.

  • exp: Expiration time (in UNIX second) of signed_doc_url .

Sample request

curl 'https://staging.sign.singpass.gov.sg/api/v3/sign-requests/<request_id>/signed_doc' \
  -H 'Authorization: <auth_token>'

Last updated

Was this helpful?