GST Certificate OCR API
New
Read an uploaded GST registration certificate and get the printed details back as structured fields. A merchant, seller or vendor record then starts without anyone retyping the document.
Overview
GST Certificate OCR reads an image of a GST registration certificate and turns the printed details into structured data your application can use. Payment service providers, marketplaces and buyers all collect this document at onboarding, and someone normally retypes the values into a form. Your application submits a certificate image or scan collected from the business. The service reads it and returns what it can extract, as far as the document and the image allow. That can include the GSTIN, the legal name and the trade name. The constitution of the business, the principal place of business and the printed dates can come back as well. Available fields vary by data source and by record. Extraction is the capture step. Reading a GSTIN off a certificate reports what the document says, and confirming the registration is a separate check.
- Category
- Document OCR APIs
- Coverage
- GST registration certificates issued to businesses across India
- Input
- An image, scan or export of a GST registration certificate
- Output
- Structured registration and business fields, where the document and image allow
- Typical users
- Payment service providers, marketplaces, lenders, logistics and procurement teams
- Coverage note
- Certificates are re-issued on amendment; layout and available fields vary by record
The overview and the sections after the reference are the FinSour API catalog’s own record for this service, rendered unaltered.
Endpoint URL and method
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Authentication
Send your API key in this header on every call, from your own server: a key sent from a browser is refused. A key starting fs_test_ calls the sandbox and one starting fs_live_ calls production, at the same address. Create keys in the FinSour console.
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Request parameters
Headers
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
Idempotency-Key | string | Required | A key you generate for each attempt. Sending the same key again returns the first answer instead of running the check twice; the same key with a different body is refused. | 8 to 255 characters. Matches ^[A-Za-z0-9._:-]+$ |
FinSour-Version | string | Required | Send 2026-11-01 on this call and on every poll to get the receipt and the result described on this page. A call without it is served under 2026-09-01, whose job has a different shape. | — |
Body
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
file | file | Required | The document to read. | — |
payload | string (JSON) | Optional | A JSON string carrying the call's options. | — |
payload. | object | Optional | Settings for this call. | — |
payload. | string | Optional | Your own reference for this call. It comes back unchanged as meta.reference. | 1 to 128 characters |
payload. | object | Optional | The person's consent to this check. | — |
payload. | boolean | Required | Send true once the person has agreed to the check. | Always true |
payload. | string (date-time) | Required | When the person gave consent. | — |
payload. | string | Required | What the check is for, for example kyc. | 1 to 64 characters |
Request samples
cURL
curl -X POST https://gateway.staging.finsour.io/v1/documents/gst-certificate \
-H "X-Api-Key: $FINSOUR_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "FinSour-Version: 2026-11-01" \
-F "file=@<path-to-document>"Node.js
import { openAsBlob } from "node:fs";
const form = new FormData();
form.append("file", await openAsBlob("<path-to-document>"));
const response = await fetch("https://gateway.staging.finsour.io/v1/documents/gst-certificate", {
method: "POST",
headers: {
"X-Api-Key": process.env.FINSOUR_API_KEY,
"Idempotency-Key": crypto.randomUUID(),
"FinSour-Version": "2026-11-01",
},
body: form,
});
console.log(response.status, await response.json());Python
import os
import uuid
import requests
response = requests.post(
"https://gateway.staging.finsour.io/v1/documents/gst-certificate",
headers={
"X-Api-Key": os.environ["FINSOUR_API_KEY"],
"Idempotency-Key": str(uuid.uuid4()),
"FinSour-Version": "2026-11-01",
},
files={"file": open("<path-to-document>", "rb")},
timeout=30,
)
print(response.status_code, response.json())Generated from the fields above. Replace each value in angle brackets with your own; the key is read from FINSOUR_API_KEY.
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Response schema
| Name | Type | Present | Description | Constraints |
|---|---|---|---|---|
data | object | Always | The job that will read the document. | — |
data. | string | Always | The job's id. Poll GET /v1/jobs/{jobId} with it. | Matches ^[0-9A-HJKMNP-TV-Z]{26}$ |
data. | string | Always | Always queued: the job is accepted and has not started. | Always "queued" |
The result
Poll GET /v1/jobs/{jobId}. Once the job has finished, data holds these fields:
| Name | Type | Present | Description | Constraints |
|---|---|---|---|---|
jobId | string | Always | — | — |
status | string | Always | — | One of queued, processing, completed, needs_review, unreadable, failed, expired, cancelled |
documentType | string or null | Always | The kind of document found, once it has been read; null before that. | — |
confidence | number or null | Always | The document's confidence, 0 to 1, to two places; null until it has been read. | Minimum 0. Maximum 1 |
fields | object | Always | What was read. Every key is always present: null means the document does not carry it, or it could not be read with enough confidence. | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | ISO date, YYYY-MM-DD; a year or month alone is YYYY or YYYY-MM. | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fieldsToReview | array of strings | Always | When status is needs_review, the fields a person should confirm; empty otherwise. | — |
failureReason | string | Sometimes | Present only when status is unreadable or failed. | One of UNREADABLE_IMAGE, LOW_CONFIDENCE, DOCUMENT_TYPE_MISMATCH, UNSUPPORTED_MEDIA_TYPE, FILE_TOO_LARGE, INPUT_CORRUPT, PAGE_LIMIT_EXCEEDED, TIMEOUT, PROCESSING_ERROR |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Error codes
| Code | Status | Meaning | Retrying |
|---|---|---|---|
API_VERSION_UNSUPPORTED | 400 | That API version is no longer supported. | Do not retry automatically |
IDEMPOTENCY_KEY_INVALID | 400 | That Idempotency-Key does not meet the required format. | Do not retry automatically |
IDEMPOTENCY_KEY_REQUIRED | 400 | An Idempotency-Key header is required for this request. | Do not retry automatically |
REQUEST_MALFORMED | 400 | The request could not be parsed. | Do not retry automatically |
AUTH_KEY_EXPIRED | 401 | The API key is not valid. | Do not retry automatically |
AUTH_KEY_INVALID | 401 | The API key is not valid. | Do not retry automatically |
AUTH_KEY_MISSING | 401 | No API key was presented. | Do not retry automatically |
AUTH_KEY_REVOKED | 401 | The API key is not valid. | Do not retry automatically |
INSUFFICIENT_BALANCE | 402 | The available balance is not enough for this request. | Do not retry automatically |
AUTH_IP_NOT_ALLOWED | 403 | This API key may not be used from this address. | Do not retry automatically |
ENTITLEMENT_MISSING | 403 | This organization is not entitled to that product in this environment. | Do not retry automatically |
ORGANIZATION_SUSPENDED | 403 | This organization is not active. | Do not retry automatically |
PRODUCT_NOT_AVAILABLE | 403 | That product is not available. | Do not retry automatically |
PRODUCT_RETIRED | 403 | That product has been withdrawn. | Do not retry automatically |
SCOPE_INSUFFICIENT | 403 | This API key does not carry the scope this product requires. | Do not retry automatically |
PRODUCT_NOT_FOUND | 404 | No such product. | Do not retry automatically |
IDEMPOTENCY_KEY_REUSED | 409 | That idempotency key was already used for a different request. | Do not retry automatically |
PRICE_UNAVAILABLE | 409 | No active price covers this product right now. | Safe to retry |
REQUEST_IN_PROGRESS | 409 | An earlier attempt with this key is still running. | Safe to retry |
SETTLEMENT_PENDING | 409 | This request is awaiting reconciliation by an operator. | Do not retry automatically |
API_VERSION_SUNSET | 410 | That API version passed its announced sunset date. | Do not retry automatically |
REQUEST_TOO_LARGE | 413 | The request body is too large. | Do not retry automatically |
OCR_UNSUPPORTED_MEDIA_TYPE | 415 | That document format is not accepted. | Do not retry automatically |
UNSUPPORTED_MEDIA_TYPE | 415 | That content type is not accepted on this route. | Do not retry automatically |
SANDBOX_FIXTURE_MISSING | 422 | No sandbox fixture exists for this input. Use a different test value. | Do not retry automatically |
UPSTREAM_REJECTED | 422 | The upstream source rejected the input. | Do not retry automatically |
VALIDATION_FAILED | 422 | The request payload is invalid. | Do not retry automatically |
CONCURRENCY_LIMIT | 429 | Too many simultaneous requests. | Safe to retry |
OCR_QUEUE_SATURATED | 429 | The document queue is full. Retry shortly. | Safe to retry |
QUOTA_EXCEEDED | 429 | The allowance for this window is spent. | Do not retry automatically |
RATE_LIMITED | 429 | Too many requests. | Safe to retry |
INTERNAL_ERROR | 500 | An unexpected error occurred. | Safe to retry |
OUTCOME_UNCERTAIN | 502 | The outcome of this request is not yet known. Retry with the same Idempotency-Key. | Do not retry automatically |
UPSTREAM_UNAVAILABLE | 502 | The upstream source is unavailable. Retry shortly. | Safe to retry |
MAINTENANCE_MODE | 503 | The service is in a maintenance window. | Safe to retry |
NO_PROVIDER_AVAILABLE | 503 | No provider can serve this product right now. | Safe to retry |
OCR_UNAVAILABLE | 503 | Document reading is unavailable right now. Retry later. | Safe to retry |
SERVICE_OVERLOADED | 503 | The service is shedding load. Retry shortly. | Safe to retry |
UPSTREAM_TIMEOUT | 504 | The upstream source did not respond in time. | Safe to retry |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Rate limits
| Scope | Limit | Window | At the limit |
|---|---|---|---|
| Your API key, within your organisation's limit | The figure in X-RateLimit-Limit | Per minute | 429 RATE_LIMITED, with Retry-After in seconds. Every answer past authentication carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Use cases
- Fintech and PSP: create a merchant onboarding record from the certificate
- Marketplaces: seller registration and business detail capture
- Lending and NBFC: business document intake for working-capital files
- Logistics: consignor and transport vendor GSTIN capture for billing
- Insurance: proposer details for commercial policy applications
- Procurement: supplier master creation from vendor-submitted certificates
What this service does
GSTIN and business details as fields
Send a certificate image and the response carries what the service could read. That can include the GSTIN, the legal name and the trade name where one is printed. It can also carry the constitution, the principal place of business, the type of registration, the date of liability and the date of issue. The fields available vary by data source and by the individual record.
Capture inside the merchant application you already run
Plug the service into a merchant application form, a seller registration journey or a vendor onboarding portal. It also runs from an internal dashboard, or as a batch over documents already on file.
A clean GSTIN to check against
Extraction gives you the identifier and business details that a registration check, a bank-detail check or a vendor-master rule can then run against. Capture and verification become two steps of one workflow.
Annexure pages read as well as the first sheet
A registration record can run across the main certificate page and its annexures. You can send those pages so the details on each are read, subject to the multi-page handling in the service contract you choose.
How a check runs
Collect the certificate from the business
Accept an upload, scan or export of the GST registration certificate as part of the merchant, seller or vendor application the business is already completing.
Post the pages to the API
Your application sends the collected pages to the service from the onboarding step that gathered them.
The service reads the certificate
The service works through the pages and pulls out the registration and business details it can recover.
Fill the merchant or vendor record
The available fields come back structured, ready to drop into your merchant, seller or supplier record.
Confirm the GSTIN, then check it
Show the business or a reviewer the pre-filled onboarding form for confirmation. Route unreadable documents to an exception queue, then pass the confirmed identifier into your next registration check.
Questions
- What do I send to read a GST certificate?
- An image, scan or export of the GST registration certificate, collected from the business as part of your own onboarding. Where the record runs across more than one page, send the extra pages as well so the details on them can be read.
- Which GSTIN and business fields come back?
- The details the service can read from the certificate, as structured fields. Depending on the document, that can include the GSTIN, the legal name of the business and the trade name where one is printed. It can also include the constitution of the business and the address of the principal place of business. The type of registration, the date of liability and the date of issue can come back too. The exact fields available vary by data source and by record.
- Does GST certificate OCR tell me if the registration is active?
- No. The service reports what is printed on the document you sent. A certificate can be superseded by a later amendment, and a registration can change status after the certificate is issued. Confirming a registration is a separate check, and most teams run it immediately after capture.
- What are the rules on using GST certificate data?
- Take the certificate from the business openly, with its consent, and use the extracted values only for the onboarding, credit, billing or compliance purpose you collected them for. For a proprietorship the document also identifies a person. Keep access limited to the teams whose work needs it, and hold the document and its fields only while that purpose and your policy allow.
- Why do two GST certificates return different fields?
- Certificates are re-issued when a registration is amended, and older documents and annexures do not all carry the same layout. A skewed, shadowed or heavily compressed capture also hides text a clean scan would show. Expect any field to be missing on a given document, and route what the service cannot read to an exception queue.
- How do we start using the GST Certificate OCR API?
- Start with Get API on this page, and our team will go through your onboarding workflow with you. Access, supported formats, multi-page handling and volumes are set by the service contract you agree.
Catalog entry last updated .