{ "info": { "name": "emver API", "_postman_id": "191fa390-f088-443e-91f0-06f3597a8d95", "description": "Every emver verification API. Set the {{api_key}} variable to your API key. {{base_url}} points at the sandbox; switch it to {{production_url}} for live, billed calls.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "emver" }, "item": [ { "name": "Workforce & Assets", "item": [ { "name": "UAN Advanced", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uan_advanced_uan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/uan-advanced", "host": [ "{{base_url}}" ], "path": [ "v1", "uan-advanced" ] }, "description": "Retrieve a candidate's emver history from provident fund records using their UAN.\n\n**Request Fields**\n- `uan_advanced_uan_number` \u2014 UAN Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"data\": {\n \"pan_number\": \"string\",\n \"pan_status\": \"string\",\n \"remarks\": \"string\"\n }\n}" } ] }, { "name": "UAN Advanced (PDF)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uan_advanced_uan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/uan-advanced-pdf", "host": [ "{{base_url}}" ], "path": [ "v1", "uan-advanced-pdf" ] }, "description": "**Request Fields**\n- `uan_advanced_uan_number` \u2014 UAN Number (string) *(required)*\n\n**Answers with a PDF document**\nThe 200 body carries the file inline as `report.base64` \u2014 decode it and save it as `report.filename`; no second call is needed. `report_url` is optional: GET it with the same API key (see the *Requests* folder) to download the raw file at any time within 72 hours (`report.expires_at`); after that it answers 410. A negative outcome (no record) is a plain `{status, message}` body without a `report` block.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"report_url\": \"string\",\n \"report\": {\n \"format\": \"string\",\n \"mime\": \"string\",\n \"filename\": \"string\",\n \"size\": 200,\n \"url\": \"string\",\n \"expires_at\": \"string\",\n \"base64\": \"string\"\n }\n}" } ] }, { "name": "Uan Check (v2)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/uan-check-v2", "host": [ "{{base_url}}" ], "path": [ "v1", "uan-check-v2" ] }, "description": "Retrieve a candidate's emver history from provident fund records using their UAN.\n\n**Request Fields**\n- `uan_number` \u2014 UAN Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"data\": {\n \"uan_number\": \"string\",\n \"message\": \"string\"\n }\n}" } ] }, { "name": "ICAI Membership Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"i_c_a_i_membership_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/icai-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "icai-verification" ] }, "description": "Confirm a Chartered Accountant's membership number, status and type.\n\n**Request Fields**\n- `i_c_a_i_membership_number` \u2014 ICAI membership number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"member_name\": \"string\",\n \"membership_status\": \"string\",\n \"membership_type\": \"string\"\n }\n}" } ] }, { "name": "Vehicle RC Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"vehicle_registration_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/rc-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "rc-verification" ] }, "description": "Verify a vehicle registration and its owner from the national vehicle registry.\n\n**Request Fields**\n- `vehicle_registration_number` \u2014 Vehicle registration number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"owner_name\": \"string\",\n \"make_and_model\": \"string\",\n \"registration_date\": \"string\",\n \"fuel_type\": \"string\"\n }\n}" } ] }, { "name": "Vehicle Challan Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"vehicle_registration_number_or_d_l_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/vehicle-challan", "host": [ "{{base_url}}" ], "path": [ "v1", "vehicle-challan" ] }, "description": "Pending and paid traffic challans for a vehicle or driving licence.\n\n**Request Fields**\n- `vehicle_registration_number_or_d_l_number` \u2014 Vehicle registration number or DL number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"list_of_challans_with_date_and_offence\": \"string\",\n \"amount_and_payment_status\": \"string\",\n \"issuing_authority\": \"string\",\n \"total_pending_amount\": \"string\"\n }\n}" } ] }, { "name": "Dual emver Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"u_a_n_number\": \"string\",\n \"current_employer_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/dual-employment-check", "host": [ "{{base_url}}" ], "path": [ "v1", "dual-employment-check" ] }, "description": "Detect concurrent emver from overlapping provident fund contributions.\n\n**Request Fields**\n- `u_a_n_number` \u2014 UAN number (string) *(required)*\n- `current_employer_name` \u2014 Current employer name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"dual_employment_detected\": \"string\",\n \"overlapping_periods\": \"string\",\n \"establishments_involved\": \"string\",\n \"current_active_establishments\": \"string\"\n }\n}" } ] }, { "name": "Employer Establishment Search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employer_name_or_establishment_code\": \"string\",\n \"city_or_state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/employer-search", "host": [ "{{base_url}}" ], "path": [ "v1", "employer-search" ] }, "description": "Find a company's provident fund establishment record and confirm it is a real employer.\n\n**Request Fields**\n- `employer_name_or_establishment_code` \u2014 Employer name or establishment code (string) *(required)*\n- `city_or_state` \u2014 City or state (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"matching_establishments\": \"string\",\n \"establishment_i_d_and_registration_date\": \"string\",\n \"registered_address\": \"string\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "ESIC Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"e_s_i_c_insurance_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/esic-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "esic-verification" ] }, "description": "Confirm an employee's state insurance registration and the employer behind it.\n\n**Request Fields**\n- `e_s_i_c_insurance_number` \u2014 ESIC insurance number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"insured_person_s_name\": \"string\",\n \"registration_date\": \"string\",\n \"employer_name_and_code\": \"string\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "Education Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"candidate_name_and_date_of_birth\": \"string\",\n \"institution_degree_and_year\": \"string\",\n \"certificate_or_roll_number\": \"string\",\n \"certificate_image\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/education-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "education-verification" ] }, "description": "Confirm degrees and diplomas with the issuing university or through the national credential repository.\n\n**Request Fields**\n- `candidate_name_and_date_of_birth` \u2014 Candidate name and date of birth (string) *(required)*\n- `institution_degree_and_year` \u2014 Institution, degree and year (string) *(required)*\n- `certificate_or_roll_number` \u2014 Certificate or roll number (string)\n- `certificate_image` \u2014 Certificate image (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"verification_outcome\": \"string\",\n \"degree__specialisation_and_year\": \"string\",\n \"institution_confirmation\": \"string\",\n \"result_or_class\": \"string\",\n \"evidence_reference\": \"string\"\n }\n}" } ] }, { "name": "FASTag Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registration_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/fastag-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "fastag-verification" ] }, "description": "Confirm a vehicle's FASTag status and issuing bank from its registration number.\n\n**Request Fields**\n- `registration_number` \u2014 Vehicle registration number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"tag_active\": true,\n \"issuer_bank\": \"string\",\n \"tag_class\": \"string\",\n \"tag_id\": \"string\"\n }\n}" } ] }, { "name": "Vehicle Insurance Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registration_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/vehicle-insurance-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "vehicle-insurance-verification" ] }, "description": "Confirm a vehicle is insured, by whom and until when.\n\n**Request Fields**\n- `registration_number` \u2014 Vehicle registration number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"insured\": true,\n \"insurer\": \"string\",\n \"policy_number\": \"string\",\n \"cover_type\": \"string\",\n \"valid_until\": \"YYYY-MM-DD\"\n }\n}" } ] }, { "name": "National Permit Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registration_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/national-permit-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "national-permit-verification" ] }, "description": "Validate a commercial vehicle's national permit and its validity period.\n\n**Request Fields**\n- `registration_number` \u2014 Vehicle registration number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"permit_valid\": true,\n \"permit_type\": \"string\",\n \"permit_number\": \"string\",\n \"issuing_authority\": \"string\",\n \"valid_until\": \"YYYY-MM-DD\"\n }\n}" } ] }, { "name": "Income Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pan_number\": \"string\",\n \"mobile\": \"9999999999\",\n \"declared_income\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/income-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "income-verification" ] }, "description": "Verify declared income from tax filings and salary credits with the person's consent.\n\n**Request Fields**\n- `pan_number` \u2014 PAN (string) *(required)*\n- `mobile` \u2014 Mobile (for consent) (phone) *(required)*\n- `declared_income` \u2014 Declared annual income (number)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"estimated_income\": 0,\n \"income_band\": \"string\",\n \"sources\": [],\n \"declared_match\": true,\n \"confidence\": 0\n }\n}" } ] }, { "name": "Form 16 Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"form16\": \"\",\n \"pan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/form-16-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "form-16-verification" ] }, "description": "Validate a Form 16 against the TDS records it claims to reflect.\n\n**Request Fields**\n- `form16` \u2014 Form 16 PDF (file) *(required)*\n- `pan_number` \u2014 Employee PAN (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"genuine\": true,\n \"employer_name\": \"string\",\n \"employer_tan\": \"string\",\n \"assessment_year\": \"string\",\n \"gross_salary\": 0,\n \"tds_deducted\": 0,\n \"discrepancies\": []\n }\n}" } ] }, { "name": "UAN Lookup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile\": \"9999999999\",\n \"pan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/uan-lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "uan-lookup" ] }, "description": "Find a person's Universal Account Number from their mobile or PAN.\n\n**Request Fields**\n- `mobile` \u2014 Mobile number (phone)\n- `pan_number` \u2014 PAN (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"uans\": [],\n \"name\": \"string\"\n }\n}" } ] }, { "name": "ICSI Membership Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"membership_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/icsi-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "icsi-verification" ] }, "description": "Verify a Company Secretary's membership with the Institute of Company Secretaries of India.\n\n**Request Fields**\n- `membership_number` \u2014 ICSI membership number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"member_name\": \"string\",\n \"membership_type\": \"string\",\n \"practice_status\": \"string\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "emver Verification (Employer Confirmation)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"candidate_name\": \"string\",\n \"employer_name\": \"string\",\n \"employee_id\": \"string\",\n \"from_date\": \"YYYY-MM-DD\",\n \"to_date\": \"YYYY-MM-DD\",\n \"designation\": \"string\",\n \"documents\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/employment-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "employment-verification" ] }, "description": "Direct confirmation of tenure, designation and exit reason from the previous employer.\n\n**Request Fields**\n- `candidate_name` \u2014 Candidate name (string) *(required)*\n- `employer_name` \u2014 Employer name (string) *(required)*\n- `employee_id` \u2014 Employee ID (string)\n- `from_date` \u2014 Tenure from (date) *(required)*\n- `to_date` \u2014 Tenure to (date)\n- `designation` \u2014 Designation (string)\n- `documents` \u2014 Supporting documents (file)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"request_id\": \"string\",\n \"status\": \"string\",\n \"tenure_confirmed\": true,\n \"designation_confirmed\": true,\n \"exit_reason\": \"string\",\n \"eligible_for_rehire\": true,\n \"report_url\": \"string\"\n }\n}" } ] } ] }, { "name": "Banking & Credit", "item": [ { "name": "Bank Account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_number\": \"string\",\n \"bank_ifsc\": \"string\",\n \"bank_holder_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/bank-account", "host": [ "{{base_url}}" ], "path": [ "v1", "bank-account" ] }, "description": "Verifies a bank account number and IFSC in real time and returns the account holder name with optional name-match score.\n\n**Request Fields**\n- `bank_account_number` \u2014 Account Number (string) *(required)*\n- `bank_ifsc` \u2014 IFSC Code (string) *(required)*\n- `bank_holder_name` \u2014 Account Holder Name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "CIBIL Transunion NEE V2 (PDF)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pan_card_number\": \"string\",\n \"phone_number\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v2/cibil-transunion-nee-v2-pdf", "host": [ "{{base_url}}" ], "path": [ "v2", "cibil-transunion-nee-v2-pdf" ] }, "description": "Reviews an individual\u2019s credit history using a TransUnion CIBIL credit report obtained through an authorized process. The check covers the available credit score, loan and credit card accounts, repayment history, outstanding balances and reported adverse account statuses. Processing is subject to the individual\u2019s consent, permitted purpose and applicable access requirements.\n\n**Request Fields**\n- `pan_card_number` \u2014 PAN Card Number (string) *(required)*\n- `phone_number` \u2014 Mobile Number (phone) *(required)*\n\n**Answers with a PDF document**\nThe 200 body carries the file inline as `report.base64` \u2014 decode it and save it as `report.filename`; no second call is needed. `report_url` is optional: GET it with the same API key (see the *Requests* folder) to download the raw file at any time within 72 hours (`report.expires_at`); after that it answers 410. A negative outcome (no record) is a plain `{status, message}` body without a `report` block.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"message\": \"string\",\n \"report_url\": \"string\",\n \"report\": {\n \"format\": \"string\",\n \"mime\": \"string\",\n \"filename\": \"string\",\n \"size\": 200,\n \"url\": \"string\",\n \"expires_at\": \"string\",\n \"base64\": \"string\"\n }\n}" } ] }, { "name": "CIBIL Transunion V2 (PDF)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pan_card_number\": \"string\",\n \"phone_number\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v2/cibil-transunion-v2-pdf", "host": [ "{{base_url}}" ], "path": [ "v2", "cibil-transunion-v2-pdf" ] }, "description": "Reviews an individual\u2019s credit history using a TransUnion CIBIL credit report obtained through an authorized process. The check covers the available credit score, loan and credit card accounts, repayment history, outstanding balances and reported adverse account statuses. Processing is subject to the individual\u2019s consent, permitted purpose and applicable access requirements.\n\n**Request Fields**\n- `pan_card_number` \u2014 PAN Card Number (string) *(required)*\n- `phone_number` \u2014 Mobile Number (phone) *(required)*\n\n**Answers with a PDF document**\nThe 200 body carries the file inline as `report.base64` \u2014 decode it and save it as `report.filename`; no second call is needed. `report_url` is optional: GET it with the same API key (see the *Requests* folder) to download the raw file at any time within 72 hours (`report.expires_at`); after that it answers 410. A negative outcome (no record) is a plain `{status, message}` body without a `report` block.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"message\": \"string\",\n \"report_url\": \"string\",\n \"report\": {\n \"format\": \"string\",\n \"mime\": \"string\",\n \"filename\": \"string\",\n \"size\": 200,\n \"url\": \"string\",\n \"expires_at\": \"string\",\n \"base64\": \"string\"\n }\n}" } ] }, { "name": "UPI", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"upi_vpa\": \"string\",\n \"upi_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/upi", "host": [ "{{base_url}}" ], "path": [ "v1", "upi" ] }, "description": "Verifies a UPI ID / VPA and returns the linked account holder name, with optional name match against the supplied name.\n\n**Request Fields**\n- `upi_vpa` \u2014 UPI ID / VPA (string) *(required)*\n- `upi_name` \u2014 Name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Bank Account Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_number\": \"string\",\n \"i_f_s_c_code\": \"string\",\n \"account_holder_name\": \"string\",\n \"p_a_n_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/bank-account-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "bank-account-verification" ] }, "description": "Confirm an account exists and belongs to the person or emver you are paying.\n\n**Request Fields**\n- `account_number` \u2014 Account number (string) *(required)*\n- `i_f_s_c_code` \u2014 IFSC code (string) *(required)*\n- `account_holder_name` \u2014 Account holder name (string)\n- `p_a_n_number` \u2014 PAN number (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"account_exists\": \"string\",\n \"name_as_per_bank\": \"string\",\n \"name_match_result\": \"string\",\n \"bank_name\": \"string\"\n }\n}" } ] }, { "name": "UPI Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"u_p_i_i_d_v_p_a\": \"string\",\n \"name_to_match\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/upi-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "upi-verification" ] }, "description": "Resolve a UPI ID to its registered account holder and match the name.\n\n**Request Fields**\n- `u_p_i_i_d_v_p_a` \u2014 UPI ID (VPA) (string) *(required)*\n- `name_to_match` \u2014 Name to match (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"account_holder_name\": \"string\",\n \"name_match_result\": \"string\"\n }\n}" } ] }, { "name": "Credit Report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"p_a_n_number\": \"string\",\n \"full_name\": \"string\",\n \"registered_mobile\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/credit-report", "host": [ "{{base_url}}" ], "path": [ "v1", "credit-report" ] }, "description": "Consent-based credit score and report for lending and financial-role screening.\n\n**Request Fields**\n- `p_a_n_number` \u2014 PAN number (string) *(required)*\n- `full_name` \u2014 Full name (string) *(required)*\n- `registered_mobile` \u2014 Registered mobile (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"credit_score\": \"string\",\n \"registered_name\": \"string\",\n \"full_credit_report\": \"string\"\n }\n}" } ] }, { "name": "IFSC & Bank Branch Lookup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"i_f_s_c_code\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/ifsc-lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "ifsc-lookup" ] }, "description": "Resolve an IFSC to its bank, branch, address and supported payment rails.\n\n**Request Fields**\n- `i_f_s_c_code` \u2014 IFSC code (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"bank_name\": \"string\",\n \"branch_name_and_address\": \"string\",\n \"city_and_state\": \"string\",\n \"supported_rails\": \"string\",\n \"contact_details\": \"string\"\n }\n}" } ] }, { "name": "Reverse Penny Drop", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"person_s_reference_for_the_payment_link\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/reverse-penny-drop", "host": [ "{{base_url}}" ], "path": [ "v1", "reverse-penny-drop" ] }, "description": "Verify bank account ownership by having the person pay one rupee via UPI.\n\n**Request Fields**\n- `person_s_reference_for_the_payment_link` \u2014 Person's reference for the payment link (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"account_number_and_i_f_s_c_as_seen_by_the_bank\": \"string\",\n \"account_holder_name\": \"string\",\n \"u_p_i_i_d_used\": \"string\",\n \"verification_status\": \"string\",\n \"refund_status\": \"string\"\n }\n}" } ] }, { "name": "Bank Statement Analysis", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"statement_p_d_fs_with_password_if_protected\": \"string\",\n \"consent_reference_for_account_aggregator_fetch\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/bank-statement-analysis", "host": [ "{{base_url}}" ], "path": [ "v1", "bank-statement-analysis" ] }, "description": "Turn PDF statements into categorised transactions, income and risk indicators.\n\n**Request Fields**\n- `statement_p_d_fs_with_password_if_protected` \u2014 Statement PDFs (with password if protected) (string) *(required)*\n- `consent_reference_for_account_aggregator_fetch` \u2014 Consent reference for account-aggregator fetch (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"parsed_transactions\": \"string\",\n \"categorised_inflows_and_outflows\": \"string\",\n \"detected_salary_credits_and_employer\": \"string\",\n \"e_m_i_and_loan_obligations\": \"string\",\n \"bounces_and_penalties\": \"string\",\n \"average_and_minimum_balances\": \"string\",\n \"tamper_check_result\": \"string\"\n }\n}" } ] }, { "name": "emver Credit Report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entity_p_a_n_or_c_i_n\": \"string\",\n \"entity_name_and_address\": \"string\",\n \"authorised_signatory_consent\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/business-credit-report", "host": [ "{{base_url}}" ], "path": [ "v1", "business-credit-report" ] }, "description": "Commercial bureau report and score for a company or proprietorship.\n\n**Request Fields**\n- `entity_p_a_n_or_c_i_n` \u2014 Entity PAN or CIN (string) *(required)*\n- `entity_name_and_address` \u2014 Entity name and address (string) *(required)*\n- `authorised_signatory_consent` \u2014 Authorised signatory consent (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"commercial_credit_score\": \"string\",\n \"credit_facilities_and_outstanding\": \"string\",\n \"repayment_history_and_overdues\": \"string\",\n \"suits_and_defaults\": \"string\",\n \"recent_enquiries\": \"string\",\n \"full_report\": \"string\"\n }\n}" } ] }, { "name": "Bank Account Verification (Penny-less)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_number\": \"string\",\n \"ifsc\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/bank-account-pennyless", "host": [ "{{base_url}}" ], "path": [ "v1", "bank-account-pennyless" ] }, "description": "Confirm an account and holder name without moving any money.\n\n**Request Fields**\n- `account_number` \u2014 Account number (string) *(required)*\n- `ifsc` \u2014 IFSC (string) *(required)*\n- `name` \u2014 Name to match (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"account_exists\": true,\n \"account_holder\": \"string\",\n \"name_match_score\": 0,\n \"method\": \"string\"\n }\n}" } ] }, { "name": "Account Aggregator Data Fetch", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile\": \"9999999999\",\n \"purpose\": \"string\",\n \"from_date\": \"YYYY-MM-DD\",\n \"to_date\": \"YYYY-MM-DD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/account-aggregator", "host": [ "{{base_url}}" ], "path": [ "v1", "account-aggregator" ] }, "description": "Consented bank statements and financial data through the Account Aggregator framework.\n\n**Request Fields**\n- `mobile` \u2014 Customer mobile (phone) *(required)*\n- `purpose` \u2014 Purpose code (string) *(required)*\n- `from_date` \u2014 Data from (date) *(required)*\n- `to_date` \u2014 Data to (date) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"consent_id\": \"string\",\n \"consent_status\": \"string\",\n \"accounts\": [],\n \"transactions\": []\n }\n}" } ] }, { "name": "e-NACH Mandate Registration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_number\": \"string\",\n \"ifsc\": \"string\",\n \"amount\": 0,\n \"frequency\": \"string\",\n \"start_date\": \"YYYY-MM-DD\",\n \"end_date\": \"YYYY-MM-DD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/enach-mandate", "host": [ "{{base_url}}" ], "path": [ "v1", "enach-mandate" ] }, "description": "Register recurring debit mandates digitally with net-banking, debit-card or Aadhaar authentication.\n\n**Request Fields**\n- `account_number` \u2014 Account number (string) *(required)*\n- `ifsc` \u2014 IFSC (string) *(required)*\n- `amount` \u2014 Maximum amount (number) *(required)*\n- `frequency` \u2014 Frequency (string) *(required)*\n- `start_date` \u2014 Start date (date) *(required)*\n- `end_date` \u2014 End date (date)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"mandate_id\": \"string\",\n \"authentication_url\": \"string\",\n \"status\": \"string\",\n \"umrn\": \"string\"\n }\n}" } ] } ] }, { "name": "Identity & KYC", "item": [ { "name": "Aadhaar Check (Without OTP)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"aadhaar_api_without_otp_aadhaar_number\": 0,\n \"consent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/aadhaar-api-without-otp", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar-api-without-otp" ] }, "description": "Validates an Aadhaar number against UIDAI records and returns demographic details of the holder (age range, gender, state, mobile-linkage status). Non-OTP \u2014 no consent/OTP flow required.\n\n**Request Fields**\n- `aadhaar_api_without_otp_aadhaar_number` \u2014 Aadhaar Number (number) *(required)*\n- `consent` \u2014 Consent of the person (boolean) *(required)*\n\n**Consent required**\nCollect the consent of the person being verified to: \"I hereby provide consent for Aadhaar-based KYC verification as per UIDAI guidelines.\" and send `consent: true` (or `\"Y\"`) with the call. A call without consent is refused with 422 `consent_required`, before anything is billed. `consent: false` is refused with 422 `consent_declined`.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "CIBIL Transunion", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"9999999999\",\n \"dob\": \"YYYY-MM-DD\",\n \"gender\": \"Male\",\n \"pan_card_number\": \"string\",\n \"consent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/cibil-transunion", "host": [ "{{base_url}}" ], "path": [ "v1", "cibil-transunion" ] }, "description": "Reviews an individual\u2019s credit history using a TransUnion CIBIL credit report obtained through an authorized process. The check covers the available credit score, loan and credit card accounts, repayment history, outstanding balances and reported adverse account statuses. Processing is subject to the individual\u2019s consent, permitted purpose and applicable access requirements.\n\n**Request Fields**\n- `first_name` \u2014 First Name (string) *(required)*\n- `last_name` \u2014 Last Name (string) *(required)*\n- `phone_number` \u2014 Phone Number (phone) *(required)*\n- `dob` \u2014 Date of Birth (date) *(required)*\n- `gender` \u2014 Gender (enum) *(required)*\n- `pan_card_number` \u2014 PAN Card Number (string) *(required)*\n- `consent` \u2014 Consent of the person (boolean) *(required)*\n\n**Consent required**\nCollect the consent of the person being verified to: \"I confirm the customer has given consent for a credit check.\" and send `consent: true` (or `\"Y\"`) with the call. A call without consent is refused with 422 `consent_required`, before anything is billed. `consent: false` is refused with 422 `consent_declined`.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"message\": \"string\",\n \"reference_id\": \"string\"\n}" } ] }, { "name": "CIBIL Transunion - NEE (PDF)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"9999999999\",\n \"dob\": \"YYYY-MM-DD\",\n \"gender\": \"Male\",\n \"pan_card_number\": \"string\",\n \"consent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/cibil-transunion-nee-pdf", "host": [ "{{base_url}}" ], "path": [ "v1", "cibil-transunion-nee-pdf" ] }, "description": "Reviews an individual\u2019s credit history using a TransUnion CIBIL credit report obtained through an authorized process. The check covers the available credit score, loan and credit card accounts, repayment history, outstanding balances and reported adverse account statuses. Processing is subject to the individual\u2019s consent, permitted purpose and applicable access requirements.\n\n**Request Fields**\n- `first_name` \u2014 First Name (string) *(required)*\n- `last_name` \u2014 Last Name (string) *(required)*\n- `phone_number` \u2014 Phone Number (phone) *(required)*\n- `dob` \u2014 Date of Birth (date) *(required)*\n- `gender` \u2014 Gender (enum) *(required)*\n- `pan_card_number` \u2014 PAN Card Number (string) *(required)*\n- `consent` \u2014 Consent of the person (boolean) *(required)*\n\n**Consent required**\nCollect the consent of the person being verified to: \"I confirm the customer has given consent for a credit check.\" and send `consent: true` (or `\"Y\"`) with the call. A call without consent is refused with 422 `consent_required`, before anything is billed. `consent: false` is refused with 422 `consent_declined`.\n\n**Answers with a PDF document**\nThe 200 body carries the file inline as `report.base64` \u2014 decode it and save it as `report.filename`; no second call is needed. `report_url` is optional: GET it with the same API key (see the *Requests* folder) to download the raw file at any time within 72 hours (`report.expires_at`); after that it answers 410. A negative outcome (no record) is a plain `{status, message}` body without a `report` block.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"message\": \"string\",\n \"report_url\": \"string\",\n \"report\": {\n \"format\": \"string\",\n \"mime\": \"string\",\n \"filename\": \"string\",\n \"size\": 200,\n \"url\": \"string\",\n \"expires_at\": \"string\",\n \"base64\": \"string\"\n }\n}" } ] }, { "name": "CIBIL Transunion (PDF V2)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"9999999999\",\n \"dob\": \"YYYY-MM-DD\",\n \"gender\": \"Male\",\n \"pan_card_number\": \"string\",\n \"consent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/cibil-transunion-pdf-v2", "host": [ "{{base_url}}" ], "path": [ "v1", "cibil-transunion-pdf-v2" ] }, "description": "Reviews an individual\u2019s credit history using a TransUnion CIBIL credit report obtained through an authorized process. The check covers the available credit score, loan and credit card accounts, repayment history, outstanding balances and reported adverse account statuses. Processing is subject to the individual\u2019s consent, permitted purpose and applicable access requirements.\n\n**Request Fields**\n- `first_name` \u2014 First Name (string) *(required)*\n- `last_name` \u2014 Last Name (string) *(required)*\n- `phone_number` \u2014 Phone Number (phone) *(required)*\n- `dob` \u2014 Date of Birth (date) *(required)*\n- `gender` \u2014 Gender (enum) *(required)*\n- `pan_card_number` \u2014 PAN Card Number (string) *(required)*\n- `consent` \u2014 Consent of the person (boolean) *(required)*\n\n**Consent required**\nCollect the consent of the person being verified to: \"I confirm the customer has given consent for a credit check.\" and send `consent: true` (or `\"Y\"`) with the call. A call without consent is refused with 422 `consent_required`, before anything is billed. `consent: false` is refused with 422 `consent_declined`.\n\n**Answers with a PDF document**\nThe 200 body carries the file inline as `report.base64` \u2014 decode it and save it as `report.filename`; no second call is needed. `report_url` is optional: GET it with the same API key (see the *Requests* folder) to download the raw file at any time within 72 hours (`report.expires_at`); after that it answers 410. A negative outcome (no record) is a plain `{status, message}` body without a `report` block.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"message\": \"string\",\n \"report_url\": \"string\",\n \"report\": {\n \"format\": \"string\",\n \"mime\": \"string\",\n \"filename\": \"string\",\n \"size\": 200,\n \"url\": \"string\",\n \"expires_at\": \"string\",\n \"base64\": \"string\"\n }\n}" } ] }, { "name": "CIBIL Transunion (PDF)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"9999999999\",\n \"dob\": \"YYYY-MM-DD\",\n \"gender\": \"Male\",\n \"pan_card_number\": \"string\",\n \"consent\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/cibil-transunion-pdf", "host": [ "{{base_url}}" ], "path": [ "v1", "cibil-transunion-pdf" ] }, "description": "Reviews an individual\u2019s credit history using a TransUnion CIBIL credit report obtained through an authorized process. The check covers the available credit score, loan and credit card accounts, repayment history, outstanding balances and reported adverse account statuses. Processing is subject to the individual\u2019s consent, permitted purpose and applicable access requirements.\n\n**Request Fields**\n- `first_name` \u2014 First Name (string) *(required)*\n- `last_name` \u2014 Last Name (string) *(required)*\n- `phone_number` \u2014 Phone Number (phone) *(required)*\n- `dob` \u2014 Date of Birth (date) *(required)*\n- `gender` \u2014 Gender (enum) *(required)*\n- `pan_card_number` \u2014 PAN Card Number (string) *(required)*\n- `consent` \u2014 Consent of the person (boolean) *(required)*\n\n**Consent required**\nCollect the consent of the person being verified to: \"I confirm the customer has given consent for a credit check.\" and send `consent: true` (or `\"Y\"`) with the call. A call without consent is refused with 422 `consent_required`, before anything is billed. `consent: false` is refused with 422 `consent_declined`.\n\n**Answers with a PDF document**\nThe 200 body carries the file inline as `report.base64` \u2014 decode it and save it as `report.filename`; no second call is needed. `report_url` is optional: GET it with the same API key (see the *Requests* folder) to download the raw file at any time within 72 hours (`report.expires_at`); after that it answers 410. A negative outcome (no record) is a plain `{status, message}` body without a `report` block.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"message\": \"string\",\n \"report_url\": \"string\",\n \"report\": {\n \"format\": \"string\",\n \"mime\": \"string\",\n \"filename\": \"string\",\n \"size\": 200,\n \"url\": \"string\",\n \"expires_at\": \"string\",\n \"base64\": \"string\"\n }\n}" } ] }, { "name": "DigiLocker", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input_field\": \"value\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/digilocker", "host": [ "{{base_url}}" ], "path": [ "v1", "digilocker" ] }, "description": "Consent-based document & identity verification (Aadhaar/PAN/DL) via DigiLocker. Generate a candidate consent link; verified documents + eKYC return to the case.\n\nThis API starts a consent flow in the person's browser rather than answering a single request. Contact emver for the integration guide.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": \"object\"\n}" } ] }, { "name": "Digilocker", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"digilocker_mobile\": \"9999999999\",\n \"digilocker_first_name\": \"string\",\n \"digilocker_last_name\": \"string\",\n \"digilocker_email\": \"name@example.com\",\n \"digilocker_redirect_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/digilocker-kyc", "host": [ "{{base_url}}" ], "path": [ "v1", "digilocker-kyc" ] }, "description": "Step 1 of DigiLocker KYC - generates a consent link for the customer to sign in to DigiLocker and share documents. Use the returned transaction_id with the Digilocker Fetch Details API.\n\n**Request Fields**\n- `digilocker_mobile` \u2014 Mobile Number (string) *(required)*\n- `digilocker_first_name` \u2014 First Name (string)\n- `digilocker_last_name` \u2014 Last Name (string)\n- `digilocker_email` \u2014 Email (string)\n- `digilocker_redirect_url` \u2014 Redirect URL (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Digilocker Fetch Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"digilocker_transaction_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/digilocker-fetch-details", "host": [ "{{base_url}}" ], "path": [ "v1", "digilocker-fetch-details" ] }, "description": "Step 2 of DigiLocker KYC - after the customer completes consent, fetches the verified Aadhaar e-KYC details using the transaction_id returned by the Digilocker API.\n\n**Request Fields**\n- `digilocker_transaction_id` \u2014 Transaction ID (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Driving License", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dl_number\": \"string\",\n \"dl_dob\": \"YYYY-MM-DD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/driving-license", "host": [ "{{base_url}}" ], "path": [ "v1", "driving-license" ] }, "description": "Verifies a Driving Licence number with date of birth against RTO records and returns holder, validity, address and vehicle class details.\n\n**Request Fields**\n- `dl_number` \u2014 DL Number (string) *(required)*\n- `dl_dob` \u2014 Date of Birth (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Driving License V2 (DL Validation Plus)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dl_v2_dl_number\": \"string\",\n \"dl_v2_dob\": \"YYYY-MM-DD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/driving-license-v2", "host": [ "{{base_url}}" ], "path": [ "v1", "driving-license-v2" ] }, "description": "DL Validation Plus - enhanced Driving Licence verification returning holder photo, blood group, expiry, status details and vehicle-category wise validity.\n\n**Request Fields**\n- `dl_v2_dl_number` \u2014 DL Number (string) *(required)*\n- `dl_v2_dob` \u2014 Date of Birth (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Pan Basic", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pan_api_detail_pan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/pan-basic", "host": [ "{{base_url}}" ], "path": [ "v1", "pan-basic" ] }, "description": "Validate a PAN, match the name and confirm it is active with the tax department.\n\n**Request Fields**\n- `pan_api_detail_pan_number` \u2014 Pan Number (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Pan Detail", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pan_api_detail_pan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/pan-aetail", "host": [ "{{base_url}}" ], "path": [ "v1", "pan-aetail" ] }, "description": "Validates PAN against Income Tax Department records via emver. Checks name, DOB, and PAN status.\n\n**Request Fields**\n- `pan_api_detail_pan_number` \u2014 Pan Number (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"data\": {\n \"pan_number\": \"string\",\n \"pan_status\": \"string\",\n \"remarks\": \"string\"\n }\n}" } ] }, { "name": "Passport", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"passport_file_number\": \"string\",\n \"passport_dob\": \"YYYY-MM-DD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/passport", "host": [ "{{base_url}}" ], "path": [ "v1", "passport" ] }, "description": "Verifies a passport using the application file number and date of birth and returns passport number, holder name and application/dispatch dates.\n\n**Request Fields**\n- `passport_file_number` \u2014 Passport File Number (string) *(required)*\n- `passport_dob` \u2014 Date of Birth (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "UAN Check (v3)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uan_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/uan-check-v3", "host": [ "{{base_url}}" ], "path": [ "v1", "uan-check-v3" ] }, "description": "**Request Fields**\n- `uan_number` \u2014 UAN Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"string\"\n }\n}" } ] }, { "name": "Voter ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"voter_id_epic_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/voter-id", "host": [ "{{base_url}}" ], "path": [ "v1", "voter-id" ] }, "description": "Verifies a Voter ID (EPIC) number against Election Commission records and returns voter, constituency and polling station details.\n\n**Request Fields**\n- `voter_id_epic_number` \u2014 EPIC Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "PAN-Aadhaar Link Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"p_a_n_number\": \"string\",\n \"aadhaar_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/pan-aadhaar-link", "host": [ "{{base_url}}" ], "path": [ "v1", "pan-aadhaar-link" ] }, "description": "Confirm a PAN is seeded with the given Aadhaar.\n\n**Request Fields**\n- `p_a_n_number` \u2014 PAN number (string) *(required)*\n- `aadhaar_number` \u2014 Aadhaar number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"link_status\": \"string\",\n \"masked_p_a_n\": \"string\",\n \"reason_when_not_linked\": \"string\"\n }\n}" } ] }, { "name": "Passport Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"passport_number\": \"string\",\n \"date_of_birth\": \"string\",\n \"full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/passport-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "passport-verification" ] }, "description": "Verify Indian passport details against official records.\n\n**Request Fields**\n- `passport_number` \u2014 Passport number (string) *(required)*\n- `date_of_birth` \u2014 Date of birth (string) *(required)*\n- `full_name` \u2014 Full name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"verification_status\": \"string\",\n \"registered_name\": \"string\",\n \"passport_number_confirmation\": \"string\",\n \"date_of_birth\": \"string\",\n \"date_of_application\": \"string\"\n }\n}" } ] }, { "name": "Driving Licence Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"driving_licence_number\": \"string\",\n \"date_of_birth\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/driving-license-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "driving-license-verification" ] }, "description": "Confirm a driving licence is valid, current and permits the right vehicle class.\n\n**Request Fields**\n- `driving_licence_number` \u2014 Driving licence number (string) *(required)*\n- `date_of_birth` \u2014 Date of birth (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"verification_status\": \"string\",\n \"registered_name\": \"string\",\n \"issuing_state\": \"string\",\n \"valid_until\": \"string\",\n \"permitted_vehicle_classes\": \"string\"\n }\n}" } ] }, { "name": "Voter ID Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"voter_i_d_e_p_i_c_number\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/voter-id-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "voter-id-verification" ] }, "description": "Validate an EPIC number and retrieve the registered name and constituency.\n\n**Request Fields**\n- `voter_i_d_e_p_i_c_number` \u2014 Voter ID (EPIC number) (string) *(required)*\n- `state` \u2014 State (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"verification_status\": \"string\",\n \"registered_name\": \"string\",\n \"registered_address\": \"string\",\n \"constituency\": \"string\"\n }\n}" } ] }, { "name": "Aadhaar eKYC (OTP)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"aadhaar_number\": \"string\",\n \"o_t_p_entered_by_the_person\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/aadhaar-ekyc-otp", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar-ekyc-otp" ] }, "description": "Full Aadhaar eKYC with a one-time password on the registered mobile.\n\n**Request Fields**\n- `aadhaar_number` \u2014 Aadhaar number (string) *(required)*\n- `o_t_p_entered_by_the_person` \u2014 OTP entered by the person (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"verified_name\": \"string\",\n \"date_of_birth\": \"string\",\n \"gender\": \"string\",\n \"full_address\": \"string\",\n \"photograph\": \"string\",\n \"masked_aadhaar\": \"string\",\n \"consent_reference\": \"string\"\n }\n}" } ] }, { "name": "CKYC Search & Download", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"p_a_n_or_other_i_d_number\": \"string\",\n \"date_of_birth\": \"string\",\n \"customer_authorisation_for_download\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/ckyc-search", "host": [ "{{base_url}}" ], "path": [ "v1", "ckyc-search" ] }, "description": "Look up an existing central KYC record and reuse it with consent.\n\n**Request Fields**\n- `p_a_n_or_other_i_d_number` \u2014 PAN or other ID number (string) *(required)*\n- `date_of_birth` \u2014 Date of birth (string)\n- `customer_authorisation_for_download` \u2014 Customer authorisation for download (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"c_k_y_c_record_found\": \"string\",\n \"c_k_y_c_identifier\": \"string\",\n \"k_y_c_record_with_identity_and_address_details_on_download\": \"string\",\n \"record_update_date\": \"string\"\n }\n}" } ] }, { "name": "Aadhaar Offline eKYC", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ekyc_file\": \"\",\n \"share_code\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/aadhaar-offline-ekyc", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar-offline-ekyc" ] }, "description": "Paperless offline KYC: the person shares a UIDAI-signed XML and you get verified demographics and photo.\n\n**Request Fields**\n- `ekyc_file` \u2014 Offline e-KYC ZIP file (file) *(required)*\n- `share_code` \u2014 Share code (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"signature_valid\": true,\n \"reference_id\": \"string\",\n \"name\": \"string\",\n \"dob\": \"YYYY-MM-DD\",\n \"gender\": \"string\",\n \"address\": \"string\",\n \"photo\": \"string\"\n }\n}" } ] }, { "name": "Ration Card Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ration_card_number\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/ration-card-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "ration-card-verification" ] }, "description": "Confirm a ration card number and the household members listed on it.\n\n**Request Fields**\n- `ration_card_number` \u2014 Ration card number (string) *(required)*\n- `state` \u2014 State (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"card_type\": \"string\",\n \"head_of_family\": \"string\",\n \"district\": \"string\",\n \"members\": [],\n \"status\": \"string\"\n }\n}" } ] }, { "name": "Doctor Registration Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registration_number\": \"string\",\n \"council\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/doctor-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "doctor-verification" ] }, "description": "Verify a medical practitioner's registration with the national or state medical council.\n\n**Request Fields**\n- `registration_number` \u2014 Registration number (string) *(required)*\n- `council` \u2014 Medical council (string) *(required)*\n- `name` \u2014 Doctor's name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registered_name\": \"string\",\n \"qualification\": \"string\",\n \"registration_year\": \"string\",\n \"council\": \"string\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "Nurse Registration Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registration_number\": \"string\",\n \"council\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/nurse-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "nurse-verification" ] }, "description": "Confirm a nurse or midwife is registered with the state nursing council.\n\n**Request Fields**\n- `registration_number` \u2014 Registration number (string) *(required)*\n- `council` \u2014 Nursing council (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registered_name\": \"string\",\n \"qualification\": \"string\",\n \"valid_until\": \"YYYY-MM-DD\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "Advocate Enrolment Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enrolment_number\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/advocate-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "advocate-verification" ] }, "description": "Verify a lawyer's enrolment number with the state bar council.\n\n**Request Fields**\n- `enrolment_number` \u2014 Enrolment number (string) *(required)*\n- `name` \u2014 Advocate's name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registered_name\": \"string\",\n \"bar_council\": \"string\",\n \"enrolment_date\": \"YYYY-MM-DD\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "RERA Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rera_number\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/rera-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "rera-verification" ] }, "description": "Verify a RERA-registered project or real-estate agent.\n\n**Request Fields**\n- `rera_number` \u2014 RERA registration number (string) *(required)*\n- `state` \u2014 State (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registration_type\": \"string\",\n \"registered_name\": \"string\",\n \"promoter\": \"string\",\n \"valid_from\": \"YYYY-MM-DD\",\n \"valid_until\": \"YYYY-MM-DD\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "Drug Licence Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"license_number\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/drug-license-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "drug-license-verification" ] }, "description": "Validate a pharmacy or drug distributor licence and its validity.\n\n**Request Fields**\n- `license_number` \u2014 Drug licence number (string) *(required)*\n- `state` \u2014 State (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"licensee\": \"string\",\n \"license_type\": \"string\",\n \"address\": \"string\",\n \"valid_until\": \"YYYY-MM-DD\",\n \"status\": \"string\"\n }\n}" } ] }, { "name": "Death Certificate Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"certificate_number\": \"string\",\n \"state\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/death-certificate-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "death-certificate-verification" ] }, "description": "Validate a death certificate for claims, succession and account closure.\n\n**Request Fields**\n- `certificate_number` \u2014 Certificate / registration number (string) *(required)*\n- `state` \u2014 State (string) *(required)*\n- `name` \u2014 Name of the deceased (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registered_name\": \"string\",\n \"date_of_death\": \"YYYY-MM-DD\",\n \"registration_date\": \"YYYY-MM-DD\",\n \"authority\": \"string\",\n \"match\": true\n }\n}" } ] } ] }, { "name": "Contact & Address", "item": [ { "name": "Mobile to PAN", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile_to_pan_mobile\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mobile-to-pan", "host": [ "{{base_url}}" ], "path": [ "v1", "mobile-to-pan" ] }, "description": "Fetches the PAN linked to a mobile number along with PAN holder name, status, type, DOB, gender, Aadhaar-link status and address.\n\n**Request Fields**\n- `mobile_to_pan_mobile` \u2014 Mobile Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Mobile Number Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile_number\": \"9999999999\",\n \"name_to_match\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mobile-number-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "mobile-number-verification" ] }, "description": "Confirm a mobile number is active, who it is registered to and which network serves it.\n\n**Request Fields**\n- `mobile_number` \u2014 Mobile number (string) *(required)*\n- `name_to_match` \u2014 Name to match (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"active_status\": \"string\",\n \"operator_and_telecom_circle\": \"string\",\n \"connection_type\": \"string\",\n \"name_match_result_where_available\": \"string\",\n \"ported\": \"string\"\n }\n}" } ] }, { "name": "Email Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email_address\": \"name@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/email-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "email-verification" ] }, "description": "Check an email address is deliverable, not disposable and consistent with the person.\n\n**Request Fields**\n- `email_address` \u2014 Email address (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"deliverable\": \"string\",\n \"disposable_or_role_address_flag\": \"string\",\n \"domain_and_provider_type\": \"string\",\n \"risk_score\": \"string\",\n \"suggested_correction_for_typos\": \"string\"\n }\n}" } ] }, { "name": "Digital Address Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"person_s_name_and_contact_for_the_capture_link\": \"string\",\n \"declared_address\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/digital-address-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "digital-address-verification" ] }, "description": "Verify a residential address with geo-tagged, timestamped photos captured by the person.\n\n**Request Fields**\n- `person_s_name_and_contact_for_the_capture_link` \u2014 Person's name and contact for the capture link (string) *(required)*\n- `declared_address` \u2014 Declared address (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"verification_outcome\": \"string\",\n \"distance_between_declared_and_captured_location\": \"string\",\n \"photo_evidence_with_g_p_s_and_timestamps\": \"string\",\n \"anti_spoofing_checks\": \"string\",\n \"reviewer_notes_where_applicable\": \"string\"\n }\n}" } ] }, { "name": "Mobile to Name", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile\": \"9999999999\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mobile-to-name", "host": [ "{{base_url}}" ], "path": [ "v1", "mobile-to-name" ] }, "description": "Find the name registered against a mobile number.\n\n**Request Fields**\n- `mobile` \u2014 Mobile number (phone) *(required)*\n- `name` \u2014 Name to match (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registered_name\": \"string\",\n \"name_match_score\": 0\n }\n}" } ] }, { "name": "Telecom Operator Lookup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/telecom-operator-lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "telecom-operator-lookup" ] }, "description": "Operator, circle, connection type and porting status for any Indian mobile number.\n\n**Request Fields**\n- `mobile` \u2014 Mobile number (phone) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"active\": true,\n \"operator\": \"string\",\n \"circle\": \"string\",\n \"connection_type\": \"string\",\n \"ported\": true,\n \"revoked\": true\n }\n}" } ] }, { "name": "WhatsApp Number Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/whatsapp-number-check", "host": [ "{{base_url}}" ], "path": [ "v1", "whatsapp-number-check" ] }, "description": "Know whether a number is reachable on WhatsApp before you message it.\n\n**Request Fields**\n- `mobile` \u2014 Mobile number (phone) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"on_whatsapp\": true,\n \"account_type\": \"string\",\n \"business_name\": \"string\"\n }\n}" } ] }, { "name": "Physical Address Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"address\": \"string\",\n \"pincode\": \"string\",\n \"mobile\": \"9999999999\",\n \"address_type\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/physical-address-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "physical-address-verification" ] }, "description": "A field agent visits the address and confirms residence with geotagged evidence.\n\n**Request Fields**\n- `name` \u2014 Name of the person (string) *(required)*\n- `address` \u2014 Full address (string) *(required)*\n- `pincode` \u2014 PIN code (string) *(required)*\n- `mobile` \u2014 Contact mobile (phone) *(required)*\n- `address_type` \u2014 Address type (current / permanent / office) (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"request_id\": \"string\",\n \"status\": \"string\",\n \"outcome\": \"string\",\n \"visited_at\": \"YYYY-MM-DD\",\n \"gps\": \"string\",\n \"photos\": [],\n \"report_url\": \"string\"\n }\n}" } ] } ] }, { "name": "Business & KYB", "item": [ { "name": "Challan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"challan_reg_no\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/challan", "host": [ "{{base_url}}" ], "path": [ "v1", "challan" ] }, "description": "Fetches e-Challan (traffic violation) records linked to a vehicle registration number, including offence, amount, payment and court status.\n\n**Request Fields**\n- `challan_reg_no` \u2014 Vehicle Registration Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "CIN Advanced", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cin_adv_cin\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/cin-advanced", "host": [ "{{base_url}}" ], "path": [ "v1", "cin-advanced" ] }, "description": "Advanced company verification - MCA master data plus registered state/city/pincode, active compliance, CIRP status, charges, present and past directors and related parties.\n\n**Request Fields**\n- `cin_adv_cin` \u2014 CIN / LLPIN (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "CIN Basic", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cin_basic_cin\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/cin-basic", "host": [ "{{base_url}}" ], "path": [ "v1", "cin-basic" ] }, "description": "Verifies a company CIN / LLPIN against MCA records and returns company master data, charges and directors/signatories.\n\n**Request Fields**\n- `cin_basic_cin` \u2014 CIN / LLPIN (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "FSSAI", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fssai_license_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/fssai", "host": [ "{{base_url}}" ], "path": [ "v1", "fssai" ] }, "description": "Verifies an FSSAI licence / registration number and returns emver name, address, licence type and validity status.\n\n**Request Fields**\n- `fssai_license_number` \u2014 FSSAI License Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "GST Advanced", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"gst_adv_gstin\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/gst-advanced", "host": [ "{{base_url}}" ], "path": [ "v1", "gst-advanced" ] }, "description": "Advanced GSTIN verification - adds promoters/partners, aggregate turnover, gross total income, e-invoice mandate, additional emver places and contact details.\n\n**Request Fields**\n- `gst_adv_gstin` \u2014 GSTIN (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "GST Basic", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"gst_basic_gstin\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/gst-basic", "host": [ "{{base_url}}" ], "path": [ "v1", "gst-basic" ] }, "description": "Verifies a GSTIN and returns taxpayer registration details - legal/trade name, status, constitution, registration date, address and filing status.\n\n**Request Fields**\n- `gst_basic_gstin` \u2014 GSTIN (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "RC V1", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rc_v1_reg_no\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/rc-v1", "host": [ "{{base_url}}" ], "path": [ "v1", "rc-v1" ] }, "description": "Vehicle RC verification - returns owner, vehicle, insurance, PUC, permit and financer details for a vehicle registration number.\n\n**Request Fields**\n- `rc_v1_reg_no` \u2014 Vehicle Registration Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "RC V2", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rc_v2_reg_no\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/rc-v2", "host": [ "{{base_url}}" ], "path": [ "v1", "rc-v2" ] }, "description": "Vehicle RC verification (Plus) - enhanced RC lookup with owner, vehicle, insurance, PUC, permit, blacklist and challan details.\n\n**Request Fields**\n- `rc_v2_reg_no` \u2014 Vehicle Registration Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Udyam Advanced", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"udyam_adv_number\": \"string\",\n \"udyam_adv_mobile\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/udyam-advanced", "host": [ "{{base_url}}" ], "path": [ "v1", "udyam-advanced" ] }, "description": "Step 1 of Udyam Advanced (OTP based) - sends an OTP to the mobile number linked with the Udyam registration. Submit the OTP with the returned reference_id to the Udyam Advanced Submit OTP API.\n\n**Request Fields**\n- `udyam_adv_number` \u2014 Udyam Registration Number (string) *(required)*\n- `udyam_adv_mobile` \u2014 Registered Mobile Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Udyam Advanced Submit OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"udyam_otp_reference_id\": \"string\",\n \"udyam_otp_code\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/udyam-advanced-submit-otp", "host": [ "{{base_url}}" ], "path": [ "v1", "udyam-advanced-submit-otp" ] }, "description": "Step 2 of Udyam Advanced - submits the OTP and returns full Udyam details including owner, PAN, contact, bank, emver and financials.\n\n**Request Fields**\n- `udyam_otp_reference_id` \u2014 Reference ID (string) *(required)*\n- `udyam_otp_code` \u2014 OTP (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "Udyam Basic", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"udyam_basic_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/udyam-basic", "host": [ "{{base_url}}" ], "path": [ "v1", "udyam-basic" ] }, "description": "Verifies a Udyam (MSME) registration number and returns emver profile, classification, address, NIC activity and branch details.\n\n**Request Fields**\n- `udyam_basic_number` \u2014 Udyam Registration Number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\"\n}" } ] }, { "name": "GSTIN Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"g_s_t_i_n\": \"string\",\n \"company_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/gstin-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "gstin-verification" ] }, "description": "Confirm GST registration, legal name, emver type and filing compliance.\n\n**Request Fields**\n- `g_s_t_i_n` \u2014 GSTIN (string) *(required)*\n- `company_name` \u2014 Company name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"registration_status\": \"string\",\n \"legal_name\": \"string\",\n \"trade_name\": \"string\",\n \"business_type__constitution\": \"string\",\n \"date_of_registration\": \"string\",\n \"return_filing_compliance\": \"string\"\n }\n}" } ] }, { "name": "GSTIN by PAN", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"p_a_n_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/gstin-by-pan", "host": [ "{{base_url}}" ], "path": [ "v1", "gstin-by-pan" ] }, "description": "Discover every GST registration held against a PAN.\n\n**Request Fields**\n- `p_a_n_number` \u2014 PAN number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"p_a_n_confirmation\": \"string\",\n \"list_of_g_s_t_i_ns_with_state_and_status\": \"string\"\n }\n}" } ] }, { "name": "TAN Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"t_a_n\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/tan-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "tan-verification" ] }, "description": "Validate a Tax Deduction Account Number and resolve the deductor.\n\n**Request Fields**\n- `t_a_n` \u2014 TAN (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"t_a_n_status\": \"string\",\n \"registered_company__deductor_name\": \"string\"\n }\n}" } ] }, { "name": "Company (MCA) Lookup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"c_i_n_registration_number\": \"string\",\n \"company_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mca-company-lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "mca-company-lookup" ] }, "description": "Incorporation status, company type, registered office and filing compliance from the corporate registry.\n\n**Request Fields**\n- `c_i_n_registration_number` \u2014 CIN / registration number (string) *(required)*\n- `company_name` \u2014 Company name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"incorporation_status\": \"string\",\n \"company_type\": \"string\",\n \"date_of_incorporation\": \"string\",\n \"registered_office_address\": \"string\",\n \"annual_filing_compliance\": \"string\"\n }\n}" } ] }, { "name": "Directorship (DIN) Lookup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"p_a_n_number\": \"string\",\n \"full_name\": \"string\",\n \"date_of_birth\": \"string\",\n \"d_i_n\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mca-directorship-lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "mca-directorship-lookup" ] }, "description": "Resolve a person's directorships and DIN status from the corporate registry.\n\n**Request Fields**\n- `p_a_n_number` \u2014 PAN number (string) *(required)*\n- `full_name` \u2014 Full name (string)\n- `date_of_birth` \u2014 Date of birth (string)\n- `d_i_n` \u2014 DIN (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"d_i_n_status\": \"string\",\n \"registered_name\": \"string\",\n \"list_of_companies_with_directorship_role\": \"string\"\n }\n}" } ] }, { "name": "Udyam / MSME Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"udyam_registration_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/udyam-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "udyam-verification" ] }, "description": "Confirm MSME registration, emver type and major activity.\n\n**Request Fields**\n- `udyam_registration_number` \u2014 Udyam registration number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"enterprise_name\": \"string\",\n \"enterprise_type\": \"string\",\n \"major_activity\": \"string\",\n \"registration_date\": \"string\"\n }\n}" } ] }, { "name": "IEC Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"i_e_c_number\": \"string\",\n \"company_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/iec-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "iec-verification" ] }, "description": "Validate an Import Export Code and the entity behind it.\n\n**Request Fields**\n- `i_e_c_number` \u2014 IEC number (string) *(required)*\n- `company_name` \u2014 Company name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"entity_name\": \"string\",\n \"i_e_c_status\": \"string\",\n \"issue_date\": \"string\"\n }\n}" } ] }, { "name": "FSSAI Licence Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"f_s_s_a_i_licence_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/fssai-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "fssai-verification" ] }, "description": "Verify a food emver licence, its status and validity.\n\n**Request Fields**\n- `f_s_s_a_i_licence_number` \u2014 FSSAI licence number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"business_name\": \"string\",\n \"licence_status\": \"string\",\n \"valid_until\": \"string\"\n }\n}" } ] }, { "name": "GST Return Filing Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"g_s_t_i_n\": \"string\",\n \"financial_year\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/gst-filing-status", "host": [ "{{base_url}}" ], "path": [ "v1", "gst-filing-status" ] }, "description": "Month-by-month GST return filing history for a GSTIN.\n\n**Request Fields**\n- `g_s_t_i_n` \u2014 GSTIN (string) *(required)*\n- `financial_year` \u2014 Financial year (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"filing_history_by_period_and_return_type\": \"string\",\n \"filing_dates\": \"string\",\n \"delayed_and_missing_periods\": \"string\",\n \"overall_compliance_rating\": \"string\"\n }\n}" } ] }, { "name": "Company Financials (MCA)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"c_i_n\": \"string\",\n \"financial_years\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mca-company-financials", "host": [ "{{base_url}}" ], "path": [ "v1", "mca-company-financials" ] }, "description": "Filed financial statements, charges and shareholding from the corporate registry.\n\n**Request Fields**\n- `c_i_n` \u2014 CIN (string) *(required)*\n- `financial_years` \u2014 Financial years (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"revenue__profit_and_net_worth_by_year\": \"string\",\n \"registered_charges_and_lenders\": \"string\",\n \"directors_and_signatories\": \"string\",\n \"shareholding_summary\": \"string\",\n \"filing_dates\": \"string\"\n }\n}" } ] }, { "name": "Shop & Establishment Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registration_number\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/shop-establishment-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "shop-establishment-verification" ] }, "description": "Confirm a state shop and establishment registration and the emver behind it.\n\n**Request Fields**\n- `registration_number` \u2014 Registration number (string) *(required)*\n- `state` \u2014 State (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"business_name\": \"string\",\n \"owner_or_employer_name\": \"string\",\n \"registered_address\": \"string\",\n \"licence_status_and_validity\": \"string\",\n \"nature_of_business\": \"string\"\n }\n}" } ] }, { "name": "GST Verification with OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"gstin\": \"string\",\n \"otp\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/gst-otp-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "gst-otp-verification" ] }, "description": "Consented GST pull: OTP to the registered mobile, then the complete profile and filing history.\n\n**Request Fields**\n- `gstin` \u2014 GSTIN (string) *(required)*\n- `otp` \u2014 OTP (second step) (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"legal_name\": \"string\",\n \"trade_name\": \"string\",\n \"places_of_business\": [],\n \"filing_frequency\": \"string\",\n \"returns\": [],\n \"turnover_band\": \"string\"\n }\n}" } ] }, { "name": "MCA Filed Documents", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cin\": \"string\",\n \"document_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/mca-filed-documents", "host": [ "{{base_url}}" ], "path": [ "v1", "mca-filed-documents" ] }, "description": "Pull the statutory documents a company has filed with the registrar.\n\n**Request Fields**\n- `cin` \u2014 CIN / LLPIN (string) *(required)*\n- `document_id` \u2014 Document ID (to fetch one) (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"documents\": [],\n \"document_url\": \"string\"\n }\n}" } ] }, { "name": "Company Name Search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/company-search", "host": [ "{{base_url}}" ], "path": [ "v1", "company-search" ] }, "description": "Find companies and LLPs by name and get their CIN or LLPIN.\n\n**Request Fields**\n- `query` \u2014 Company name (partial allowed) (string) *(required)*\n- `state` \u2014 State filter (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"results\": []\n }\n}" } ] }, { "name": "ITR Filing Status (Section 206AB)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pan_number\": \"string\",\n \"financial_year\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/tds-206-compliance", "host": [ "{{base_url}}" ], "path": [ "v1", "tds-206-compliance" ] }, "description": "Check whether a vendor is a \"specified person\" for higher TDS under section 206AB / 206CCA.\n\n**Request Fields**\n- `pan_number` \u2014 Vendor PAN (string) *(required)*\n- `financial_year` \u2014 Financial year (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"specified_person\": true,\n \"pan_status\": \"string\",\n \"aadhaar_linked\": true,\n \"financial_year\": \"string\"\n }\n}" } ] }, { "name": "Trademark Search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"string\",\n \"class\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/trademark-search", "host": [ "{{base_url}}" ], "path": [ "v1", "trademark-search" ] }, "description": "Look up registered and pending trademarks by name, application number or owner.\n\n**Request Fields**\n- `query` \u2014 Word mark or application number (string) *(required)*\n- `class` \u2014 Trademark class (number)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"results\": []\n }\n}" } ] }, { "name": "Beneficial Ownership (UBO) Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cin\": \"string\",\n \"threshold\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/ubo-check", "host": [ "{{base_url}}" ], "path": [ "v1", "ubo-check" ] }, "description": "Trace who ultimately owns and controls a company.\n\n**Request Fields**\n- `cin` \u2014 CIN / LLPIN (string) *(required)*\n- `threshold` \u2014 Ownership threshold (%) (number)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"beneficial_owners\": [],\n \"ownership_chain\": [],\n \"as_of\": \"YYYY-MM-DD\"\n }\n}" } ] }, { "name": "Udyog Aadhaar Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uam_number\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/udyog-aadhaar-verification", "host": [ "{{base_url}}" ], "path": [ "v1", "udyog-aadhaar-verification" ] }, "description": "Validate a legacy Udyog Aadhaar (UAM) number for MSMEs that have not migrated to Udyam.\n\n**Request Fields**\n- `uam_number` \u2014 Udyog Aadhaar number (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"enterprise_name\": \"string\",\n \"owner_name\": \"string\",\n \"enterprise_type\": \"string\",\n \"major_activity\": \"string\",\n \"registration_date\": \"YYYY-MM-DD\"\n }\n}" } ] } ] }, { "name": "Documents & Biometrics", "item": [ { "name": "ID Document OCR", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"document_image_front_and_back_where_applicable\": \"string\",\n \"expected_document_type\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/id-document-ocr", "host": [ "{{base_url}}" ], "path": [ "v1", "id-document-ocr" ] }, "description": "Extract structured data from Aadhaar, PAN, passport, DL, voter ID and more.\n\n**Request Fields**\n- `document_image_front_and_back_where_applicable` \u2014 Document image (front, and back where applicable) (string) *(required)*\n- `expected_document_type` \u2014 Expected document type (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"detected_document_type\": \"string\",\n \"extracted_fields\": \"string\",\n \"image_quality_score\": \"string\",\n \"masked_identifiers\": \"string\"\n }\n}" } ] }, { "name": "Face Match", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"selfie_image\": \"string\",\n \"reference_photo_i_d_document_or_k_y_c_record\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/face-match", "host": [ "{{base_url}}" ], "path": [ "v1", "face-match" ] }, "description": "Compare a selfie to the photo on an ID document or KYC record.\n\n**Request Fields**\n- `selfie_image` \u2014 Selfie image (string) *(required)*\n- `reference_photo_i_d_document_or_k_y_c_record` \u2014 Reference photo (ID document or KYC record) (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"match_score\": \"string\",\n \"match_decision_against_threshold\": \"string\",\n \"face_detected_in_each_image\": \"string\"\n }\n}" } ] }, { "name": "Liveness Detection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"selfie_image_or_short_capture\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/liveness-detection", "host": [ "{{base_url}}" ], "path": [ "v1", "liveness-detection" ] }, "description": "Prove the selfie is a live person, not a photo, screen or mask.\n\n**Request Fields**\n- `selfie_image_or_short_capture` \u2014 Selfie image or short capture (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"liveness_decision\": \"string\",\n \"confidence_score\": \"string\",\n \"capture_quality_feedback\": \"string\"\n }\n}" } ] }, { "name": "Video KYC", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_name_and_contact_for_the_session_link\": \"string\",\n \"documents_to_capture_and_checks_to_run\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/video-kyc", "host": [ "{{base_url}}" ], "path": [ "v1", "video-kyc" ] }, "description": "Agent-assisted or self-serve video identification with recording and audit trail.\n\n**Request Fields**\n- `customer_name_and_contact_for_the_session_link` \u2014 Customer name and contact for the session link (string) *(required)*\n- `documents_to_capture_and_checks_to_run` \u2014 Documents to capture and checks to run (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"session_outcome\": \"string\",\n \"extracted_document_data\": \"string\",\n \"liveness_and_face_match_results\": \"string\",\n \"geo_location_and_timestamps\": \"string\",\n \"recording_and_audit_trail_reference\": \"string\"\n }\n}" } ] }, { "name": "Aadhaar Masking", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"aadhaar_image_or_p_d_f\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/aadhaar-masking", "host": [ "{{base_url}}" ], "path": [ "v1", "aadhaar-masking" ] }, "description": "Automatically mask the first eight digits on Aadhaar images and PDFs.\n\n**Request Fields**\n- `aadhaar_image_or_p_d_f` \u2014 Aadhaar image or PDF (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"masked_document\": \"string\",\n \"number_detected\": \"string\",\n \"confidence_flag\": \"string\"\n }\n}" } ] }, { "name": "Name Match", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name_one\": \"string\",\n \"name_two\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/name-match", "host": [ "{{base_url}}" ], "path": [ "v1", "name-match" ] }, "description": "Score how well two names match, allowing for initials, order and spelling.\n\n**Request Fields**\n- `name_one` \u2014 Name one (string) *(required)*\n- `name_two` \u2014 Name two (string) *(required)*", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"match_score\": \"string\",\n \"match_decision_against_threshold\": \"string\",\n \"explanation_of_differences\": \"string\"\n }\n}" } ] }, { "name": "Signature Match", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reference_image\": \"\",\n \"document_image\": \"\",\n \"threshold\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/signature-match", "host": [ "{{base_url}}" ], "path": [ "v1", "signature-match" ] }, "description": "Compare a signature on a document with a reference specimen and get a match score.\n\n**Request Fields**\n- `reference_image` \u2014 Reference signature image (file) *(required)*\n- `document_image` \u2014 Document image (file) *(required)*\n- `threshold` \u2014 Match threshold (0\u2013100) (number)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"match\": true,\n \"score\": 0,\n \"signature_detected\": true\n }\n}" } ] }, { "name": "Deepfake Detection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"media\": \"\",\n \"threshold\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/deepfake-detection", "host": [ "{{base_url}}" ], "path": [ "v1", "deepfake-detection" ] }, "description": "Flag synthetic or manipulated faces in selfies and video frames.\n\n**Request Fields**\n- `media` \u2014 Selfie image or video (file) *(required)*\n- `threshold` \u2014 Risk threshold (0\u2013100) (number)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"is_deepfake\": true,\n \"risk_score\": 0,\n \"signals\": []\n }\n}" } ] }, { "name": "Document Tamper Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"\",\n \"document_type\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/document-tamper-check", "host": [ "{{base_url}}" ], "path": [ "v1", "document-tamper-check" ] }, "description": "Detect edited, forged or template-generated documents before you trust their contents.\n\n**Request Fields**\n- `document` \u2014 Document image or PDF (file) *(required)*\n- `document_type` \u2014 Document type hint (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"tampered\": true,\n \"score\": 0,\n \"anomalies\": [],\n \"regions\": []\n }\n}" } ] } ] }, { "name": "Risk & Compliance", "item": [ { "name": "AML & Sanctions Screening", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name_individual_or_entity\": \"string\",\n \"date_of_birth_or_incorporation\": \"string\",\n \"nationality_or_country\": \"string\",\n \"identifiers_p_a_n_passport\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/aml-screening", "host": [ "{{base_url}}" ], "path": [ "v1", "aml-screening" ] }, "description": "Screen people and entities against global sanctions, PEP and watchlists.\n\n**Request Fields**\n- `name_individual_or_entity` \u2014 Name (individual or entity) (string) *(required)*\n- `date_of_birth_or_incorporation` \u2014 Date of birth or incorporation (string)\n- `nationality_or_country` \u2014 Nationality or country (string)\n- `identifiers_p_a_n_passport` \u2014 Identifiers (PAN, passport) (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"match_status\": \"string\",\n \"ranked_matches_with_score\": \"string\",\n \"list__category_and_reason\": \"string\",\n \"p_e_p_level_and_relationships\": \"string\",\n \"profile_summary_for_each_match\": \"string\"\n }\n}" } ] }, { "name": "Court & Criminal Records Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"string\",\n \"father_s_or_spouse_s_name\": \"string\",\n \"address_or_district\": \"string\",\n \"date_of_birth\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/court-records-check", "host": [ "{{base_url}}" ], "path": [ "v1", "court-records-check" ] }, "description": "Search civil and criminal case records across Indian courts for a person or entity.\n\n**Request Fields**\n- `full_name` \u2014 Full name (string) *(required)*\n- `father_s_or_spouse_s_name` \u2014 Father's or spouse's name (string)\n- `address_or_district` \u2014 Address or district (string)\n- `date_of_birth` \u2014 Date of birth (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"records_found\": \"string\",\n \"matched_cases_with_court_and_case_number\": \"string\",\n \"case_type__status_and_year\": \"string\",\n \"parties_and_match_score\": \"string\",\n \"adjudication_notes_where_reviewed\": \"string\"\n }\n}" } ] }, { "name": "Adverse Media Screening", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name_individual_or_entity\": \"string\",\n \"context_company_location_role\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/adverse-media-screening", "host": [ "{{base_url}}" ], "path": [ "v1", "adverse-media-screening" ] }, "description": "Find negative news about a person or company across news and public sources.\n\n**Request Fields**\n- `name_individual_or_entity` \u2014 Name (individual or entity) (string) *(required)*\n- `context_company_location_role` \u2014 Context (company, location, role) (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"articles_found_with_source_and_date\": \"string\",\n \"risk_category_per_article\": \"string\",\n \"relevance_score\": \"string\",\n \"summary_of_allegations\": \"string\",\n \"monitoring_alerts\": \"string\"\n }\n}" } ] }, { "name": "Digital Footprint Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mobile\": \"9999999999\",\n \"email\": \"name@example.com\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/digital-footprint-check", "host": [ "{{base_url}}" ], "path": [ "v1", "digital-footprint-check" ] }, "description": "How established is this person online? Signals from phone, email and app presence.\n\n**Request Fields**\n- `mobile` \u2014 Mobile number (phone) *(required)*\n- `email` \u2014 Email address (email)\n- `name` \u2014 Name (string)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"footprint_score\": 0,\n \"platforms\": [],\n \"consistency_flags\": [],\n \"risk_band\": \"string\"\n }\n}" } ] }, { "name": "Data Breach Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\",\n \"mobile\": \"9999999999\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/data-breach-check", "host": [ "{{base_url}}" ], "path": [ "v1", "data-breach-check" ] }, "description": "Has this email or phone appeared in known credential leaks?\n\n**Request Fields**\n- `email` \u2014 Email address (email)\n- `mobile` \u2014 Mobile number (phone)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"breached\": true,\n \"breach_count\": 200,\n \"last_seen\": \"YYYY-MM-DD\",\n \"exposed_data_types\": []\n }\n}" } ] }, { "name": "Court Case Status Lookup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cnr_number\": \"string\",\n \"court\": \"string\",\n \"case_number\": \"string\",\n \"year\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/v1/case-status-lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "case-status-lookup" ] }, "description": "Track a specific case by CNR or case number: status, next hearing and orders.\n\n**Request Fields**\n- `cnr_number` \u2014 CNR number (string)\n- `court` \u2014 Court (when no CNR) (string)\n- `case_number` \u2014 Case number (string)\n- `year` \u2014 Case year (number)", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, "response": [ { "name": "200 Success", "originalRequest": { "method": "POST" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 200,\n \"message\": \"string\",\n \"data\": {\n \"case_title\": \"string\",\n \"stage\": \"string\",\n \"parties\": [],\n \"next_hearing\": \"YYYY-MM-DD\",\n \"orders\": []\n }\n}" } ] } ] }, { "name": "Requests", "description": "Every answer carries a request_id (body and X-Request-Id header). Set the {{request_id}} variable to read a call back or download its document.", "item": [ { "name": "Get a request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/requests/{{request_id}}", "host": [ "{{base_url}}" ], "path": [ "requests", "{{request_id}}" ] }, "description": "The status and answer of an earlier call. status is processing (still waiting on the source), completed (the answer is in result) or failed. While a document is kept (72 hours) the body also carries report_url and report.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } } }, { "name": "Download the document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{base_url}}/requests/{{request_id}}/report", "host": [ "{{base_url}}" ], "path": [ "requests", "{{request_id}}", "report" ] }, "description": "Optional \u2014 a document API's answer already carries the file as report.base64. Streams the raw file (its Content-Type, not JSON) for 72 hours after the call (report.expires_at), then 410. Also serves the PDF of a JSON API called with ?report=pdf.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } } } ] } ], "variable": [ { "key": "base_url", "value": "https://app.emver.io/api/sandbox", "type": "string", "description": "Sandbox base URL (demo hits, safe to test)." }, { "key": "production_url", "value": "https://app.emver.io/api", "type": "string", "description": "Production base URL (billed)." }, { "key": "request_id", "value": "req_xxxxxxxxxxxxxxxxxxxxxxxx", "type": "string", "description": "A request_id from an earlier answer, for the Requests folder." }, { "key": "api_key", "value": "YOUR_API_KEY", "type": "string", "description": "Your emver API key for the environment you are calling. Create one under API Keys in the console." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }