ID Format Validator
kycCheck that Indian identifiers are well-formed before you pay for a lookup: PAN, GSTIN (with check character), Aadhaar (Verhoeff check digit), Aadhaar VID, IFSC, mobile, email, UPI ID, CIN, LLPIN, DIN, TAN, Udyam, Voter ID, passport, driving licence and vehicle registration. Send any combination in one call. Each comes back valid or not, with the reason and what its structure tells you (PAN holder type, GSTIN state and embedded PAN, CIN company type and year). This checks format only, not whether the number exists. A full Aadhaar number is never echoed back.
POST /gw/v1/id-format-validate-v1/SLA p95: 50 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/id-format-validate-v1/
The trailing slash is required. /v1/id-format-validate-v1/ works; /v1/id-format-validate-v1 returns 404 Not Found. This applies to every product.
| Field | Type | Required | Constraints |
|---|---|---|---|
| pan | string | optional | — |
| gstin | string | optional | — |
| aadhaar | string | optional | — |
| vid | string | optional | — |
| ifsc | string | optional | — |
| mobile | string | optional | — |
| string | optional | — | |
| upi | string | optional | — |
| cin | string | optional | — |
| llpin | string | optional | — |
| din | string | optional | — |
| tan | string | optional | — |
| udyam | string | optional | — |
| voter_id | string | optional | — |
| passport | string | optional | — |
| dl | string | optional | — |
| vehicle_rc | string | optional | — |
Code snippets
curl -X POST https://apisathi.in/gw/v1/id-format-validate-v1/ \
-H "X-API-Key: $API_SATHI_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"pan":"ABCPE1234F","gstin":"27AAPFU0939F1ZV","aadhaar":"499118665246","mobile":"+91 98765 43210"}'Response
| Field | Type | Required | Constraints |
|---|---|---|---|
| all_valid | boolean | optional | — |
| results | object | optional | One entry per field sent: {valid, normalized, reason?, details?}. |
Sample response
{
"all_valid": true,
"results": {
"pan": {
"valid": true,
"normalized": "ABCPE1234F",
"details": {
"holder_type": "Individual",
"holder_type_code": "P",
"name_initial": "E"
}
},
"gstin": {
"valid": true,
"normalized": "27AAPFU0939F1ZV",
"details": {
"state_code": "27",
"state": "Maharashtra",
"pan": "AAPFU0939F",
"pan_format_valid": true,
"holder_type": "Firm / LLP",
"registration_number": "1"
}
},
"aadhaar": {
"valid": true,
"normalized": "XXXXXXXX5246",
"details": {
"last4": "5246"
}
},
"mobile": {
"valid": true,
"normalized": "9876543210",
"details": {
"e164": "+919876543210"
}
}
}
}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 — ID Format Validator",
"version": "1.0.0",
"description": "Check that Indian identifiers are well-formed before you pay for a lookup: PAN, GSTIN (with check character), Aadhaar (Verhoeff check digit), Aadhaar VID, IFSC, mobile, email, UPI ID, CIN, LLPIN, DIN, TAN, Udyam, Voter ID, passport, driving licence and vehicle registration. Send any combination in one call. Each comes back valid or not, with the reason and what its structure tells you (PAN holder type, GSTIN state and embedded PAN, CIN company type and year). This checks format only, not whether the number exists. A full Aadhaar number is never echoed back."
},
"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": {
"/id-format-validate-v1": {
"post": {
"operationId": "idFormatValidateV1",
"tags": [
"kyc"
],
"summary": "ID Format Validator",
"description": "Check that Indian identifiers are well-formed before you pay for a lookup: PAN, GSTIN (with check character), Aadhaar (Verhoeff check digit), Aadhaar VID, IFSC, mobile, email, UPI ID, CIN, LLPIN, DIN, TAN, Udyam, Voter ID, passport, driving licence and vehicle registration. Send any combination in one call. Each comes back valid or not, with the reason and what its structure tells you (PAN holder type, GSTIN state and embedded PAN, CIN company type and year). This checks format only, not whether the number exists. A full Aadhaar number is never echoed back.",
"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",
"minProperties": 1,
"properties": {
"pan": {
"type": "string"
},
"gstin": {
"type": "string"
},
"aadhaar": {
"type": "string"
},
"vid": {
"type": "string"
},
"ifsc": {
"type": "string"
},
"mobile": {
"type": "string"
},
"email": {
"type": "string"
},
"upi": {
"type": "string"
},
"cin": {
"type": "string"
},
"llpin": {
"type": "string"
},
"din": {
"type": "string"
},
"tan": {
"type": "string"
},
"udyam": {
"type": "string"
},
"voter_id": {
"type": "string"
},
"passport": {
"type": "string"
},
"dl": {
"type": "string"
},
"vehicle_rc": {
"type": "string"
}
},
"additionalProperties": false
},
"example": {
"pan": "ABCPE1234F",
"gstin": "27AAPFU0939F1ZV",
"aadhaar": "499118665246",
"mobile": "+91 98765 43210"
}
}
}
},
"responses": {
"200": {
"description": "Successful, normalized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"all_valid": {
"type": "boolean"
},
"results": {
"type": "object",
"description": "One entry per field sent: {valid, normalized, reason?, details?}."
}
}
},
"example": {
"all_valid": true,
"results": {
"pan": {
"valid": true,
"normalized": "ABCPE1234F",
"details": {
"holder_type": "Individual",
"holder_type_code": "P",
"name_initial": "E"
}
},
"gstin": {
"valid": true,
"normalized": "27AAPFU0939F1ZV",
"details": {
"state_code": "27",
"state": "Maharashtra",
"pan": "AAPFU0939F",
"pan_format_valid": true,
"holder_type": "Firm / LLP",
"registration_number": "1"
}
},
"aadhaar": {
"valid": true,
"normalized": "XXXXXXXX5246",
"details": {
"last4": "5246"
}
},
"mobile": {
"valid": true,
"normalized": "9876543210",
"details": {
"e164": "+919876543210"
}
}
}
}
}
}
},
"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"
}
}
}
}
}
}
}
}
}
}
}
}
}