Get Estamp Status

9 min

Introduction

Get Estamp Status API can be used by any customer to know the status of the estamp that they already requested for. This API takes in transactionId which you get as a response from Request Estamp API as an input and responds with the status of your request and the corresponding result.

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

Make sure you replace ..your-patron-id.. in the URL with the patronId that you receive from the login call and also make sure you pass in all the necessary input parameters in the correct format.

Sample Curl

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../estamping' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"task": "getStatus",
	"essentials": {
        "transactionId": "...transactionId..."
    }
}'

curl --location --request POST 'https://signzy.tech/api/v2/patrons/...patronID.../estamping' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"task": "getStatus",
	"essentials": {
        "transactionId": "...transactionId..."
    }
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
transactionId	Required	This is the id you got as a response from Request Estamp API.

Sample Response

{
      "result": {
        "transactionId": "...transactionId...",
        "estampStatus": "...estampStatus...",
        "transactionResult": {
            "certificateNumber": "...certificateNumber...",
            "certificateReferenceNumber": "...certificateReferenceNumber...",
            "eStampedFile": "...eStampedFile..."
        }
      }
  }

Response Parameter

PARAMETER NAME	DESCRIPTION
estampStatus	The possible values are : inProgress, Success, Fail inProgress indicate that the request is still in process. Success indicate that request is processed and the result is ready Fail indicates that there is some problem in processing the request possibly because of some errors.
certificateNumber	A certificate number is typically a unique identifier assigned to a specific estamp certificate or document, to help identify it among others.
certificateReferenceNumber	may be a unique identifier used to track or reference a particular estamp transaction or submission.
eStampedFile	URL of the final output file where the first page would be consisting of estamp and the further pages consists of the pdf url that you have passed as an input parameter.

Sample Error

{
    "error": {
        "statusCode": 400,
        "name": "error",
        "message": "Transaction Id is invalid",
        "status": 400
    }
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.statusCode	Request Status code from Signzy

Error Codes

CODE	DESCRIPTION	INTERPRETATION
400	Bad Request	Input Parameter has a missing required parameter or input is invalid
401	Authorization Failed	Authorization token is invalid.
500	Internal Server Error	Internal error at Signzy, please contact support.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].