e-Stamp — Order Status
esignFetch the current status of an order created with estamp-create-v1, and the stamped certificate once it is issued. WHERE THE CERTIFICATE IS. When `data.status` is FULFILLED (or CONSUMED), the certificate PDF link is `data.stampCertificateUrl` and its id is `data.eStampId`. Each stamp is also listed in `data.orderItems[]` with its own `certificateNo`, `eStampId` and `stampCertificateUrl`. There is no separate documents array. The top-level `status` is only a message; the order status is `data.status`. THE LINK EXPIRES. `stampCertificateUrl` is a time-limited link: download the PDF and store it in your own system as soon as the order is FULFILLED. To get a fresh link later, call this API again. TEST MODE returns a FULFILLED order whose link opens a sample certificate marked SAMPLE - NOT VALID, so you can build and test the download step. Stamping is not instant: poll every few seconds (not in a tight loop) while `data.status` is IN_PROGRESS. Priced at a nominal rate so polling is cheap.
POST /gw/v1/estamp-status-v1/SLA p95: 3000 ms
Authentication
Pass your key in the X-API-Key header. Use a test_ key against the sandbox and a live_ key in production. Send an optional Idempotency-Key header to safely retry — the same key returns the same response for 24h.
X-API-Key: live_xxxxxxxxxxxx
Request
Endpoint: POST https://apisathi.in/gw/v1/estamp-status-v1/
The trailing slash is required. /v1/estamp-status-v1/ works; /v1/estamp-status-v1 returns 404 Not Found. This applies to every product.
| Field | Type | Required | Constraints |
|---|---|---|---|
| order_id | string | required | The order_id returned by estamp-create-v1. |
Code snippets
curl -X POST https://apisathi.in/gw/v1/estamp-status-v1/ \
-H "X-API-Key: $API_SATHI_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"order_id":"SPRAV000001"}'Response
| Field | Type | Required | Constraints |
|---|---|---|---|
| status | string | optional | A human-readable message. The ORDER status is data.status. |
| data | object | optional | The order. |
Sample response
{
"status": "E-stamp order details fetched successfully.",
"data": {
"orderId": "SPRAV000001",
"type": "SINGLE",
"refId": "LOAN-2026-000123",
"status": "FULFILLED",
"createdAt": "2026-10-20T10:00:00.000Z",
"updatedAt": "2026-10-20T10:02:00.000Z",
"eStampId": "sample-estamp-0001",
"stampCertificateUrl": "https://apisathi.in/samples/estamp-certificate-sample.pdf",
"orderItems": [
{
"id": "sample-item-0001",
"quantity": 1,
"status": "FULFILLED",
"amount": "100",
"createdAt": "2026-10-20T10:00:00.000Z",
"updatedAt": "2026-10-20T10:02:00.000Z",
"stateCode": "RJ",
"stampDutyAmount": 100,
"stampType": "ESTAMP",
"taxCharges": 30,
"considerationPrice": 0,
"purpose": "Loan agreement",
"articleId": 12,
"firstParty": "Sample Lender Pvt Ltd",
"secondParty": "Sample Borrower",
"stampDutyPaidBy": "FIRST_PARTY",
"articleNumber": "5(h)",
"certificateNo": "IN-SAMPLE-000001",
"stampCertificateUrl": "https://apisathi.in/samples/estamp-certificate-sample.pdf",
"eStampId": "sample-estamp-0001",
"stampWithAttachment": null
}
]
}
}Reading a 400
A schema rejection returns INVALID_REQUEST with a details array naming the exact field. Read it before guessing — it gives you the JSON path and what was wrong with it.
{
"error": {
"code": "INVALID_REQUEST",
"message": "Request body failed schema validation",
"details": [
{ "path": "/callback_url",
"message": "unexpected property 'callback_url' — this endpoint does not accept unknown fields" }
]
}
}Most endpoints reject unknown top-level fields outright, so an extra key you added for your own bookkeeping will fail the call. Enum errors list the accepted values, and a missing required field is named with its full path.
Error codes
| Code | HTTP | When |
|---|---|---|
| INVALID_INPUT | 422 | The request was rejected as invalid — either it failed OUR schema validation (malformed input; not charged), or the upstream source rejected the value you sent. NOTE: an identifier that is well-formed but simply has NO RECORD is no longer an error — it returns 200 with `verified: false` and is charged (see the result-code table below). FIX the input before retrying; retrying the same value will fail again. |
| INVALID_API_KEY | 401 | Missing, malformed, or revoked X-API-Key. |
| OUT_OF_SCOPE | 403 | API key is not scoped for this product. |
| INSUFFICIENT_BALANCE | 402 | Wallet balance is below the per-call sale price. Recharge and retry. |
| RATE_LIMITED | 429 | Per-key RPS or RPM limit exceeded. Back off and retry after the Retry-After header. |
| PRODUCT_DEPRECATED | 410 | This API has been retired and is no longer available. Stop calling it — it will not return. Check the catalog for the current equivalent. |
| ROUTER_NO_VENDOR | 503 | No healthy vendor is currently available for this product. Transient — safe to retry after a short backoff. Not charged. |
| VENDOR_AUTH_FAILED | 502 | Upstream vendor rejected our credentials (our config issue). Not charged. |
| VENDOR_ERROR | 502 | A genuine transient upstream error (the source was briefly unavailable). Safe to RETRY after a short backoff. Not charged. NOTE: this is NOT for bad input — invalid values return 422 INVALID_INPUT, not 502. |
| TIMEOUT | 504 | Upstream vendor did not respond within the SLA window. Safe to retry after a short backoff. Not charged. |
OpenAPI 3.1
Generated from this product's request/response JSON Schemas.
{
"openapi": "3.1.0",
"info": {
"title": "API Sathi — e-Stamp — Order Status",
"version": "1.0.0",
"description": "Fetch the current status of an order created with estamp-create-v1, and the stamped certificate once it is issued.\n\nWHERE THE CERTIFICATE IS. When `data.status` is FULFILLED (or CONSUMED), the certificate PDF link is `data.stampCertificateUrl` and its id is `data.eStampId`. Each stamp is also listed in `data.orderItems[]` with its own `certificateNo`, `eStampId` and `stampCertificateUrl`. There is no separate documents array. The top-level `status` is only a message; the order status is `data.status`.\n\nTHE LINK EXPIRES. `stampCertificateUrl` is a time-limited link: download the PDF and store it in your own system as soon as the order is FULFILLED. To get a fresh link later, call this API again.\n\nTEST MODE returns a FULFILLED order whose link opens a sample certificate marked SAMPLE - NOT VALID, so you can build and test the download step.\n\nStamping is not instant: poll every few seconds (not in a tight loop) while `data.status` is IN_PROGRESS. Priced at a nominal rate so polling is cheap."
},
"servers": [
{
"url": "https://apisathi.in/gw/v1"
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Your live or test key, e.g. `live_xxxxxxxxxxxx`."
}
}
},
"paths": {
"/estamp-status-v1": {
"post": {
"operationId": "estampStatusV1",
"tags": [
"esign"
],
"summary": "e-Stamp — Order Status",
"description": "Fetch the current status of an order created with estamp-create-v1, and the stamped certificate once it is issued.\n\nWHERE THE CERTIFICATE IS. When `data.status` is FULFILLED (or CONSUMED), the certificate PDF link is `data.stampCertificateUrl` and its id is `data.eStampId`. Each stamp is also listed in `data.orderItems[]` with its own `certificateNo`, `eStampId` and `stampCertificateUrl`. There is no separate documents array. The top-level `status` is only a message; the order status is `data.status`.\n\nTHE LINK EXPIRES. `stampCertificateUrl` is a time-limited link: download the PDF and store it in your own system as soon as the order is FULFILLED. To get a fresh link later, call this API again.\n\nTEST MODE returns a FULFILLED order whose link opens a sample certificate marked SAMPLE - NOT VALID, so you can build and test the download step.\n\nStamping is not instant: poll every few seconds (not in a tight loop) while `data.status` is IN_PROGRESS. Priced at a nominal rate so polling is cheap.",
"security": [
{
"ApiKeyAuth": []
}
],
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Optional. Same key returns the same response for 24h."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "string",
"description": "The order_id returned by estamp-create-v1."
}
},
"additionalProperties": false
},
"example": {
"order_id": "SPRAV000001"
}
}
}
},
"responses": {
"200": {
"description": "Successful, normalized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "A human-readable message. The ORDER status is data.status."
},
"data": {
"type": "object",
"description": "The order.",
"properties": {
"orderId": {
"type": "string"
},
"refId": {
"type": "string",
"description": "Your reference from estamp-create-v1."
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"description": "IN_PROGRESS, then FULFILLED (stamp issued; certificate ready) or CONSUMED (stamp used against a document). Treat both FULFILLED and CONSUMED as done."
},
"eStampId": {
"type": "string",
"description": "Present once issued."
},
"stampCertificateUrl": {
"type": "string",
"description": "Link to the stamped certificate PDF, present once FULFILLED. Time-limited: download and store the PDF straight away; call this API again for a fresh link."
},
"orderItems": {
"type": "array",
"description": "One per stamp, each with its own certificateNo, eStampId and stampCertificateUrl (null until issued), plus stateCode, stampDutyAmount, stampType, purpose, firstParty, secondParty, stampDutyPaidBy."
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}
}
},
"example": {
"status": "E-stamp order details fetched successfully.",
"data": {
"orderId": "SPRAV000001",
"type": "SINGLE",
"refId": "LOAN-2026-000123",
"status": "FULFILLED",
"createdAt": "2026-10-20T10:00:00.000Z",
"updatedAt": "2026-10-20T10:02:00.000Z",
"eStampId": "sample-estamp-0001",
"stampCertificateUrl": "https://apisathi.in/samples/estamp-certificate-sample.pdf",
"orderItems": [
{
"id": "sample-item-0001",
"quantity": 1,
"status": "FULFILLED",
"amount": "100",
"createdAt": "2026-10-20T10:00:00.000Z",
"updatedAt": "2026-10-20T10:02:00.000Z",
"stateCode": "RJ",
"stampDutyAmount": 100,
"stampType": "ESTAMP",
"taxCharges": 30,
"considerationPrice": 0,
"purpose": "Loan agreement",
"articleId": 12,
"firstParty": "Sample Lender Pvt Ltd",
"secondParty": "Sample Borrower",
"stampDutyPaidBy": "FIRST_PARTY",
"articleNumber": "5(h)",
"certificateNo": "IN-SAMPLE-000001",
"stampCertificateUrl": "https://apisathi.in/samples/estamp-certificate-sample.pdf",
"eStampId": "sample-estamp-0001",
"stampWithAttachment": null
}
]
}
}
}
}
},
"401": {
"description": "Missing, malformed, or revoked X-API-Key.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"402": {
"description": "Wallet balance is below the per-call sale price. Recharge and retry.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"403": {
"description": "API key is not scoped for this product.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"410": {
"description": "This API has been retired and is no longer available. Stop calling it — it will not return. Check the catalog for the current equivalent.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "The request was rejected as invalid — either it failed OUR schema validation (malformed input; not charged), or the upstream source rejected the value you sent. NOTE: an identifier that is well-formed but simply has NO RECORD is no longer an error — it returns 200 with `verified: false` and is charged (see the result-code table below). FIX the input before retrying; retrying the same value will fail again.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Per-key RPS or RPM limit exceeded. Back off and retry after the Retry-After header.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"502": {
"description": "Upstream vendor rejected our credentials (our config issue). Not charged.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"503": {
"description": "No healthy vendor is currently available for this product. Transient — safe to retry after a short backoff. Not charged.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
},
"504": {
"description": "Upstream vendor did not respond within the SLA window. Safe to retry after a short backoff. Not charged.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"call_id": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}