MSME Certificate OCR API
New
Upload a Udyam registration certificate and get the printed enterprise details back as structured fields. An MSME supplier, borrower or seller record then starts without retyping.
Overview
MSME Certificate OCR reads a Udyam registration certificate you submit as a file and returns the enterprise details written across it as named fields. The certificate is how a small business shows it is a registered micro, small or medium enterprise. Lenders, large buyers and marketplaces all collect it at onboarding. Your application uploads the certificate image or scan the enterprise provided. The service reads it and returns the fields it can extract, as far as the image allows. That can include the Udyam registration number, enterprise name, type of organization and classification, the addresses as printed and the dates shown on the document. Which fields you get varies with the data source and the individual record. Capture and confirmation are different jobs: OCR reports what the document says, and confirming the registration against a business data source is a separate check.
- Category
- Document OCR APIs
- Coverage
- Udyam and MSME registration certificates issued to enterprises across India
- Input
- An image, scan or export of a Udyam registration certificate
- Output
- Structured enterprise and registration fields, where the document and image allow
- Typical users
- Lenders and NBFCs, procurement teams, marketplaces, payment providers, insurers
- Coverage note
- Certificates are re-issued when details change; 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/msme-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/msme-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/msme-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 | ISO date, YYYY-MM-DD; a year or month alone is YYYY or YYYY-MM. | — |
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
- Lending and NBFC: capture MSME classification when a credit file is opened
- Procurement: supplier master creation and MSME payment-timeline tracking
- Marketplaces: small-seller program enrollment from the certificate
- Fintech and PSP: small-merchant onboarding record creation
- Logistics: transport vendor and small-contractor onboarding intake
- Insurance: enterprise details for small-business cover proposals
What this service does
Udyam number and classification as fields
Upload the certificate and the service returns whatever it can read. That can include the Udyam registration number, the enterprise name, the type of organization and the classification. The major activity, the unit and office addresses as printed, the date of incorporation or commencement and the date of registration can come back as well. Which fields arrive varies by data source and by record.
Classification captured before the decision
The classification printed on the certificate drives eligibility for MSME credit products, preferential seller programs and supplier payment-timeline handling. Reading it at the point of application puts it in the record before the decision is made.
Reads the certificate inside your supplier portal
The service can sit inside a supplier onboarding portal, a credit application journey or a seller enrollment flow. An internal dashboard or a batch pass over certificates already on file works just as well.
The registration number the next lookup needs
You end up with the registration number and enterprise details a business check or vendor-master rule can run against. The confirmation step then runs off the capture instead of being a separate manual job.
How a check runs
Ask the enterprise for its certificate
Accept an upload, scan or export of the Udyam registration certificate as part of the supplier, borrower or seller application the enterprise is already completing.
Upload the pages to the API
Your credit or onboarding system sends the collected pages straight to the service.
The service pulls out the enterprise details
The service processes the submitted image and recovers the enterprise and registration details printed on the certificate.
Fill the supplier or borrower record
The response carries the available fields in a shape your supplier, borrower or seller record can take directly.
Confirm the Udyam number, then verify it
Let the enterprise or a reviewer confirm the pre-filled form. Anything the service cannot read goes down an exception path, and the confirmed registration number moves on to your next business check.
Questions
- What file do I send to read a Udyam certificate?
- An image, scan or export of the Udyam registration certificate, collected from the enterprise as part of your own onboarding or credit application. If the record continues past the first page, include those pages so the service can read what is on them.
- Which enterprise details does MSME Certificate OCR return?
- Whatever the service can read off the certificate, returned as structured fields. Depending on the document, that can include the Udyam registration number, the name of the enterprise, the type of organization and the classification. It can also include the major activity, the unit and office addresses as printed, the date of incorporation or commencement of business, and the date of registration. Which fields you actually get varies by data source and by record.
- Does this prove the Udyam registration is genuine?
- No. OCR only reports what the submitted sheet says. A certificate can be superseded when the details behind a registration change, and classification can be updated over time. Confirming a registration against a business data source is a separate check, and most teams run it as soon as the capture is done.
- What are the consent rules for a Udyam certificate?
- Ask the enterprise for the certificate openly, and use what you extract only for the onboarding, credit, procurement or compliance purpose behind the request. Let only the teams whose work needs it open the file, because a proprietorship certificate also identifies a person. Keep the document and the extracted fields no longer than that purpose and your own policy allow.
- Why do some Udyam certificates return fewer fields?
- Certificates are re-issued when the details behind a registration change, and not every document carries the same set of printed details. Skew, shadow or heavy compression can also swallow text that a clean file shows. Design for fields that may not appear, and keep a path for documents the service cannot read.
- How do I get access to MSME Certificate OCR?
- Get API on this page puts you in touch with our team about your onboarding or credit workflow. What you can access, which formats are supported, how multi-page files are handled and what volumes you can run all follow the service contract you agree.
Catalog entry last updated .