E Stamping: Get Status
Introduction
This API is used to get the status of an estamping transaction by providing the transaction ID.
Sample cURL
curl --request POST \
--url http://signzy.tech/api/v2/patrons/..your-patron-id../estamping \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"task":"getStatus","essentials":{"transactionId":"...transactionId..."}}'Parameter Name | Data Type | Required | Description |
|---|---|---|---|
task | string | Yes | The task to be performed. Set this to "getStatus". |
essentials | object | Yes | An object containing the transaction ID. |
Parameter Name | Data Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | The ID of the estamping transaction to get the status of. |
Sample Response
{
"result": {
"transactionId": "...transactionId...",
"estampStatus": "...estampStatus...",
"transactionResult": {
"certificateNumber": "...certificateNumber...",
"certificateReferenceNumber": "...certificateReferenceNumber...",
"eStampedFile": "...eStampedFile..."
}
}
}
Field | Data Type | Description |
|---|---|---|
result.transactionId | string | Unique ID of the transaction |
result.estampStatus | string | Status of the e-stamp process |
result.transactionResult | object | Details of the transaction result |
result.transactionResult.certificateNumber | string | Certificate number of the stamped document |
result.transactionResult.certificateReferenceNumber | string | Reference number of the stamped document |
result.transactionResult.eStampedFile | string | URL of the e-stamped document |