{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e17d165c-15e1-4366-829d-8421b98d8e7c","name":"KYC Bharat API Suite","description":"## KYC Bharat API Suite\n\nKYCBharat’s API suite provides modular APIs to build a fast, scalable KYC and onboarding workflow.\n\n### Getting credentials\n\nTo use the APIs, you need these credentials rom KYCBharat:\n\n- **API Key** (`x-api-key`)\n    \n\n### Base URL\n\nSet `base_url` in your environment before sending requests.\n\n### Authentication (required headers)\n\nInclude these headers on every request:\n\n| Header | Required | Description |\n| --- | --- | --- |\n| `x-api-key` | Yes | Your API key. |\n\nSome endpoints may also support request-signing headers:\n\n| Header | Required | Description |\n| --- | --- | --- |\n| `x-signature` | No | HMAC signature of the request payload using your shared secret. |\n| `x-timestamp` | No | Unix timestamp (seconds) to help prevent replay attacks. |\n\n### Document input options\n\nFor document/image uploads, endpoints typically accept **either**:\n\n- a **file**, or\n    \n- a **Base64-encoded** payload\n    \n\n_(size: < 3 MB)_.\n\nSee each endpoint for the exact fields supported.\n\n---\n\n# Error Responses\n\nAll error responses follow the same format:\n\n``` json\n{\n    \"success\": false,\n    \"error_code\": \"ERROR_CODE\",\n    \"error_message\": \"Human readable message\",\n    \"meta\": {\n        \"request_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n    }\n}\n\n ```\n\n### Possible Error Codes\n\n| HTTP Status | Error Code | Description |\n| --- | --- | --- |\n| `400` | `MISSING_INPUT` | No document was provided in the request. |\n| `400` | `EMPTY_FILE` | Uploaded file is empty (0 bytes). |\n| `401` | `AUTHENTICATION_REQUIRED` | API key missing from request headers. |\n| `401` | `AUTHENTICATION_FAILED` | Invalid API key provided. |\n| `401` | `INVALID_SIGNATURE` | HMAC signature verification failed. |\n| `413` | `FILE_TOO_LARGE` | Uploaded file exceeds the maximum allowed size. |\n| `415` | `INVALID_FILE_TYPE` | Uploaded file format is not supported. |\n| `422` | `CORRUPT_FILE` | Uploaded document could not be processed. |\n| `429` | `RATE_LIMIT_EXCEEDED` | Too many requests sent in a short time window. |\n| `500` | `MASKING_FAILED` | Document masking process failed. |\n| `500` | `INTERNAL_ERROR` | Unexpected internal server error occurred. |\n| `503` | `SERVICE_TEMPORARILY_UNAVAILABLE` |  |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"52689524","team":5320324,"collectionId":"e17d165c-15e1-4366-829d-8421b98d8e7c","publishedId":"2sBXcHhK1B","public":true,"publicUrl":"https://api-docs.kycbharat.com","privateUrl":"https://go.postman.co/documentation/52689524-e17d165c-15e1-4366-829d-8421b98d8e7c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0d7350"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/c96635ba-38e0-4be0-a117-09f61750a00e/Mi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0d7350"}},{"name":"light","logo":"https://content.pstmn.io/dfab5288-528d-470a-8a0e-3f70ac930542/MS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0d7350"}}]}},"version":"8.10.1","publishDate":"2026-02-27T09:14:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/dfab5288-528d-470a-8a0e-3f70ac930542/MS5wbmc=","logoDark":"https://content.pstmn.io/c96635ba-38e0-4be0-a117-09f61750a00e/Mi5wbmc="}},"statusCode":200},"environments":[{"name":"Beta","id":"f229aab5-feaa-40d9-be60-d275535a2f0f","owner":"52689524","values":[{"key":"base_url","value":"dev.kycbharat.com","enabled":true,"type":"default"},{"key":"x-api-key","value":"","enabled":true,"type":"secret"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/88d91fe7944c4c0fdbb7e0fbbc0b6f5c738dd760922dc922c5ca067f4e3ba368","favicon":"https://kycbharat.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Beta","value":"52689524-f229aab5-feaa-40d9-be60-d275535a2f0f"}],"canonicalUrl":"https://api-docs.kycbharat.com/view/metadata/2sBXcHhK1B"}