{ "info": { "name": "EzVerify API", "description": "KYC verification APIs \u2014 Aadhaar mask/OCR, PAN OCR, name/address matching, face verify & liveness.\n\n**Auth:** send `X-API-Key`.\n**Input:** send documents/images as base64 (`file_b64` / `image_b64`) in the JSON body; options go in the same body.\n**Envelope:** `{ok, data, request_id, took_ms}`.\nLive status: `/v1/status`.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://api.kyc.ezfinanz.com" }, { "key": "api_key", "value": "ez_your_api_key" }, { "key": "jwt", "value": "paste_login_JWT" } ], "item": [ { "name": "Aadhaar", "description": "Mask + OCR for Aadhaar. Send the file as base64 (`file_b64`) in the JSON body; options (return_b64, id_type, \u2026) go in the same body.", "item": [ { "name": "Is this a genuine Aadhaar? Returns verdict + confidence + the signals ", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Is this a genuine Aadhaar? Returns verdict + confidence + the signals that fired. Send file_b64 (base64).", "url": { "raw": "{{base_url}}/v1/aadhaar/detect", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar", "detect" ] }, "body": { "mode": "raw", "raw": "{\n \"file_b64\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"is_aadhaar\": true,\n \"confidence\": 0.98,\n \"pages\": [\n {\n \"is_aadhaar\": true,\n \"confidence\": 0.98,\n \"signals\": {\n \"aadhaar_number\": true,\n \"uidai_keywords\": true,\n \"qr\": true\n }\n }\n ]\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "OCR an Aadhaar: name, DOB, gender, address, pincode", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "OCR an Aadhaar: name, DOB, gender, address, pincode. The number is returned as masked_ref only. Send file_b64 (base64).", "url": { "raw": "{{base_url}}/v1/aadhaar/extract", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar", "extract" ] }, "body": { "mode": "raw", "raw": "{\n \"file_b64\": \"\",\n \"id_type\": \"aadhaar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"id_type\": \"aadhaar\",\n \"pages\": [\n {\n \"classification\": \"aadhaar\",\n \"fields\": {\n \"masked_ref\": \"XXXX-XXXX-1234\",\n \"name\": \"Rajesh Kumar\",\n \"dob\": \"01/01/1990\",\n \"yob\": 1990,\n \"gender\": \"MALE\",\n \"address\": \"12 MG Road, Bengaluru\",\n \"state\": \"Karnataka\",\n \"pincode\": \"560001\",\n \"confidence\": 0.93\n }\n }\n ]\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Mask the first 8 Aadhaar digits + the QR code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Mask the first 8 Aadhaar digits + the QR code. Send **file_b64** (base64 of the image or PDF). Options go in the JSON body. Returns the masked image (base64 when return_b64=true, else raw image bytes).", "url": { "raw": "{{base_url}}/v1/aadhaar/mask", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar", "mask" ] }, "body": { "mode": "raw", "raw": "{\n \"file_b64\": \"\",\n \"return_b64\": true,\n \"fail_if_none\": false,\n \"id_type\": \"aadhaar\",\n \"unique_request_id\": \"req-abc-123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"pages\": [\n {\n \"page\": 1,\n \"aadhaar_found\": 1,\n \"masked_refs\": [\n \"XXXX-XXXX-1234\"\n ],\n \"qr_masked\": true,\n \"already_masked\": false,\n \"rotation_used\": 0\n }\n ],\n \"total_masked\": 1,\n \"output\": {\n \"content_type\": \"image/jpeg\",\n \"b64\": \"\"\n }\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "All-in-one: masked image + extracted fields in one OCR pass", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "All-in-one: masked image + extracted fields in one OCR pass. Send file_b64 (base64).", "url": { "raw": "{{base_url}}/v1/aadhaar/process", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar", "process" ] }, "body": { "mode": "raw", "raw": "{\n \"file_b64\": \"\",\n \"return_b64\": true,\n \"id_type\": \"aadhaar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"id_type\": \"aadhaar\",\n \"fields\": {\n \"masked_ref\": \"XXXX-XXXX-1234\",\n \"name\": \"Rajesh Kumar\",\n \"dob\": \"01/01/1990\",\n \"gender\": \"MALE\",\n \"pincode\": \"560001\"\n },\n \"details\": {\n \"masking_done_count\": 1,\n \"already_masked_count\": 0\n },\n \"output\": {\n \"content_type\": \"image/jpeg\",\n \"b64\": \"\"\n }\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] } ] }, { "name": "PAN", "description": "PAN card OCR.", "item": [ { "name": "OCR a PAN card: name, father's name, PAN number, DOB", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "OCR a PAN card: name, father's name, PAN number, DOB. Send file_b64 (base64).", "url": { "raw": "{{base_url}}/v1/pan/extract", "host": [ "{{base_url}}" ], "path": [ "v1", "pan", "extract" ] }, "body": { "mode": "raw", "raw": "{\n \"file_b64\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"id_type\": \"pan\",\n \"pages\": [\n {\n \"classification\": \"pan\",\n \"fields\": {\n \"masked_ref\": \"XXXXX1234X\",\n \"name\": \"Rajesh Kumar\",\n \"father_name\": \"Suresh Kumar\",\n \"dob\": \"01/01/1990\",\n \"confidence\": 0.9\n }\n }\n ]\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] } ] }, { "name": "Match", "description": "India-tuned fuzzy matching for names & addresses.", "item": [ { "name": "Fuzzy-match two Indian addresses (libpostal-normalised)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Fuzzy-match two Indian addresses (libpostal-normalised). pincode_a/b optional.", "url": { "raw": "{{base_url}}/v1/match/address", "host": [ "{{base_url}}" ], "path": [ "v1", "match", "address" ] }, "body": { "mode": "raw", "raw": "{\n \"address_a\": \"12 MG Road, Bengaluru 560001\",\n \"address_b\": \"No.12, Mahatma Gandhi Rd, Bangalore 560001\",\n \"pincode_a\": \"560001\",\n \"pincode_b\": \"560001\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"score\": 88,\n \"band\": \"REVIEW\",\n \"decision\": \"REVIEW\",\n \"confidence\": 88,\n \"reasons\": [\n \"locality_alias:bengaluru=bangalore\",\n \"pincode_exact\"\n ]\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Fuzzy-match two Indian names (initial expansion, transliteration, phon", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Fuzzy-match two Indian names (initial expansion, transliteration, phonetics).", "url": { "raw": "{{base_url}}/v1/match/name", "host": [ "{{base_url}}" ], "path": [ "v1", "match", "name" ] }, "body": { "mode": "raw", "raw": "{\n \"name_a\": \"Rajesh Kumar\",\n \"name_b\": \"Rajesh K\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"score\": 97,\n \"band\": \"AUTO_MATCH\",\n \"decision\": \"ACCEPT\",\n \"p_match\": 99,\n \"confidence\": 99,\n \"reasons\": [\n \"initial_expansion:k->kumar\"\n ]\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Combined name + address person match with an overall verdict", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Combined name + address person match with an overall verdict.", "url": { "raw": "{{base_url}}/v1/match/person", "host": [ "{{base_url}}" ], "path": [ "v1", "match", "person" ] }, "body": { "mode": "raw", "raw": "{\n \"name_a\": \"Rajesh Kumar\",\n \"name_b\": \"Rajesh K\",\n \"address_a\": \"12 MG Road, Bengaluru\",\n \"address_b\": \"No.12 MG Rd, Bangalore\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"score\": 92,\n \"band\": \"AUTO_MATCH\",\n \"decision\": \"ACCEPT\",\n \"name\": {\n \"score\": 97\n },\n \"address\": {\n \"score\": 88\n }\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] } ] }, { "name": "Face", "description": "Face match, liveness and hosted capture.", "item": [ { "name": "Passive liveness / anti-spoof score for a selfie image", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Passive liveness / anti-spoof score for a selfie image.", "url": { "raw": "{{base_url}}/v1/face/liveness", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "liveness" ] }, "body": { "mode": "raw", "raw": "{\n \"image_b64\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"live\": true,\n \"score\": 0.82,\n \"label\": \"real\"\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Submit a captured selfie for liveness (+ match vs the session's refere", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Submit a captured selfie for liveness (+ match vs the session's reference).", "url": { "raw": "{{base_url}}/v1/face/liveness-selfie", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "liveness-selfie" ] }, "body": { "mode": "raw", "raw": "{\n \"selfie_b64\": \"\",\n \"challenge\": {\n \"blink\": true,\n \"centered\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"live\": true,\n \"score\": 0.84,\n \"match\": {\n \"similarity\": 0.9,\n \"verdict\": \"MATCH\"\n }\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "1:1 face match (selfie vs document)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "1:1 face match (selfie vs document). Returns similarity 0-1 + verdict + quality.", "url": { "raw": "{{base_url}}/v1/face/match", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "match" ] }, "body": { "mode": "raw", "raw": "{\n \"image_a_b64\": \"\",\n \"image_b_b64\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"similarity\": 0.87,\n \"verdict\": \"MATCH\",\n \"quality_selfie\": {\n \"face_px\": 120,\n \"blur_var\": 210.5,\n \"det_score\": 0.91\n },\n \"quality_doc\": {\n \"face_px\": 96,\n \"blur_var\": 180.2,\n \"det_score\": 0.88\n }\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Create a hosted keyless capture session (Digio/Persona pattern)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Create a hosted keyless capture session (Digio/Persona pattern). Returns a session id + a capture URL the end-user opens on their phone.", "url": { "raw": "{{base_url}}/v1/face/session", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "session" ] }, "body": { "mode": "raw", "raw": "{\n \"reference_id\": \"cust-12345\",\n \"reference_image_b64\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"session_id\": \"sess_ab12cd\",\n \"capture_url\": \"https://api.kyc.ezfinanz.com/capture?sid=sess_ab12cd\",\n \"expires_in\": 900\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Get a capture session's status + result (verdict, liveness, match)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Get a capture session's status + result (verdict, liveness, match).", "url": { "raw": "{{base_url}}/v1/face/session/{sid}", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "session", "{sid}" ] } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"session_id\": \"sess_ab12cd\",\n \"status\": \"completed\",\n \"verdict\": \"PASS\"\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] }, { "name": "Fetch the captured photo for a completed session (image bytes)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Fetch the captured photo for a completed session (image bytes).", "url": { "raw": "{{base_url}}/v1/face/session/{sid}/photo", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "session", "{sid}", "photo" ] } }, "response": [] }, { "name": "Composite KYC check: face match + liveness + quality in one call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Composite KYC check: face match + liveness + quality in one call.", "url": { "raw": "{{base_url}}/v1/face/verify", "host": [ "{{base_url}}" ], "path": [ "v1", "face", "verify" ] }, "body": { "mode": "raw", "raw": "{\n \"selfie_b64\": \"\",\n \"doc_photo_b64\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"verdict\": \"PASS\",\n \"match\": {\n \"similarity\": 0.87,\n \"verdict\": \"MATCH\"\n },\n \"liveness\": {\n \"live\": true,\n \"score\": 0.82\n }\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] } ] }, { "name": "Status", "description": "Public service health.", "item": [ { "name": "Live health of every service", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-API-Key", "value": "{{api_key}}" } ], "description": "Live health of every service. Public, no auth.", "url": { "raw": "{{base_url}}/v1/status", "host": [ "{{base_url}}" ], "path": [ "v1", "status" ] } }, "response": [ { "name": "200 OK", "originalRequest": {}, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"data\": {\n \"overall\": \"ok\",\n \"services\": [\n {\n \"service\": \"aadhaar-mask\",\n \"status\": \"ok\"\n }\n ]\n },\n \"request_id\": \"\\u2026\",\n \"took_ms\": 123\n}" } ] } ] } ] }