{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"12b7207f-56ef-42c6-b5e9-f0a7bee39681","name":"Facheck API Documentation","description":"<img src=\"https://content.pstmn.io/278165c6-6eec-4f88-a357-cc8d7d504bdf/ZmNsb2dvLnBuZw==\" width=\"210\" height=\"111\">\n\n## Introduction\n\nOur services provide a comprehensive suite of **Verification API solutions** designed to meet diverse business requirements. These APIs are engineered to deliver **swift, secure, and reliable performance**, ensuring seamless integration with partner systems.\n\nAll APIs are constructed using **RESTful interfaces** and standard **HTTP methods**, enabling straightforward implementation and interoperability.\n\n#### Key Features\n\n1. **Secure Communication**  \n    All request and response exchanges are **encrypted** to ensure data confidentiality and integrity.\n    \n2. **Authentication**  \n    Each user is uniquely identified through the use of an **API key** during the authentication process.\n    \n3. **Data Format**  \n    All API requests must be submitted in **JSON format** with encrypted payloads.\n    \n    - _Exception:_ Document submissions may require alternative formats as specified in the respective API guidelines.\n        \n4. **Response Classification**  \n    API responses are categorized using **flags**, enabling clear interpretation of results and streamlined error handling.\n    \n\n# Getting Started\n\nThe **Facheck API** serves as a standardized, programmatic gateway to the Facheck infrastructure. It is built on a **RESTful architecture**, leveraging **HTTP requests** and **JSON responses** for efficient and secure data transfer.\n\n#### Key Highlights\n\n- **RESTful Design:** All endpoints follow REST principles, ensuring predictable and consistent behavior.\n    \n- **Data Format:** Requests and responses are exchanged in **JSON**, enabling lightweight and structured communication.\n    \n- **Secure Access:** Authentication is required for all API calls, ensuring authorized usage.\n    \n\n#### Quick Start with Postman\n\nThe easiest way to begin using the Facheck API is through **Postman**, a free and widely used tool for testing and debugging API requests.\n\n- Click the **Run in Postman** button provided above.\n    \n- Import the official **Facheck Postman Collection**, which contains all documented endpoints.\n    \n- Each endpoint in this documentation is readily available for execution within Postman, serving as the **source of truth** for integration and testing.\n    \n\n# Authentication\n\nTo securely access Facheck services, all API requests must include valid authentication credentials. Requests must be equipped with an **Authorization header** containing the required key–value pair for verification.\n\n``` makefile\nx-parse-rest-api-key   : <YOUR_API_KEY>\nx-parse-application-id : <YOUR_APPLICATION_ID>\n\n ```\n\nIt is mandatory to provide an authentic key-value in the header to access our services.\n\n# Request–Response Workflow\n\nIt is essential that all requests sent to our server strictly adhere to the prescribed format, particularly for **ID‑based verification** services. This ensures consistency, security, and accurate processing of data across all integrations.\n\n#### Request Format\n\n- **Method:** `POST`\n    \n- **Content-Type:** `application/json`\n    \n- **Authentication:** Mandatory `Authorization` header with valid API key\n    \n- **Payload:** JSON object containing required parameters\n    \n\n``` json\n/* REQUEST */\n{\n    \"encrypted_data\": \"hXXwh4fdkKuKV57WwTiVLltLOxfe6NubyIJ0KzOynGc=\"\n}\n\n ```\n\n#### Response Format\n\n``` json\n/* RESPONSE */\n{\n    \"statusCode\": 200,\n    \"statusMessage\": \"Success\",\n    \"statusFlag\": 1,\n    \"data\": {\n        \"return_response\": \"YOR6enHbD8OxA1t574MOjthNOkEDqBUlxqsM1wma7N/rDwndT\"\n    },\n    \"serviceName\": \"PAN COMPREHENSIVE\",\n    \"errorDescription\": null,\n    \"errorReferenceId\": \"\"\n}\n\n ```\n\n# HTTP Status Codes & Flags\n\n- **2xx – Success**  \n    Indicates that the request was successfully processed and a valid response has been returned.\n    \n    - Example: `200 OK`\n        \n- **4xx – Client Error**  \n    Indicates that the request could not be processed due to invalid input or missing information provided by the client.\n    \n    - Example: `400 Bad Request`\n        \n- **5xx – Server Error**  \n    Indicates that the request failed due to an internal error on Facheck servers.\n    \n    - Example: `500 Internal Server Error`\n        \n\n#### Status Flags\n\n**i)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 1 | 200 | Encrypted Value |\n\n_**Message :**_ _Success / Failed._\n\n_**Error Description :**_ _N/A._\n\n**ii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 2 | 402 | Encrypted Value |\n\n_**Message :**_ _Balance Exhausted (Prepaid) / Payment Pending (Postpaid)._\n\n_**Error Description :**_ _Top up your wallet to continue our service usage (Prepaid) / Clear the due bill to continue our service usage (Postpaid)._\n\n**iii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 3 | 403 | Encrypted Value |\n\n_**Message :**_ _Your Account is Inactive._\n\n_**Error Description :**_ _Your account is presently not active.Please contact_ [<i>support@facheck.in</i>](https://mailto:support@facheck.in) _for further assistance._\n\n**iv)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 4 | 503 | Encrypted Value |\n\n_**Message :**_ _Verification service not available at the moment._\n\n_**Error Description :**_ _The verification service you are trying to access is not available at the moment.Please contact_ [<i>support@facheck.in</i>](https://mailto:support@facheck.in) _for further information._\n\n**v)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 5 | 401 | Encrypted Value |\n\n_**Message :**_ _Access not granted._\n\n_**Error Description :**_ _You don't have access for KYC Verification , Or the Access has been revoked Please contact_ [<i>support@facheck.in</i>](https://mailto:support@facheck.in) _to request access._\n\n**vi)**\n\n| _**Status Flag**_ | _**Status Code**_ | _**Data Field Specification**_ |\n| --- | --- | --- |\n| 6 | 407 | Encrypted Value |\n\n_**Message :**_ _We’ve adjusted the pricing. Please review and acknowledge now._\n\n_**Error Description :**_ _You have not accepted the latest price updation for {{serviceName}}._\n\n**vii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _**Data Field Specification**_ |\n| --- | --- | --- |\n| 7 | 500 | _**null**_ |\n\n_**Message :**_ _We encountered a technical issue.Please try again later or contact support if the issue persists._\n\n_**Error Description :**_ _There was a server-side issue. Please contact_ [<i>support@facheck.in</i>](https://mailto:support@facheck.in) _with the Error ID for further support._\n\n**viii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 8 | 423 | Encrypted Value |\n\n_**Message :**_ _Invalid Encryption key._\n\n_**Error Description :**_ _The encryption key being used is not legitimate; please verify and try again._\n\n**ix)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 9 | 424 | Encrypted Value |\n\n_**Message :**_ _Invalid JSON structure._\n\n_**Error Description :**_ _The JSON structure provided in encrypted format is Inoperative_.\n\n**x)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 10 | 412 | _**null**_ |\n\n_**Message :**_ _The header value provided is not accurate or appropriate._\n\n_**Error Description :**_ _The JSON structure provided in encrypted format is Inoperative._\n\n**xi)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ | **Applicable For** |\n| --- | --- | --- | --- |\n| 11 | 404 | Encrypted Value | _**OCR**_ based services only |\n| 11 | 415 | Encrypted Value | _**OCR**_ based services only |\n| 11 | 413 | Encrypted Value | _**OCR**_ based services only |\n\n_**Message / Error Description (404) :**_ _The file is either missing or contains no data._\n\n_**Message / Error Description (415):**_ _The file format is not supported._\n\n_**Message / Error Description (413):**_ _The file format is too large,Please use an image below 2MB._\n\n**xii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 12 | 422 | Encrypted Value |\n\n_**Message :**_ _A required key is missing from the request._\n\n_**Error Description :**_ _The {{keyName}} key is required but was not provided in the request payload._\n\n**xiii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 13 | 400 | Encrypted Value |\n\n_**Message :**_ _The reference number provided is invalid and cannot be processed / The estamp category code entered is either invalid or not available._\n\n_**Error Description :**_ _The provided reference number does not correspond to any existing record / The estamp category code entered does not correspond to any recognized or acceptable values._\n\n_**Note :**_ _This is primarily applicable to callback APIs; the e‑stamp API category code (document code) is invalid_.\n\n**xiv)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 14 | 503 | Encrypted Value |\n\n_**Message :**_ _The requested estamp category is currently unavailable._\n\n_**Error Description :**_ _The requested estamp category is presently unavailable and cannot be selected for further action._\n\n**xv)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 15 | 403 | Encrypted Value |\n\n_**Message :**_ _Artice code not configured._\n\n_**Error Description :**_ _The specified article code is not configured for your organization._\n\n**xvi)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 16 | 451 | Encrypted Value |\n\n_**Message :**_ _Invalid Stamp Denomination/ Stamp Consideration Amount._\n\n_**Error Description :**_ _The Stamp amount Or Consideration amount provided does not meet the required criteria. Please verify and submit a valid amount._\n\n**xvii)**\n\n| _**Status Flag**_ | _**Status Code**_ | _Data Field Specification_ |\n| --- | --- | --- |\n| 17 | 400 | Encrypted Value |\n\n_**Message :**_ _Invalid Inputs (AADHAAR E SIGN)._\n\n_**Error Description :**_ _Invalid Inputs (AADHAAR E SIGN)._\n\n_","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32089063","team":5753834,"collectionId":"12b7207f-56ef-42c6-b5e9-f0a7bee39681","publishedId":"2sAY547z6o","public":true,"publicUrl":"https://documenter-api.postman.tech/view/32089063/2sAY547z6o","privateUrl":"https://go.postman.co/documentation/32089063-12b7207f-56ef-42c6-b5e9-f0a7bee39681","customColor":{"top-bar":"FFFFFF","right-sidebar":"E2DFD2","highlight":"1D976C"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/2a81eb25-ef27-4412-8e07-855df9a07ac4/ZmNsb2dvLnBuZw==","colors":{"top-bar":"303030","right-sidebar":"303030","highlight":"1D976C"}},{"name":"light","logo":"https://content.pstmn.io/e74432d8-db22-4800-838e-b687194e02e1/ZmNsb2dvLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"E2DFD2","highlight":"1D976C"}}]}},"version":"8.10.1","publishDate":"2026-02-09T07:34:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/e74432d8-db22-4800-838e-b687194e02e1/ZmNsb2dvLnBuZw==","logoDark":"https://content.pstmn.io/2a81eb25-ef27-4412-8e07-855df9a07ac4/ZmNsb2dvLnBuZw=="}},"statusCode":200},"environments":[],"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/4dcda0703ae5dce2a4ae0061a14c49aba36213ebbbd4e8e81ecf2a0b693acd82","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAY547z6o"}