Name Match
kycScore how likely two spellings of a name belong to the same person, from 0 to 100. Built for Indian KYC records: it ignores case, punctuation, titles (Mr, Smt, Dr, Shri) and word order, understands initials (R Kumar / Ravi Kumar), joined names (Vijaykumar / Vijay Kumar), common abbreviations (Mohd / Mohammed, Kr / Kumar) and spelling variants (Preeti / Priti, Rafiq / Rafik). A missing middle name costs a little; a different first name costs a lot. Returns the score, a match flag at your threshold (default 80) and the kind of match.
POST /gw/v1/name-match/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/name-match/
The trailing slash is required. /v1/name-match/ works; /v1/name-match returns 404 Not Found. This applies to every product.
| Field | Type | Required | Constraints |
|---|---|---|---|
| name1 | string | required | maxLength: 200 · First name to compare, e.g. from the PAN record. |
| name2 | string | required | maxLength: 200 · Second name, e.g. from the bank account. |
| threshold | number | optional | Optional. Score at or above which match is true. Default 80. |
Code snippets
curl -X POST https://apisathi.in/gw/v1/name-match/ \
-H "X-API-Key: $API_SATHI_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"name1":"MOHD RAFIQ KHAN","name2":"Mohammed Rafik Khan"}'Response
| Field | Type | Required | Constraints |
|---|---|---|---|
| score | integer | optional | — |
| match | boolean | optional | — |
| threshold | number | optional | — |
| match_type | string | optional | — |
| name1_normalized | string | optional | — |
| name2_normalized | string | optional | — |
Sample response
{
"score": 98,
"match": true,
"threshold": 80,
"match_type": "fuzzy",
"name1_normalized": "MOHAMMED RAFIQ KHAN",
"name2_normalized": "MOHAMMED RAFIK KHAN"
}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 — Name Match",
"version": "1.0.0",
"description": "Score how likely two spellings of a name belong to the same person, from 0 to 100. Built for Indian KYC records: it ignores case, punctuation, titles (Mr, Smt, Dr, Shri) and word order, understands initials (R Kumar / Ravi Kumar), joined names (Vijaykumar / Vijay Kumar), common abbreviations (Mohd / Mohammed, Kr / Kumar) and spelling variants (Preeti / Priti, Rafiq / Rafik). A missing middle name costs a little; a different first name costs a lot. Returns the score, a match flag at your threshold (default 80) and the kind of match."
},
"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": {
"/name-match": {
"post": {
"operationId": "nameMatch",
"tags": [
"kyc"
],
"summary": "Name Match",
"description": "Score how likely two spellings of a name belong to the same person, from 0 to 100. Built for Indian KYC records: it ignores case, punctuation, titles (Mr, Smt, Dr, Shri) and word order, understands initials (R Kumar / Ravi Kumar), joined names (Vijaykumar / Vijay Kumar), common abbreviations (Mohd / Mohammed, Kr / Kumar) and spelling variants (Preeti / Priti, Rafiq / Rafik). A missing middle name costs a little; a different first name costs a lot. Returns the score, a match flag at your threshold (default 80) and the kind of match.",
"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": [
"name1",
"name2"
],
"properties": {
"name1": {
"type": "string",
"maxLength": 200,
"description": "First name to compare, e.g. from the PAN record."
},
"name2": {
"type": "string",
"maxLength": 200,
"description": "Second name, e.g. from the bank account."
},
"threshold": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Optional. Score at or above which match is true. Default 80."
}
},
"additionalProperties": false
},
"example": {
"name1": "MOHD RAFIQ KHAN",
"name2": "Mohammed Rafik Khan"
}
}
}
},
"responses": {
"200": {
"description": "Successful, normalized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"score": {
"type": "integer"
},
"match": {
"type": "boolean"
},
"threshold": {
"type": "number"
},
"match_type": {
"type": "string",
"enum": [
"exact",
"reordered",
"spacing",
"initials",
"partial",
"fuzzy",
"mismatch"
]
},
"name1_normalized": {
"type": "string"
},
"name2_normalized": {
"type": "string"
}
}
},
"example": {
"score": 98,
"match": true,
"threshold": 80,
"match_type": "fuzzy",
"name1_normalized": "MOHAMMED RAFIQ KHAN",
"name2_normalized": "MOHAMMED RAFIK KHAN"
}
}
}
},
"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"
}
}
}
}
}
}
}
}
}
}
}
}
}