{ "openapi": "3.0.3", "info": { "title": "emver Verification API", "version": "2026-11-12", "description": "Identity, business, banking, workforce, contact and risk verification APIs. Every call is a JSON POST authenticated with a Bearer API key. Full guides: https://app.emver.io/docs\n\nSandbox mock mode: a sandbox key set to Mock (developer console \u2192 API Keys) is answered with sample responses \u2014 no source call, no demo hits, never billed \u2014 in the same shape as a live answer plus \"mock\": true. Pick the scenario with the X-Mock-Scenario header, or by ending the first request field's value in N (not_found), X (invalid_input) or E (provider_error); any other value answers success. Input validation still applies.", "contact": { "name": "emver", "url": "https://app.emver.io/docs" } }, "servers": [ { "url": "https://app.emver.io/api/sandbox", "description": "Sandbox \u2014 demo hits, safe to test" }, { "url": "https://app.emver.io/api", "description": "Production \u2014 billed" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Workforce & Assets" }, { "name": "Banking & Credit" }, { "name": "Identity & KYC" }, { "name": "Contact & Address" }, { "name": "Business & KYB" }, { "name": "Documents & Biometrics" }, { "name": "Risk & Compliance" }, { "name": "Requests" } ], "paths": { "/v1/uan-advanced": { "post": { "operationId": "uan_advanced", "summary": "UAN Advanced", "description": "Retrieve a candidate's emver history from provident fund records using their UAN.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uan_advanced_uan_number": { "type": "string", "title": "UAN Number" } }, "required": [ "uan_advanced_uan_number" ] }, "example": { "uan_advanced_uan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "type": "object", "properties": { "pan_number": { "type": "string" }, "pan_status": { "type": "string" }, "remarks": { "type": "string" } } } } }, "example": { "status": 200, "data": { "pan_number": "string", "pan_status": "string", "remarks": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/uan-advanced-pdf": { "post": { "operationId": "uan_advanced_pdf", "summary": "UAN Advanced (PDF)", "description": "**Answers with a PDF document.** The 200 body carries the file inline as `report.base64` \u2014 no second call is needed. `report_url` is optional: GET it with the same API key to download the raw file (its `Content-Type`, not JSON) 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.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uan_advanced_uan_number": { "type": "string", "title": "UAN Number" } }, "required": [ "uan_advanced_uan_number" ] }, "example": { "uan_advanced_uan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "report_url": { "type": "string" }, "report": { "type": "object", "properties": { "format": { "type": "string" }, "mime": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "expires_at": { "type": "string" }, "base64": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "report_url": "string", "report": { "format": "string", "mime": "string", "filename": "string", "size": 200, "url": "string", "expires_at": "string", "base64": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/uan-check-v2": { "post": { "operationId": "uan_check_v2", "summary": "Uan Check (v2)", "description": "Retrieve a candidate's emver history from provident fund records using their UAN.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uan_number": { "type": "string", "title": "UAN Number" } }, "required": [ "uan_number" ] }, "example": { "uan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "type": "object", "properties": { "uan_number": { "type": "string" }, "message": { "type": "string" } } } } }, "example": { "status": 200, "data": { "uan_number": "string", "message": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/bank-account": { "post": { "operationId": "bank_account", "summary": "Bank Account", "description": "Verifies a bank account number and IFSC in real time and returns the account holder name with optional name-match score.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bank_account_number": { "type": "string", "title": "Account Number" }, "bank_ifsc": { "type": "string", "title": "IFSC Code", "description": "11-character IFSC" }, "bank_holder_name": { "type": "string", "title": "Account Holder Name", "description": "Optional - used for name match" } }, "required": [ "bank_account_number", "bank_ifsc" ] }, "example": { "bank_account_number": "string", "bank_ifsc": "string", "bank_holder_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v2/cibil-transunion-nee-v2-pdf": { "post": { "operationId": "cibil_transunion_nee_v2_pdf", "summary": "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**Answers with a PDF document.** The 200 body carries the file inline as `report.base64` \u2014 no second call is needed. `report_url` is optional: GET it with the same API key to download the raw file (its `Content-Type`, not JSON) 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.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan_card_number": { "type": "string", "title": "PAN Card Number" }, "phone_number": { "type": "string", "title": "Mobile Number" } }, "required": [ "pan_card_number", "phone_number" ] }, "example": { "pan_card_number": "string", "phone_number": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "report_url": { "type": "string" }, "report": { "type": "object", "properties": { "format": { "type": "string" }, "mime": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "expires_at": { "type": "string" }, "base64": { "type": "string" } } } } }, "example": { "status": "string", "message": "string", "report_url": "string", "report": { "format": "string", "mime": "string", "filename": "string", "size": 200, "url": "string", "expires_at": "string", "base64": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v2/cibil-transunion-v2-pdf": { "post": { "operationId": "cibil_transunion_v2_pdf", "summary": "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**Answers with a PDF document.** The 200 body carries the file inline as `report.base64` \u2014 no second call is needed. `report_url` is optional: GET it with the same API key to download the raw file (its `Content-Type`, not JSON) 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.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan_card_number": { "type": "string", "title": "PAN Card Number" }, "phone_number": { "type": "string", "title": "Mobile Number" } }, "required": [ "pan_card_number", "phone_number" ] }, "example": { "pan_card_number": "string", "phone_number": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "report_url": { "type": "string" }, "report": { "type": "object", "properties": { "format": { "type": "string" }, "mime": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "expires_at": { "type": "string" }, "base64": { "type": "string" } } } } }, "example": { "status": "string", "message": "string", "report_url": "string", "report": { "format": "string", "mime": "string", "filename": "string", "size": 200, "url": "string", "expires_at": "string", "base64": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/upi": { "post": { "operationId": "upi", "summary": "UPI", "description": "Verifies a UPI ID / VPA and returns the linked account holder name, with optional name match against the supplied name.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "upi_vpa": { "type": "string", "title": "UPI ID / VPA" }, "upi_name": { "type": "string", "title": "Name", "description": "Optional - used for name match" } }, "required": [ "upi_vpa" ] }, "example": { "upi_vpa": "string", "upi_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/aadhaar-api-without-otp": { "post": { "operationId": "aadhaar_api_without_otp", "summary": "Aadhaar Check (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**Consent required.** Collect 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 and `code: consent_required`, before anything is billed. `consent: false` is always refused with `code: consent_declined`.", "tags": [ "Identity & KYC" ], "x-consent-required": true, "x-consent-statement": "I hereby provide consent for Aadhaar-based KYC verification as per UIDAI guidelines.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aadhaar_api_without_otp_aadhaar_number": { "type": "number", "title": "Aadhaar Number" }, "consent": { "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "Y", "N" ] } ], "title": "Consent of the person", "description": "true (or \"Y\") once the person being verified has agreed to: \"I hereby provide consent for Aadhaar-based KYC verification as per UIDAI guidelines.\" false (or \"N\") if they declined \u2014 the call is then refused. Required: a call without it is refused with 422 code consent_required." } }, "required": [ "aadhaar_api_without_otp_aadhaar_number", "consent" ] }, "example": { "aadhaar_api_without_otp_aadhaar_number": 0, "consent": true } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/cibil-transunion": { "post": { "operationId": "cibil_transunion", "summary": "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**Consent required.** Collect 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 and `code: consent_required`, before anything is billed. `consent: false` is always refused with `code: consent_declined`.", "tags": [ "Identity & KYC" ], "x-consent-required": true, "x-consent-statement": "I confirm the customer has given consent for a credit check.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "phone_number": { "type": "string", "title": "Phone Number", "description": "Indian mobile number starting with 6-9" }, "dob": { "type": "string", "format": "date", "title": "Date of Birth" }, "gender": { "type": "string", "enum": [ "Male", "Female", "Other" ], "title": "Gender" }, "pan_card_number": { "type": "string", "title": "PAN Card Number" }, "consent": { "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "Y", "N" ] } ], "title": "Consent of the person", "description": "true (or \"Y\") once the person being verified has agreed to: \"I confirm the customer has given consent for a credit check.\" false (or \"N\") if they declined \u2014 the call is then refused. Required: a call without it is refused with 422 code consent_required." } }, "required": [ "first_name", "last_name", "phone_number", "dob", "gender", "pan_card_number", "consent" ] }, "example": { "first_name": "string", "last_name": "string", "phone_number": "9999999999", "dob": "YYYY-MM-DD", "gender": "Male", "pan_card_number": "string", "consent": true } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "reference_id": { "type": "string" } } }, "example": { "status": "string", "message": "string", "reference_id": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/cibil-transunion-nee-pdf": { "post": { "operationId": "cibil_transunion_nee_pdf", "summary": "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**Answers with a PDF document.** The 200 body carries the file inline as `report.base64` \u2014 no second call is needed. `report_url` is optional: GET it with the same API key to download the raw file (its `Content-Type`, not JSON) 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.\n\n**Consent required.** Collect 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 and `code: consent_required`, before anything is billed. `consent: false` is always refused with `code: consent_declined`.", "tags": [ "Identity & KYC" ], "x-consent-required": true, "x-consent-statement": "I confirm the customer has given consent for a credit check.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "phone_number": { "type": "string", "title": "Phone Number", "description": "Indian mobile number starting with 6-9" }, "dob": { "type": "string", "format": "date", "title": "Date of Birth" }, "gender": { "type": "string", "enum": [ "Male", "Female", "Other" ], "title": "Gender" }, "pan_card_number": { "type": "string", "title": "PAN Card Number" }, "consent": { "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "Y", "N" ] } ], "title": "Consent of the person", "description": "true (or \"Y\") once the person being verified has agreed to: \"I confirm the customer has given consent for a credit check.\" false (or \"N\") if they declined \u2014 the call is then refused. Required: a call without it is refused with 422 code consent_required." } }, "required": [ "first_name", "last_name", "phone_number", "dob", "gender", "pan_card_number", "consent" ] }, "example": { "first_name": "string", "last_name": "string", "phone_number": "9999999999", "dob": "YYYY-MM-DD", "gender": "Male", "pan_card_number": "string", "consent": true } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "report_url": { "type": "string" }, "report": { "type": "object", "properties": { "format": { "type": "string" }, "mime": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "expires_at": { "type": "string" }, "base64": { "type": "string" } } } } }, "example": { "status": "string", "message": "string", "report_url": "string", "report": { "format": "string", "mime": "string", "filename": "string", "size": 200, "url": "string", "expires_at": "string", "base64": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/cibil-transunion-pdf-v2": { "post": { "operationId": "cibil_transunion_pdf_v2", "summary": "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**Answers with a PDF document.** The 200 body carries the file inline as `report.base64` \u2014 no second call is needed. `report_url` is optional: GET it with the same API key to download the raw file (its `Content-Type`, not JSON) 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.\n\n**Consent required.** Collect 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 and `code: consent_required`, before anything is billed. `consent: false` is always refused with `code: consent_declined`.", "tags": [ "Identity & KYC" ], "x-consent-required": true, "x-consent-statement": "I confirm the customer has given consent for a credit check.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "phone_number": { "type": "string", "title": "Phone Number", "description": "Indian mobile number starting with 6-9" }, "dob": { "type": "string", "format": "date", "title": "Date of Birth" }, "gender": { "type": "string", "enum": [ "Male", "Female", "Other" ], "title": "Gender" }, "pan_card_number": { "type": "string", "title": "PAN Card Number" }, "consent": { "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "Y", "N" ] } ], "title": "Consent of the person", "description": "true (or \"Y\") once the person being verified has agreed to: \"I confirm the customer has given consent for a credit check.\" false (or \"N\") if they declined \u2014 the call is then refused. Required: a call without it is refused with 422 code consent_required." } }, "required": [ "first_name", "last_name", "phone_number", "dob", "gender", "pan_card_number", "consent" ] }, "example": { "first_name": "string", "last_name": "string", "phone_number": "9999999999", "dob": "YYYY-MM-DD", "gender": "Male", "pan_card_number": "string", "consent": true } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "report_url": { "type": "string" }, "report": { "type": "object", "properties": { "format": { "type": "string" }, "mime": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "expires_at": { "type": "string" }, "base64": { "type": "string" } } } } }, "example": { "status": "string", "message": "string", "report_url": "string", "report": { "format": "string", "mime": "string", "filename": "string", "size": 200, "url": "string", "expires_at": "string", "base64": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/cibil-transunion-pdf": { "post": { "operationId": "cibil_transunion_pdf", "summary": "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**Answers with a PDF document.** The 200 body carries the file inline as `report.base64` \u2014 no second call is needed. `report_url` is optional: GET it with the same API key to download the raw file (its `Content-Type`, not JSON) 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.\n\n**Consent required.** Collect 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 and `code: consent_required`, before anything is billed. `consent: false` is always refused with `code: consent_declined`.", "tags": [ "Identity & KYC" ], "x-consent-required": true, "x-consent-statement": "I confirm the customer has given consent for a credit check.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "phone_number": { "type": "string", "title": "Phone Number", "description": "Indian mobile number starting with 6-9" }, "dob": { "type": "string", "format": "date", "title": "Date of Birth" }, "gender": { "type": "string", "enum": [ "Male", "Female", "Other" ], "title": "Gender" }, "pan_card_number": { "type": "string", "title": "PAN Card Number" }, "consent": { "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "Y", "N" ] } ], "title": "Consent of the person", "description": "true (or \"Y\") once the person being verified has agreed to: \"I confirm the customer has given consent for a credit check.\" false (or \"N\") if they declined \u2014 the call is then refused. Required: a call without it is refused with 422 code consent_required." } }, "required": [ "first_name", "last_name", "phone_number", "dob", "gender", "pan_card_number", "consent" ] }, "example": { "first_name": "string", "last_name": "string", "phone_number": "9999999999", "dob": "YYYY-MM-DD", "gender": "Male", "pan_card_number": "string", "consent": true } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "report_url": { "type": "string" }, "report": { "type": "object", "properties": { "format": { "type": "string" }, "mime": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "expires_at": { "type": "string" }, "base64": { "type": "string" } } } } }, "example": { "status": "string", "message": "string", "report_url": "string", "report": { "format": "string", "mime": "string", "filename": "string", "size": 200, "url": "string", "expires_at": "string", "base64": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/digilocker": { "post": { "operationId": "digilocker", "summary": "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.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/digilocker-kyc": { "post": { "operationId": "digilocker_kyc", "summary": "Digilocker", "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.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "digilocker_mobile": { "type": "string", "title": "Mobile Number", "description": "Customer mobile number (10 digits)" }, "digilocker_first_name": { "type": "string", "title": "First Name" }, "digilocker_last_name": { "type": "string", "title": "Last Name" }, "digilocker_email": { "type": "string", "title": "Email" }, "digilocker_redirect_url": { "type": "string", "title": "Redirect URL", "description": "Where the customer returns after consent" } }, "required": [ "digilocker_mobile" ] }, "example": { "digilocker_mobile": "9999999999", "digilocker_first_name": "string", "digilocker_last_name": "string", "digilocker_email": "name@example.com", "digilocker_redirect_url": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/digilocker-fetch-details": { "post": { "operationId": "digilocker_fetch_details", "summary": "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.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "digilocker_transaction_id": { "type": "string", "title": "Transaction ID", "description": "transaction_id returned by the Digilocker API" } }, "required": [ "digilocker_transaction_id" ] }, "example": { "digilocker_transaction_id": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/driving-license": { "post": { "operationId": "driving_license", "summary": "Driving License", "description": "Verifies a Driving Licence number with date of birth against RTO records and returns holder, validity, address and vehicle class details.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dl_number": { "type": "string", "title": "DL Number", "description": "Driving licence number without spaces" }, "dl_dob": { "type": "string", "title": "Date of Birth", "description": "Date of birth as on the licence (DD/MM/YYYY)" } }, "required": [ "dl_number", "dl_dob" ] }, "example": { "dl_number": "string", "dl_dob": "YYYY-MM-DD" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/driving-license-v2": { "post": { "operationId": "driving_license_v2", "summary": "Driving License V2 (DL Validation Plus)", "description": "DL Validation Plus - enhanced Driving Licence verification returning holder photo, blood group, expiry, status details and vehicle-category wise validity.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dl_v2_dl_number": { "type": "string", "title": "DL Number", "description": "Driving licence number without spaces" }, "dl_v2_dob": { "type": "string", "title": "Date of Birth", "description": "Date of birth as on the licence (DD/MM/YYYY)" } }, "required": [ "dl_v2_dl_number", "dl_v2_dob" ] }, "example": { "dl_v2_dl_number": "string", "dl_v2_dob": "YYYY-MM-DD" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mobile-to-pan": { "post": { "operationId": "mobile_to_pan", "summary": "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.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile_to_pan_mobile": { "type": "string", "title": "Mobile Number" } }, "required": [ "mobile_to_pan_mobile" ] }, "example": { "mobile_to_pan_mobile": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/pan-basic": { "post": { "operationId": "pan_basic", "summary": "Pan Basic", "description": "Validate a PAN, match the name and confirm it is active with the tax department.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan_api_detail_pan_number": { "type": "string", "title": "Pan Number" } } }, "example": { "pan_api_detail_pan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/pan-aetail": { "post": { "operationId": "pan_aetail", "summary": "Pan Detail", "description": "Validates PAN against Income Tax Department records via emver. Checks name, DOB, and PAN status.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan_api_detail_pan_number": { "type": "string", "title": "Pan Number" } } }, "example": { "pan_api_detail_pan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "type": "object", "properties": { "pan_number": { "type": "string" }, "pan_status": { "type": "string" }, "remarks": { "type": "string" } } } } }, "example": { "status": 200, "data": { "pan_number": "string", "pan_status": "string", "remarks": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/passport": { "post": { "operationId": "passport", "summary": "Passport", "description": "Verifies a passport using the application file number and date of birth and returns passport number, holder name and application/dispatch dates.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "passport_file_number": { "type": "string", "title": "Passport File Number", "description": "Passport application file number" }, "passport_dob": { "type": "string", "title": "Date of Birth", "description": "Date of birth as on the passport (DD/MM/YYYY)" } }, "required": [ "passport_file_number", "passport_dob" ] }, "example": { "passport_file_number": "string", "passport_dob": "YYYY-MM-DD" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/uan-check-v3": { "post": { "operationId": "uan_check_v3", "summary": "UAN Check (v3)", "description": "", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uan_number": { "type": "string", "title": "UAN Number" } }, "required": [ "uan_number" ] }, "example": { "uan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "example": { "status": 200, "data": { "message": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/voter-id": { "post": { "operationId": "voter_id", "summary": "Voter ID", "description": "Verifies a Voter ID (EPIC) number against Election Commission records and returns voter, constituency and polling station details.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "voter_id_epic_number": { "type": "string", "title": "EPIC Number", "description": "Voter ID (EPIC) number as printed on the card" } }, "required": [ "voter_id_epic_number" ] }, "example": { "voter_id_epic_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/challan": { "post": { "operationId": "challan", "summary": "Challan", "description": "Fetches e-Challan (traffic violation) records linked to a vehicle registration number, including offence, amount, payment and court status.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "challan_reg_no": { "type": "string", "title": "Vehicle Registration Number", "description": "Vehicle number without spaces or special characters" } }, "required": [ "challan_reg_no" ] }, "example": { "challan_reg_no": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/cin-advanced": { "post": { "operationId": "cin_advanced", "summary": "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.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cin_adv_cin": { "type": "string", "title": "CIN / LLPIN", "description": "21-char CIN or LLPIN / FCRN" } }, "required": [ "cin_adv_cin" ] }, "example": { "cin_adv_cin": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/cin-basic": { "post": { "operationId": "cin_basic", "summary": "CIN Basic", "description": "Verifies a company CIN / LLPIN against MCA records and returns company master data, charges and directors/signatories.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cin_basic_cin": { "type": "string", "title": "CIN / LLPIN", "description": "21-char CIN or LLPIN / FCRN" } }, "required": [ "cin_basic_cin" ] }, "example": { "cin_basic_cin": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/fssai": { "post": { "operationId": "fssai", "summary": "FSSAI", "description": "Verifies an FSSAI licence / registration number and returns emver name, address, licence type and validity status.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fssai_license_number": { "type": "string", "title": "FSSAI License Number" } }, "required": [ "fssai_license_number" ] }, "example": { "fssai_license_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/gst-advanced": { "post": { "operationId": "gst_advanced", "summary": "GST Advanced", "description": "Advanced GSTIN verification - adds promoters/partners, aggregate turnover, gross total income, e-invoice mandate, additional emver places and contact details.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gst_adv_gstin": { "type": "string", "title": "GSTIN" } }, "required": [ "gst_adv_gstin" ] }, "example": { "gst_adv_gstin": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/gst-basic": { "post": { "operationId": "gst_basic", "summary": "GST Basic", "description": "Verifies a GSTIN and returns taxpayer registration details - legal/trade name, status, constitution, registration date, address and filing status.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gst_basic_gstin": { "type": "string", "title": "GSTIN" } }, "required": [ "gst_basic_gstin" ] }, "example": { "gst_basic_gstin": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/rc-v1": { "post": { "operationId": "rc_v1", "summary": "RC V1", "description": "Vehicle RC verification - returns owner, vehicle, insurance, PUC, permit and financer details for a vehicle registration number.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rc_v1_reg_no": { "type": "string", "title": "Vehicle Registration Number", "description": "Vehicle number without spaces or special characters" } }, "required": [ "rc_v1_reg_no" ] }, "example": { "rc_v1_reg_no": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/rc-v2": { "post": { "operationId": "rc_v2", "summary": "RC V2", "description": "Vehicle RC verification (Plus) - enhanced RC lookup with owner, vehicle, insurance, PUC, permit, blacklist and challan details.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rc_v2_reg_no": { "type": "string", "title": "Vehicle Registration Number", "description": "Vehicle number without spaces or special characters" } }, "required": [ "rc_v2_reg_no" ] }, "example": { "rc_v2_reg_no": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/udyam-advanced": { "post": { "operationId": "udyam_advanced", "summary": "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.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "udyam_adv_number": { "type": "string", "title": "Udyam Registration Number" }, "udyam_adv_mobile": { "type": "string", "title": "Registered Mobile Number", "description": "Mobile linked to Udyam - OTP will be sent here" } }, "required": [ "udyam_adv_number", "udyam_adv_mobile" ] }, "example": { "udyam_adv_number": "string", "udyam_adv_mobile": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/udyam-advanced-submit-otp": { "post": { "operationId": "udyam_advanced_submit_otp", "summary": "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.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "udyam_otp_reference_id": { "type": "string", "title": "Reference ID", "description": "reference_id returned by Udyam Advanced (Generate OTP)" }, "udyam_otp_code": { "type": "string", "title": "OTP" } }, "required": [ "udyam_otp_reference_id", "udyam_otp_code" ] }, "example": { "udyam_otp_reference_id": "string", "udyam_otp_code": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/udyam-basic": { "post": { "operationId": "udyam_basic", "summary": "Udyam Basic", "description": "Verifies a Udyam (MSME) registration number and returns emver profile, classification, address, NIC activity and branch details.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "udyam_basic_number": { "type": "string", "title": "Udyam Registration Number" } }, "required": [ "udyam_basic_number" ] }, "example": { "udyam_basic_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } }, "example": { "status": 200, "message": "string" } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/pan-aadhaar-link": { "post": { "operationId": "pan_aadhaar_link", "summary": "PAN-Aadhaar Link Check", "description": "Confirm a PAN is seeded with the given Aadhaar.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "p_a_n_number": { "type": "string", "title": "PAN number" }, "aadhaar_number": { "type": "string", "title": "Aadhaar number" } }, "required": [ "p_a_n_number", "aadhaar_number" ] }, "example": { "p_a_n_number": "string", "aadhaar_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "link_status": { "type": "string" }, "masked_p_a_n": { "type": "string" }, "reason_when_not_linked": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "link_status": "string", "masked_p_a_n": "string", "reason_when_not_linked": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/passport-verification": { "post": { "operationId": "passport_verification", "summary": "Passport Verification", "description": "Verify Indian passport details against official records.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "passport_number": { "type": "string", "title": "Passport number" }, "date_of_birth": { "type": "string", "title": "Date of birth" }, "full_name": { "type": "string", "title": "Full name" } }, "required": [ "passport_number", "date_of_birth" ] }, "example": { "passport_number": "string", "date_of_birth": "string", "full_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "verification_status": { "type": "string" }, "registered_name": { "type": "string" }, "passport_number_confirmation": { "type": "string" }, "date_of_birth": { "type": "string" }, "date_of_application": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "verification_status": "string", "registered_name": "string", "passport_number_confirmation": "string", "date_of_birth": "string", "date_of_application": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/driving-license-verification": { "post": { "operationId": "driving_license_verification", "summary": "Driving Licence Verification", "description": "Confirm a driving licence is valid, current and permits the right vehicle class.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "driving_licence_number": { "type": "string", "title": "Driving licence number" }, "date_of_birth": { "type": "string", "title": "Date of birth" } }, "required": [ "driving_licence_number", "date_of_birth" ] }, "example": { "driving_licence_number": "string", "date_of_birth": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "verification_status": { "type": "string" }, "registered_name": { "type": "string" }, "issuing_state": { "type": "string" }, "valid_until": { "type": "string" }, "permitted_vehicle_classes": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "verification_status": "string", "registered_name": "string", "issuing_state": "string", "valid_until": "string", "permitted_vehicle_classes": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/voter-id-verification": { "post": { "operationId": "voter_id_verification", "summary": "Voter ID Verification", "description": "Validate an EPIC number and retrieve the registered name and constituency.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "voter_i_d_e_p_i_c_number": { "type": "string", "title": "Voter ID (EPIC number)" }, "state": { "type": "string", "title": "State" } }, "required": [ "voter_i_d_e_p_i_c_number" ] }, "example": { "voter_i_d_e_p_i_c_number": "string", "state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "verification_status": { "type": "string" }, "registered_name": { "type": "string" }, "registered_address": { "type": "string" }, "constituency": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "verification_status": "string", "registered_name": "string", "registered_address": "string", "constituency": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/aadhaar-ekyc-otp": { "post": { "operationId": "aadhaar_ekyc_otp", "summary": "Aadhaar eKYC (OTP)", "description": "Full Aadhaar eKYC with a one-time password on the registered mobile.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aadhaar_number": { "type": "string", "title": "Aadhaar number" }, "o_t_p_entered_by_the_person": { "type": "string", "title": "OTP entered by the person" } }, "required": [ "aadhaar_number", "o_t_p_entered_by_the_person" ] }, "example": { "aadhaar_number": "string", "o_t_p_entered_by_the_person": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "verified_name": { "type": "string" }, "date_of_birth": { "type": "string" }, "gender": { "type": "string" }, "full_address": { "type": "string" }, "photograph": { "type": "string" }, "masked_aadhaar": { "type": "string" }, "consent_reference": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "verified_name": "string", "date_of_birth": "string", "gender": "string", "full_address": "string", "photograph": "string", "masked_aadhaar": "string", "consent_reference": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/ckyc-search": { "post": { "operationId": "ckyc_search", "summary": "CKYC Search & Download", "description": "Look up an existing central KYC record and reuse it with consent.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "p_a_n_or_other_i_d_number": { "type": "string", "title": "PAN or other ID number" }, "date_of_birth": { "type": "string", "title": "Date of birth" }, "customer_authorisation_for_download": { "type": "string", "title": "Customer authorisation for download" } }, "required": [ "p_a_n_or_other_i_d_number" ] }, "example": { "p_a_n_or_other_i_d_number": "string", "date_of_birth": "string", "customer_authorisation_for_download": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "c_k_y_c_record_found": { "type": "string" }, "c_k_y_c_identifier": { "type": "string" }, "k_y_c_record_with_identity_and_address_details_on_download": { "type": "string" }, "record_update_date": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "c_k_y_c_record_found": "string", "c_k_y_c_identifier": "string", "k_y_c_record_with_identity_and_address_details_on_download": "string", "record_update_date": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/id-document-ocr": { "post": { "operationId": "id_document_ocr", "summary": "ID Document OCR", "description": "Extract structured data from Aadhaar, PAN, passport, DL, voter ID and more.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "document_image_front_and_back_where_applicable": { "type": "string", "title": "Document image (front, and back where applicable)" }, "expected_document_type": { "type": "string", "title": "Expected document type" } }, "required": [ "document_image_front_and_back_where_applicable" ] }, "example": { "document_image_front_and_back_where_applicable": "string", "expected_document_type": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "detected_document_type": { "type": "string" }, "extracted_fields": { "type": "string" }, "image_quality_score": { "type": "string" }, "masked_identifiers": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "detected_document_type": "string", "extracted_fields": "string", "image_quality_score": "string", "masked_identifiers": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/face-match": { "post": { "operationId": "face_match", "summary": "Face Match", "description": "Compare a selfie to the photo on an ID document or KYC record.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selfie_image": { "type": "string", "title": "Selfie image" }, "reference_photo_i_d_document_or_k_y_c_record": { "type": "string", "title": "Reference photo (ID document or KYC record)" } }, "required": [ "selfie_image", "reference_photo_i_d_document_or_k_y_c_record" ] }, "example": { "selfie_image": "string", "reference_photo_i_d_document_or_k_y_c_record": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "match_score": { "type": "string" }, "match_decision_against_threshold": { "type": "string" }, "face_detected_in_each_image": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "match_score": "string", "match_decision_against_threshold": "string", "face_detected_in_each_image": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/liveness-detection": { "post": { "operationId": "liveness_detection", "summary": "Liveness Detection", "description": "Prove the selfie is a live person, not a photo, screen or mask.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selfie_image_or_short_capture": { "type": "string", "title": "Selfie image or short capture" } }, "required": [ "selfie_image_or_short_capture" ] }, "example": { "selfie_image_or_short_capture": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "liveness_decision": { "type": "string" }, "confidence_score": { "type": "string" }, "capture_quality_feedback": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "liveness_decision": "string", "confidence_score": "string", "capture_quality_feedback": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/video-kyc": { "post": { "operationId": "video_kyc", "summary": "Video KYC", "description": "Agent-assisted or self-serve video identification with recording and audit trail.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_name_and_contact_for_the_session_link": { "type": "string", "title": "Customer name and contact for the session link" }, "documents_to_capture_and_checks_to_run": { "type": "string", "title": "Documents to capture and checks to run" } }, "required": [ "customer_name_and_contact_for_the_session_link", "documents_to_capture_and_checks_to_run" ] }, "example": { "customer_name_and_contact_for_the_session_link": "string", "documents_to_capture_and_checks_to_run": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "session_outcome": { "type": "string" }, "extracted_document_data": { "type": "string" }, "liveness_and_face_match_results": { "type": "string" }, "geo_location_and_timestamps": { "type": "string" }, "recording_and_audit_trail_reference": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "session_outcome": "string", "extracted_document_data": "string", "liveness_and_face_match_results": "string", "geo_location_and_timestamps": "string", "recording_and_audit_trail_reference": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/aadhaar-masking": { "post": { "operationId": "aadhaar_masking", "summary": "Aadhaar Masking", "description": "Automatically mask the first eight digits on Aadhaar images and PDFs.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aadhaar_image_or_p_d_f": { "type": "string", "title": "Aadhaar image or PDF" } }, "required": [ "aadhaar_image_or_p_d_f" ] }, "example": { "aadhaar_image_or_p_d_f": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "masked_document": { "type": "string" }, "number_detected": { "type": "string" }, "confidence_flag": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "masked_document": "string", "number_detected": "string", "confidence_flag": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/name-match": { "post": { "operationId": "name_match", "summary": "Name Match", "description": "Score how well two names match, allowing for initials, order and spelling.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name_one": { "type": "string", "title": "Name one" }, "name_two": { "type": "string", "title": "Name two" } }, "required": [ "name_one", "name_two" ] }, "example": { "name_one": "string", "name_two": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "match_score": { "type": "string" }, "match_decision_against_threshold": { "type": "string" }, "explanation_of_differences": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "match_score": "string", "match_decision_against_threshold": "string", "explanation_of_differences": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/gstin-verification": { "post": { "operationId": "gstin_verification", "summary": "GSTIN Verification", "description": "Confirm GST registration, legal name, emver type and filing compliance.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "g_s_t_i_n": { "type": "string", "title": "GSTIN" }, "company_name": { "type": "string", "title": "Company name" } }, "required": [ "g_s_t_i_n" ] }, "example": { "g_s_t_i_n": "string", "company_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registration_status": { "type": "string" }, "legal_name": { "type": "string" }, "trade_name": { "type": "string" }, "business_type__constitution": { "type": "string" }, "date_of_registration": { "type": "string" }, "return_filing_compliance": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "registration_status": "string", "legal_name": "string", "trade_name": "string", "business_type__constitution": "string", "date_of_registration": "string", "return_filing_compliance": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/gstin-by-pan": { "post": { "operationId": "gstin_by_pan", "summary": "GSTIN by PAN", "description": "Discover every GST registration held against a PAN.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "p_a_n_number": { "type": "string", "title": "PAN number" } }, "required": [ "p_a_n_number" ] }, "example": { "p_a_n_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "p_a_n_confirmation": { "type": "string" }, "list_of_g_s_t_i_ns_with_state_and_status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "p_a_n_confirmation": "string", "list_of_g_s_t_i_ns_with_state_and_status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/tan-verification": { "post": { "operationId": "tan_verification", "summary": "TAN Verification", "description": "Validate a Tax Deduction Account Number and resolve the deductor.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "t_a_n": { "type": "string", "title": "TAN" } }, "required": [ "t_a_n" ] }, "example": { "t_a_n": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "t_a_n_status": { "type": "string" }, "registered_company__deductor_name": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "t_a_n_status": "string", "registered_company__deductor_name": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mca-company-lookup": { "post": { "operationId": "mca_company_lookup", "summary": "Company (MCA) Lookup", "description": "Incorporation status, company type, registered office and filing compliance from the corporate registry.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "c_i_n_registration_number": { "type": "string", "title": "CIN / registration number" }, "company_name": { "type": "string", "title": "Company name" } }, "required": [ "c_i_n_registration_number" ] }, "example": { "c_i_n_registration_number": "string", "company_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "incorporation_status": { "type": "string" }, "company_type": { "type": "string" }, "date_of_incorporation": { "type": "string" }, "registered_office_address": { "type": "string" }, "annual_filing_compliance": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "incorporation_status": "string", "company_type": "string", "date_of_incorporation": "string", "registered_office_address": "string", "annual_filing_compliance": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mca-directorship-lookup": { "post": { "operationId": "mca_directorship_lookup", "summary": "Directorship (DIN) Lookup", "description": "Resolve a person's directorships and DIN status from the corporate registry.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "p_a_n_number": { "type": "string", "title": "PAN number" }, "full_name": { "type": "string", "title": "Full name" }, "date_of_birth": { "type": "string", "title": "Date of birth" }, "d_i_n": { "type": "string", "title": "DIN" } }, "required": [ "p_a_n_number" ] }, "example": { "p_a_n_number": "string", "full_name": "string", "date_of_birth": "string", "d_i_n": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "d_i_n_status": { "type": "string" }, "registered_name": { "type": "string" }, "list_of_companies_with_directorship_role": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "d_i_n_status": "string", "registered_name": "string", "list_of_companies_with_directorship_role": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/udyam-verification": { "post": { "operationId": "udyam_verification", "summary": "Udyam / MSME Verification", "description": "Confirm MSME registration, emver type and major activity.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "udyam_registration_number": { "type": "string", "title": "Udyam registration number" } }, "required": [ "udyam_registration_number" ] }, "example": { "udyam_registration_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "enterprise_name": { "type": "string" }, "enterprise_type": { "type": "string" }, "major_activity": { "type": "string" }, "registration_date": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "enterprise_name": "string", "enterprise_type": "string", "major_activity": "string", "registration_date": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/iec-verification": { "post": { "operationId": "iec_verification", "summary": "IEC Verification", "description": "Validate an Import Export Code and the entity behind it.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "i_e_c_number": { "type": "string", "title": "IEC number" }, "company_name": { "type": "string", "title": "Company name" } }, "required": [ "i_e_c_number" ] }, "example": { "i_e_c_number": "string", "company_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "entity_name": { "type": "string" }, "i_e_c_status": { "type": "string" }, "issue_date": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "entity_name": "string", "i_e_c_status": "string", "issue_date": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/fssai-verification": { "post": { "operationId": "fssai_verification", "summary": "FSSAI Licence Verification", "description": "Verify a food emver licence, its status and validity.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "f_s_s_a_i_licence_number": { "type": "string", "title": "FSSAI licence number" } }, "required": [ "f_s_s_a_i_licence_number" ] }, "example": { "f_s_s_a_i_licence_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "business_name": { "type": "string" }, "licence_status": { "type": "string" }, "valid_until": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "business_name": "string", "licence_status": "string", "valid_until": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/gst-filing-status": { "post": { "operationId": "gst_filing_status", "summary": "GST Return Filing Status", "description": "Month-by-month GST return filing history for a GSTIN.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "g_s_t_i_n": { "type": "string", "title": "GSTIN" }, "financial_year": { "type": "string", "title": "Financial year" } }, "required": [ "g_s_t_i_n" ] }, "example": { "g_s_t_i_n": "string", "financial_year": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "filing_history_by_period_and_return_type": { "type": "string" }, "filing_dates": { "type": "string" }, "delayed_and_missing_periods": { "type": "string" }, "overall_compliance_rating": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "filing_history_by_period_and_return_type": "string", "filing_dates": "string", "delayed_and_missing_periods": "string", "overall_compliance_rating": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mca-company-financials": { "post": { "operationId": "mca_company_financials", "summary": "Company Financials (MCA)", "description": "Filed financial statements, charges and shareholding from the corporate registry.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "c_i_n": { "type": "string", "title": "CIN" }, "financial_years": { "type": "string", "title": "Financial years" } }, "required": [ "c_i_n" ] }, "example": { "c_i_n": "string", "financial_years": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "revenue__profit_and_net_worth_by_year": { "type": "string" }, "registered_charges_and_lenders": { "type": "string" }, "directors_and_signatories": { "type": "string" }, "shareholding_summary": { "type": "string" }, "filing_dates": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "revenue__profit_and_net_worth_by_year": "string", "registered_charges_and_lenders": "string", "directors_and_signatories": "string", "shareholding_summary": "string", "filing_dates": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/shop-establishment-verification": { "post": { "operationId": "shop_establishment_verification", "summary": "Shop & Establishment Verification", "description": "Confirm a state shop and establishment registration and the emver behind it.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_number": { "type": "string", "title": "Registration number" }, "state": { "type": "string", "title": "State" } }, "required": [ "registration_number", "state" ] }, "example": { "registration_number": "string", "state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "business_name": { "type": "string" }, "owner_or_employer_name": { "type": "string" }, "registered_address": { "type": "string" }, "licence_status_and_validity": { "type": "string" }, "nature_of_business": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "business_name": "string", "owner_or_employer_name": "string", "registered_address": "string", "licence_status_and_validity": "string", "nature_of_business": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/bank-account-verification": { "post": { "operationId": "bank_account_verification", "summary": "Bank Account Verification", "description": "Confirm an account exists and belongs to the person or emver you are paying.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "account_number": { "type": "string", "title": "Account number" }, "i_f_s_c_code": { "type": "string", "title": "IFSC code" }, "account_holder_name": { "type": "string", "title": "Account holder name" }, "p_a_n_number": { "type": "string", "title": "PAN number" } }, "required": [ "account_number", "i_f_s_c_code" ] }, "example": { "account_number": "string", "i_f_s_c_code": "string", "account_holder_name": "string", "p_a_n_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "account_exists": { "type": "string" }, "name_as_per_bank": { "type": "string" }, "name_match_result": { "type": "string" }, "bank_name": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "account_exists": "string", "name_as_per_bank": "string", "name_match_result": "string", "bank_name": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/upi-verification": { "post": { "operationId": "upi_verification", "summary": "UPI Verification", "description": "Resolve a UPI ID to its registered account holder and match the name.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "u_p_i_i_d_v_p_a": { "type": "string", "title": "UPI ID (VPA)" }, "name_to_match": { "type": "string", "title": "Name to match" } }, "required": [ "u_p_i_i_d_v_p_a" ] }, "example": { "u_p_i_i_d_v_p_a": "string", "name_to_match": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "account_holder_name": { "type": "string" }, "name_match_result": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "account_holder_name": "string", "name_match_result": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/credit-report": { "post": { "operationId": "credit_report", "summary": "Credit Report", "description": "Consent-based credit score and report for lending and financial-role screening.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "p_a_n_number": { "type": "string", "title": "PAN number" }, "full_name": { "type": "string", "title": "Full name" }, "registered_mobile": { "type": "string", "title": "Registered mobile" } }, "required": [ "p_a_n_number", "full_name", "registered_mobile" ] }, "example": { "p_a_n_number": "string", "full_name": "string", "registered_mobile": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "credit_score": { "type": "string" }, "registered_name": { "type": "string" }, "full_credit_report": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "credit_score": "string", "registered_name": "string", "full_credit_report": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/ifsc-lookup": { "post": { "operationId": "ifsc_lookup", "summary": "IFSC & Bank Branch Lookup", "description": "Resolve an IFSC to its bank, branch, address and supported payment rails.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "i_f_s_c_code": { "type": "string", "title": "IFSC code" } }, "required": [ "i_f_s_c_code" ] }, "example": { "i_f_s_c_code": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "bank_name": { "type": "string" }, "branch_name_and_address": { "type": "string" }, "city_and_state": { "type": "string" }, "supported_rails": { "type": "string" }, "contact_details": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "bank_name": "string", "branch_name_and_address": "string", "city_and_state": "string", "supported_rails": "string", "contact_details": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/reverse-penny-drop": { "post": { "operationId": "reverse_penny_drop", "summary": "Reverse Penny Drop", "description": "Verify bank account ownership by having the person pay one rupee via UPI.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "person_s_reference_for_the_payment_link": { "type": "string", "title": "Person's reference for the payment link" } }, "required": [ "person_s_reference_for_the_payment_link" ] }, "example": { "person_s_reference_for_the_payment_link": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "account_number_and_i_f_s_c_as_seen_by_the_bank": { "type": "string" }, "account_holder_name": { "type": "string" }, "u_p_i_i_d_used": { "type": "string" }, "verification_status": { "type": "string" }, "refund_status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "account_number_and_i_f_s_c_as_seen_by_the_bank": "string", "account_holder_name": "string", "u_p_i_i_d_used": "string", "verification_status": "string", "refund_status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/bank-statement-analysis": { "post": { "operationId": "bank_statement_analysis", "summary": "Bank Statement Analysis", "description": "Turn PDF statements into categorised transactions, income and risk indicators.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "statement_p_d_fs_with_password_if_protected": { "type": "string", "title": "Statement PDFs (with password if protected)" }, "consent_reference_for_account_aggregator_fetch": { "type": "string", "title": "Consent reference for account-aggregator fetch" } }, "required": [ "statement_p_d_fs_with_password_if_protected" ] }, "example": { "statement_p_d_fs_with_password_if_protected": "string", "consent_reference_for_account_aggregator_fetch": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "parsed_transactions": { "type": "string" }, "categorised_inflows_and_outflows": { "type": "string" }, "detected_salary_credits_and_employer": { "type": "string" }, "e_m_i_and_loan_obligations": { "type": "string" }, "bounces_and_penalties": { "type": "string" }, "average_and_minimum_balances": { "type": "string" }, "tamper_check_result": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "parsed_transactions": "string", "categorised_inflows_and_outflows": "string", "detected_salary_credits_and_employer": "string", "e_m_i_and_loan_obligations": "string", "bounces_and_penalties": "string", "average_and_minimum_balances": "string", "tamper_check_result": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/business-credit-report": { "post": { "operationId": "business_credit_report", "summary": "emver Credit Report", "description": "Commercial bureau report and score for a company or proprietorship.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity_p_a_n_or_c_i_n": { "type": "string", "title": "Entity PAN or CIN" }, "entity_name_and_address": { "type": "string", "title": "Entity name and address" }, "authorised_signatory_consent": { "type": "string", "title": "Authorised signatory consent" } }, "required": [ "entity_p_a_n_or_c_i_n", "entity_name_and_address", "authorised_signatory_consent" ] }, "example": { "entity_p_a_n_or_c_i_n": "string", "entity_name_and_address": "string", "authorised_signatory_consent": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "commercial_credit_score": { "type": "string" }, "credit_facilities_and_outstanding": { "type": "string" }, "repayment_history_and_overdues": { "type": "string" }, "suits_and_defaults": { "type": "string" }, "recent_enquiries": { "type": "string" }, "full_report": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "commercial_credit_score": "string", "credit_facilities_and_outstanding": "string", "repayment_history_and_overdues": "string", "suits_and_defaults": "string", "recent_enquiries": "string", "full_report": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/icai-verification": { "post": { "operationId": "icai_verification", "summary": "ICAI Membership Verification", "description": "Confirm a Chartered Accountant's membership number, status and type.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "i_c_a_i_membership_number": { "type": "string", "title": "ICAI membership number" } }, "required": [ "i_c_a_i_membership_number" ] }, "example": { "i_c_a_i_membership_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "member_name": { "type": "string" }, "membership_status": { "type": "string" }, "membership_type": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "member_name": "string", "membership_status": "string", "membership_type": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/rc-verification": { "post": { "operationId": "rc_verification", "summary": "Vehicle RC Verification", "description": "Verify a vehicle registration and its owner from the national vehicle registry.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vehicle_registration_number": { "type": "string", "title": "Vehicle registration number" } }, "required": [ "vehicle_registration_number" ] }, "example": { "vehicle_registration_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "owner_name": { "type": "string" }, "make_and_model": { "type": "string" }, "registration_date": { "type": "string" }, "fuel_type": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "owner_name": "string", "make_and_model": "string", "registration_date": "string", "fuel_type": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/vehicle-challan": { "post": { "operationId": "vehicle_challan", "summary": "Vehicle Challan Check", "description": "Pending and paid traffic challans for a vehicle or driving licence.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vehicle_registration_number_or_d_l_number": { "type": "string", "title": "Vehicle registration number or DL number" } }, "required": [ "vehicle_registration_number_or_d_l_number" ] }, "example": { "vehicle_registration_number_or_d_l_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "list_of_challans_with_date_and_offence": { "type": "string" }, "amount_and_payment_status": { "type": "string" }, "issuing_authority": { "type": "string" }, "total_pending_amount": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "list_of_challans_with_date_and_offence": "string", "amount_and_payment_status": "string", "issuing_authority": "string", "total_pending_amount": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/dual-employment-check": { "post": { "operationId": "dual_employment_check", "summary": "Dual emver Check", "description": "Detect concurrent emver from overlapping provident fund contributions.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "u_a_n_number": { "type": "string", "title": "UAN number" }, "current_employer_name": { "type": "string", "title": "Current employer name" } }, "required": [ "u_a_n_number" ] }, "example": { "u_a_n_number": "string", "current_employer_name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "dual_employment_detected": { "type": "string" }, "overlapping_periods": { "type": "string" }, "establishments_involved": { "type": "string" }, "current_active_establishments": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "dual_employment_detected": "string", "overlapping_periods": "string", "establishments_involved": "string", "current_active_establishments": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/employer-search": { "post": { "operationId": "employer_search", "summary": "Employer Establishment Search", "description": "Find a company's provident fund establishment record and confirm it is a real employer.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer_name_or_establishment_code": { "type": "string", "title": "Employer name or establishment code" }, "city_or_state": { "type": "string", "title": "City or state" } }, "required": [ "employer_name_or_establishment_code" ] }, "example": { "employer_name_or_establishment_code": "string", "city_or_state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "matching_establishments": { "type": "string" }, "establishment_i_d_and_registration_date": { "type": "string" }, "registered_address": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "matching_establishments": "string", "establishment_i_d_and_registration_date": "string", "registered_address": "string", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/esic-verification": { "post": { "operationId": "esic_verification", "summary": "ESIC Verification", "description": "Confirm an employee's state insurance registration and the employer behind it.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "e_s_i_c_insurance_number": { "type": "string", "title": "ESIC insurance number" } }, "required": [ "e_s_i_c_insurance_number" ] }, "example": { "e_s_i_c_insurance_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "insured_person_s_name": { "type": "string" }, "registration_date": { "type": "string" }, "employer_name_and_code": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "insured_person_s_name": "string", "registration_date": "string", "employer_name_and_code": "string", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/education-verification": { "post": { "operationId": "education_verification", "summary": "Education Verification", "description": "Confirm degrees and diplomas with the issuing university or through the national credential repository.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "candidate_name_and_date_of_birth": { "type": "string", "title": "Candidate name and date of birth" }, "institution_degree_and_year": { "type": "string", "title": "Institution, degree and year" }, "certificate_or_roll_number": { "type": "string", "title": "Certificate or roll number" }, "certificate_image": { "type": "string", "title": "Certificate image" } }, "required": [ "candidate_name_and_date_of_birth", "institution_degree_and_year" ] }, "example": { "candidate_name_and_date_of_birth": "string", "institution_degree_and_year": "string", "certificate_or_roll_number": "string", "certificate_image": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "verification_outcome": { "type": "string" }, "degree__specialisation_and_year": { "type": "string" }, "institution_confirmation": { "type": "string" }, "result_or_class": { "type": "string" }, "evidence_reference": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "verification_outcome": "string", "degree__specialisation_and_year": "string", "institution_confirmation": "string", "result_or_class": "string", "evidence_reference": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mobile-number-verification": { "post": { "operationId": "mobile_number_verification", "summary": "Mobile Number Verification", "description": "Confirm a mobile number is active, who it is registered to and which network serves it.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile_number": { "type": "string", "title": "Mobile number" }, "name_to_match": { "type": "string", "title": "Name to match" } }, "required": [ "mobile_number" ] }, "example": { "mobile_number": "9999999999", "name_to_match": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "active_status": { "type": "string" }, "operator_and_telecom_circle": { "type": "string" }, "connection_type": { "type": "string" }, "name_match_result_where_available": { "type": "string" }, "ported": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "active_status": "string", "operator_and_telecom_circle": "string", "connection_type": "string", "name_match_result_where_available": "string", "ported": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/email-verification": { "post": { "operationId": "email_verification", "summary": "Email Verification", "description": "Check an email address is deliverable, not disposable and consistent with the person.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email_address": { "type": "string", "title": "Email address" } }, "required": [ "email_address" ] }, "example": { "email_address": "name@example.com" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "deliverable": { "type": "string" }, "disposable_or_role_address_flag": { "type": "string" }, "domain_and_provider_type": { "type": "string" }, "risk_score": { "type": "string" }, "suggested_correction_for_typos": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "deliverable": "string", "disposable_or_role_address_flag": "string", "domain_and_provider_type": "string", "risk_score": "string", "suggested_correction_for_typos": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/digital-address-verification": { "post": { "operationId": "digital_address_verification", "summary": "Digital Address Verification", "description": "Verify a residential address with geo-tagged, timestamped photos captured by the person.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "person_s_name_and_contact_for_the_capture_link": { "type": "string", "title": "Person's name and contact for the capture link" }, "declared_address": { "type": "string", "title": "Declared address" } }, "required": [ "person_s_name_and_contact_for_the_capture_link", "declared_address" ] }, "example": { "person_s_name_and_contact_for_the_capture_link": "string", "declared_address": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "verification_outcome": { "type": "string" }, "distance_between_declared_and_captured_location": { "type": "string" }, "photo_evidence_with_g_p_s_and_timestamps": { "type": "string" }, "anti_spoofing_checks": { "type": "string" }, "reviewer_notes_where_applicable": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "verification_outcome": "string", "distance_between_declared_and_captured_location": "string", "photo_evidence_with_g_p_s_and_timestamps": "string", "anti_spoofing_checks": "string", "reviewer_notes_where_applicable": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/aml-screening": { "post": { "operationId": "aml_screening", "summary": "AML & Sanctions Screening", "description": "Screen people and entities against global sanctions, PEP and watchlists.", "tags": [ "Risk & Compliance" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name_individual_or_entity": { "type": "string", "title": "Name (individual or entity)" }, "date_of_birth_or_incorporation": { "type": "string", "title": "Date of birth or incorporation" }, "nationality_or_country": { "type": "string", "title": "Nationality or country" }, "identifiers_p_a_n_passport": { "type": "string", "title": "Identifiers (PAN, passport)" } }, "required": [ "name_individual_or_entity" ] }, "example": { "name_individual_or_entity": "string", "date_of_birth_or_incorporation": "string", "nationality_or_country": "string", "identifiers_p_a_n_passport": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "match_status": { "type": "string" }, "ranked_matches_with_score": { "type": "string" }, "list__category_and_reason": { "type": "string" }, "p_e_p_level_and_relationships": { "type": "string" }, "profile_summary_for_each_match": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "match_status": "string", "ranked_matches_with_score": "string", "list__category_and_reason": "string", "p_e_p_level_and_relationships": "string", "profile_summary_for_each_match": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/court-records-check": { "post": { "operationId": "court_records_check", "summary": "Court & Criminal Records Check", "description": "Search civil and criminal case records across Indian courts for a person or entity.", "tags": [ "Risk & Compliance" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "full_name": { "type": "string", "title": "Full name" }, "father_s_or_spouse_s_name": { "type": "string", "title": "Father's or spouse's name" }, "address_or_district": { "type": "string", "title": "Address or district" }, "date_of_birth": { "type": "string", "title": "Date of birth" } }, "required": [ "full_name" ] }, "example": { "full_name": "string", "father_s_or_spouse_s_name": "string", "address_or_district": "string", "date_of_birth": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "records_found": { "type": "string" }, "matched_cases_with_court_and_case_number": { "type": "string" }, "case_type__status_and_year": { "type": "string" }, "parties_and_match_score": { "type": "string" }, "adjudication_notes_where_reviewed": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "records_found": "string", "matched_cases_with_court_and_case_number": "string", "case_type__status_and_year": "string", "parties_and_match_score": "string", "adjudication_notes_where_reviewed": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/adverse-media-screening": { "post": { "operationId": "adverse_media_screening", "summary": "Adverse Media Screening", "description": "Find negative news about a person or company across news and public sources.", "tags": [ "Risk & Compliance" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name_individual_or_entity": { "type": "string", "title": "Name (individual or entity)" }, "context_company_location_role": { "type": "string", "title": "Context (company, location, role)" } }, "required": [ "name_individual_or_entity" ] }, "example": { "name_individual_or_entity": "string", "context_company_location_role": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "articles_found_with_source_and_date": { "type": "string" }, "risk_category_per_article": { "type": "string" }, "relevance_score": { "type": "string" }, "summary_of_allegations": { "type": "string" }, "monitoring_alerts": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "articles_found_with_source_and_date": "string", "risk_category_per_article": "string", "relevance_score": "string", "summary_of_allegations": "string", "monitoring_alerts": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/aadhaar-offline-ekyc": { "post": { "operationId": "aadhaar_offline_ekyc", "summary": "Aadhaar Offline eKYC", "description": "Paperless offline KYC: the person shares a UIDAI-signed XML and you get verified demographics and photo.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ekyc_file": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Offline e-KYC ZIP file" }, "share_code": { "type": "string", "title": "Share code" } }, "required": [ "ekyc_file", "share_code" ] }, "example": { "ekyc_file": "", "share_code": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "signature_valid": { "type": "boolean" }, "reference_id": { "type": "string" }, "name": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "gender": { "type": "string" }, "address": { "type": "string" }, "photo": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "signature_valid": true, "reference_id": "string", "name": "string", "dob": "YYYY-MM-DD", "gender": "string", "address": "string", "photo": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/ration-card-verification": { "post": { "operationId": "ration_card_verification", "summary": "Ration Card Verification", "description": "Confirm a ration card number and the household members listed on it.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ration_card_number": { "type": "string", "title": "Ration card number" }, "state": { "type": "string", "title": "State" } }, "required": [ "ration_card_number", "state" ] }, "example": { "ration_card_number": "string", "state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "card_type": { "type": "string" }, "head_of_family": { "type": "string" }, "district": { "type": "string" }, "members": { "type": "array", "items": { "type": "object" } }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "card_type": "string", "head_of_family": "string", "district": "string", "members": [], "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/doctor-verification": { "post": { "operationId": "doctor_verification", "summary": "Doctor Registration Verification", "description": "Verify a medical practitioner's registration with the national or state medical council.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_number": { "type": "string", "title": "Registration number" }, "council": { "type": "string", "title": "Medical council" }, "name": { "type": "string", "title": "Doctor's name" } }, "required": [ "registration_number", "council" ] }, "example": { "registration_number": "string", "council": "string", "name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registered_name": { "type": "string" }, "qualification": { "type": "string" }, "registration_year": { "type": "string" }, "council": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "registered_name": "string", "qualification": "string", "registration_year": "string", "council": "string", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/nurse-verification": { "post": { "operationId": "nurse_verification", "summary": "Nurse Registration Verification", "description": "Confirm a nurse or midwife is registered with the state nursing council.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_number": { "type": "string", "title": "Registration number" }, "council": { "type": "string", "title": "Nursing council" } }, "required": [ "registration_number", "council" ] }, "example": { "registration_number": "string", "council": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registered_name": { "type": "string" }, "qualification": { "type": "string" }, "valid_until": { "type": "string", "format": "date" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "registered_name": "string", "qualification": "string", "valid_until": "YYYY-MM-DD", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/advocate-verification": { "post": { "operationId": "advocate_verification", "summary": "Advocate Enrolment Verification", "description": "Verify a lawyer's enrolment number with the state bar council.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enrolment_number": { "type": "string", "title": "Enrolment number" }, "name": { "type": "string", "title": "Advocate's name" } }, "required": [ "enrolment_number" ] }, "example": { "enrolment_number": "string", "name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registered_name": { "type": "string" }, "bar_council": { "type": "string" }, "enrolment_date": { "type": "string", "format": "date" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "registered_name": "string", "bar_council": "string", "enrolment_date": "YYYY-MM-DD", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/rera-verification": { "post": { "operationId": "rera_verification", "summary": "RERA Verification", "description": "Verify a RERA-registered project or real-estate agent.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rera_number": { "type": "string", "title": "RERA registration number" }, "state": { "type": "string", "title": "State" } }, "required": [ "rera_number", "state" ] }, "example": { "rera_number": "string", "state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registration_type": { "type": "string" }, "registered_name": { "type": "string" }, "promoter": { "type": "string" }, "valid_from": { "type": "string", "format": "date" }, "valid_until": { "type": "string", "format": "date" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "registration_type": "string", "registered_name": "string", "promoter": "string", "valid_from": "YYYY-MM-DD", "valid_until": "YYYY-MM-DD", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/drug-license-verification": { "post": { "operationId": "drug_license_verification", "summary": "Drug Licence Verification", "description": "Validate a pharmacy or drug distributor licence and its validity.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "license_number": { "type": "string", "title": "Drug licence number" }, "state": { "type": "string", "title": "State" } }, "required": [ "license_number", "state" ] }, "example": { "license_number": "string", "state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "licensee": { "type": "string" }, "license_type": { "type": "string" }, "address": { "type": "string" }, "valid_until": { "type": "string", "format": "date" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "licensee": "string", "license_type": "string", "address": "string", "valid_until": "YYYY-MM-DD", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/death-certificate-verification": { "post": { "operationId": "death_certificate_verification", "summary": "Death Certificate Verification", "description": "Validate a death certificate for claims, succession and account closure.", "tags": [ "Identity & KYC" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "certificate_number": { "type": "string", "title": "Certificate / registration number" }, "state": { "type": "string", "title": "State" }, "name": { "type": "string", "title": "Name of the deceased" } }, "required": [ "certificate_number", "state" ] }, "example": { "certificate_number": "string", "state": "string", "name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registered_name": { "type": "string" }, "date_of_death": { "type": "string", "format": "date" }, "registration_date": { "type": "string", "format": "date" }, "authority": { "type": "string" }, "match": { "type": "boolean" } } } } }, "example": { "status": 200, "message": "string", "data": { "registered_name": "string", "date_of_death": "YYYY-MM-DD", "registration_date": "YYYY-MM-DD", "authority": "string", "match": true } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/signature-match": { "post": { "operationId": "signature_match", "summary": "Signature Match", "description": "Compare a signature on a document with a reference specimen and get a match score.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reference_image": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Reference signature image" }, "document_image": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Document image" }, "threshold": { "type": "number", "title": "Match threshold (0\u2013100)" } }, "required": [ "reference_image", "document_image" ] }, "example": { "reference_image": "", "document_image": "", "threshold": 0 } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "match": { "type": "boolean" }, "score": { "type": "number" }, "signature_detected": { "type": "boolean" } } } } }, "example": { "status": 200, "message": "string", "data": { "match": true, "score": 0, "signature_detected": true } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/deepfake-detection": { "post": { "operationId": "deepfake_detection", "summary": "Deepfake Detection", "description": "Flag synthetic or manipulated faces in selfies and video frames.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "media": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Selfie image or video" }, "threshold": { "type": "number", "title": "Risk threshold (0\u2013100)" } }, "required": [ "media" ] }, "example": { "media": "", "threshold": 0 } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "is_deepfake": { "type": "boolean" }, "risk_score": { "type": "number" }, "signals": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "is_deepfake": true, "risk_score": 0, "signals": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/document-tamper-check": { "post": { "operationId": "document_tamper_check", "summary": "Document Tamper Check", "description": "Detect edited, forged or template-generated documents before you trust their contents.", "tags": [ "Documents & Biometrics" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Document image or PDF" }, "document_type": { "type": "string", "title": "Document type hint" } }, "required": [ "document" ] }, "example": { "document": "", "document_type": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "tampered": { "type": "boolean" }, "score": { "type": "number" }, "anomalies": { "type": "array", "items": { "type": "object" } }, "regions": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "tampered": true, "score": 0, "anomalies": [], "regions": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/gst-otp-verification": { "post": { "operationId": "gst_otp_verification", "summary": "GST Verification with OTP", "description": "Consented GST pull: OTP to the registered mobile, then the complete profile and filing history.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gstin": { "type": "string", "title": "GSTIN" }, "otp": { "type": "string", "title": "OTP (second step)" } }, "required": [ "gstin" ] }, "example": { "gstin": "string", "otp": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "legal_name": { "type": "string" }, "trade_name": { "type": "string" }, "places_of_business": { "type": "array", "items": { "type": "object" } }, "filing_frequency": { "type": "string" }, "returns": { "type": "array", "items": { "type": "object" } }, "turnover_band": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "legal_name": "string", "trade_name": "string", "places_of_business": [], "filing_frequency": "string", "returns": [], "turnover_band": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mca-filed-documents": { "post": { "operationId": "mca_filed_documents", "summary": "MCA Filed Documents", "description": "Pull the statutory documents a company has filed with the registrar.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cin": { "type": "string", "title": "CIN / LLPIN" }, "document_id": { "type": "string", "title": "Document ID (to fetch one)" } }, "required": [ "cin" ] }, "example": { "cin": "string", "document_id": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object" } }, "document_url": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "documents": [], "document_url": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/company-search": { "post": { "operationId": "company_search", "summary": "Company Name Search", "description": "Find companies and LLPs by name and get their CIN or LLPIN.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "title": "Company name (partial allowed)" }, "state": { "type": "string", "title": "State filter" } }, "required": [ "query" ] }, "example": { "query": "string", "state": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "results": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/tds-206-compliance": { "post": { "operationId": "tds_206_compliance", "summary": "ITR Filing Status (Section 206AB)", "description": "Check whether a vendor is a \"specified person\" for higher TDS under section 206AB / 206CCA.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan_number": { "type": "string", "title": "Vendor PAN" }, "financial_year": { "type": "string", "title": "Financial year" } }, "required": [ "pan_number" ] }, "example": { "pan_number": "string", "financial_year": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "specified_person": { "type": "boolean" }, "pan_status": { "type": "string" }, "aadhaar_linked": { "type": "boolean" }, "financial_year": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "specified_person": true, "pan_status": "string", "aadhaar_linked": true, "financial_year": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/trademark-search": { "post": { "operationId": "trademark_search", "summary": "Trademark Search", "description": "Look up registered and pending trademarks by name, application number or owner.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "title": "Word mark or application number" }, "class": { "type": "number", "title": "Trademark class" } }, "required": [ "query" ] }, "example": { "query": "string", "class": 0 } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "results": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/ubo-check": { "post": { "operationId": "ubo_check", "summary": "Beneficial Ownership (UBO) Check", "description": "Trace who ultimately owns and controls a company.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cin": { "type": "string", "title": "CIN / LLPIN" }, "threshold": { "type": "number", "title": "Ownership threshold (%)" } }, "required": [ "cin" ] }, "example": { "cin": "string", "threshold": 0 } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "beneficial_owners": { "type": "array", "items": { "type": "object" } }, "ownership_chain": { "type": "array", "items": { "type": "object" } }, "as_of": { "type": "string", "format": "date" } } } } }, "example": { "status": 200, "message": "string", "data": { "beneficial_owners": [], "ownership_chain": [], "as_of": "YYYY-MM-DD" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/udyog-aadhaar-verification": { "post": { "operationId": "udyog_aadhaar_verification", "summary": "Udyog Aadhaar Verification", "description": "Validate a legacy Udyog Aadhaar (UAM) number for MSMEs that have not migrated to Udyam.", "tags": [ "Business & KYB" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uam_number": { "type": "string", "title": "Udyog Aadhaar number" } }, "required": [ "uam_number" ] }, "example": { "uam_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "enterprise_name": { "type": "string" }, "owner_name": { "type": "string" }, "enterprise_type": { "type": "string" }, "major_activity": { "type": "string" }, "registration_date": { "type": "string", "format": "date" } } } } }, "example": { "status": 200, "message": "string", "data": { "enterprise_name": "string", "owner_name": "string", "enterprise_type": "string", "major_activity": "string", "registration_date": "YYYY-MM-DD" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/bank-account-pennyless": { "post": { "operationId": "bank_account_pennyless", "summary": "Bank Account Verification (Penny-less)", "description": "Confirm an account and holder name without moving any money.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "account_number": { "type": "string", "title": "Account number" }, "ifsc": { "type": "string", "title": "IFSC" }, "name": { "type": "string", "title": "Name to match" } }, "required": [ "account_number", "ifsc" ] }, "example": { "account_number": "string", "ifsc": "string", "name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "account_exists": { "type": "boolean" }, "account_holder": { "type": "string" }, "name_match_score": { "type": "number" }, "method": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "account_exists": true, "account_holder": "string", "name_match_score": 0, "method": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/account-aggregator": { "post": { "operationId": "account_aggregator", "summary": "Account Aggregator Data Fetch", "description": "Consented bank statements and financial data through the Account Aggregator framework.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile": { "type": "string", "title": "Customer mobile" }, "purpose": { "type": "string", "title": "Purpose code" }, "from_date": { "type": "string", "format": "date", "title": "Data from" }, "to_date": { "type": "string", "format": "date", "title": "Data to" } }, "required": [ "mobile", "purpose", "from_date", "to_date" ] }, "example": { "mobile": "9999999999", "purpose": "string", "from_date": "YYYY-MM-DD", "to_date": "YYYY-MM-DD" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "consent_id": { "type": "string" }, "consent_status": { "type": "string" }, "accounts": { "type": "array", "items": { "type": "object" } }, "transactions": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "consent_id": "string", "consent_status": "string", "accounts": [], "transactions": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/enach-mandate": { "post": { "operationId": "enach_mandate", "summary": "e-NACH Mandate Registration", "description": "Register recurring debit mandates digitally with net-banking, debit-card or Aadhaar authentication.", "tags": [ "Banking & Credit" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "account_number": { "type": "string", "title": "Account number" }, "ifsc": { "type": "string", "title": "IFSC" }, "amount": { "type": "number", "title": "Maximum amount" }, "frequency": { "type": "string", "title": "Frequency" }, "start_date": { "type": "string", "format": "date", "title": "Start date" }, "end_date": { "type": "string", "format": "date", "title": "End date" } }, "required": [ "account_number", "ifsc", "amount", "frequency", "start_date" ] }, "example": { "account_number": "string", "ifsc": "string", "amount": 0, "frequency": "string", "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "mandate_id": { "type": "string" }, "authentication_url": { "type": "string" }, "status": { "type": "string" }, "umrn": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "mandate_id": "string", "authentication_url": "string", "status": "string", "umrn": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/fastag-verification": { "post": { "operationId": "fastag_verification", "summary": "FASTag Verification", "description": "Confirm a vehicle's FASTag status and issuing bank from its registration number.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_number": { "type": "string", "title": "Vehicle registration number" } }, "required": [ "registration_number" ] }, "example": { "registration_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "tag_active": { "type": "boolean" }, "issuer_bank": { "type": "string" }, "tag_class": { "type": "string" }, "tag_id": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "tag_active": true, "issuer_bank": "string", "tag_class": "string", "tag_id": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/vehicle-insurance-verification": { "post": { "operationId": "vehicle_insurance_verification", "summary": "Vehicle Insurance Verification", "description": "Confirm a vehicle is insured, by whom and until when.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_number": { "type": "string", "title": "Vehicle registration number" } }, "required": [ "registration_number" ] }, "example": { "registration_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "insured": { "type": "boolean" }, "insurer": { "type": "string" }, "policy_number": { "type": "string" }, "cover_type": { "type": "string" }, "valid_until": { "type": "string", "format": "date" } } } } }, "example": { "status": 200, "message": "string", "data": { "insured": true, "insurer": "string", "policy_number": "string", "cover_type": "string", "valid_until": "YYYY-MM-DD" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/national-permit-verification": { "post": { "operationId": "national_permit_verification", "summary": "National Permit Verification", "description": "Validate a commercial vehicle's national permit and its validity period.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_number": { "type": "string", "title": "Vehicle registration number" } }, "required": [ "registration_number" ] }, "example": { "registration_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "permit_valid": { "type": "boolean" }, "permit_type": { "type": "string" }, "permit_number": { "type": "string" }, "issuing_authority": { "type": "string" }, "valid_until": { "type": "string", "format": "date" } } } } }, "example": { "status": 200, "message": "string", "data": { "permit_valid": true, "permit_type": "string", "permit_number": "string", "issuing_authority": "string", "valid_until": "YYYY-MM-DD" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/income-verification": { "post": { "operationId": "income_verification", "summary": "Income Verification", "description": "Verify declared income from tax filings and salary credits with the person's consent.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pan_number": { "type": "string", "title": "PAN" }, "mobile": { "type": "string", "title": "Mobile (for consent)" }, "declared_income": { "type": "number", "title": "Declared annual income" } }, "required": [ "pan_number", "mobile" ] }, "example": { "pan_number": "string", "mobile": "9999999999", "declared_income": 0 } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "estimated_income": { "type": "number" }, "income_band": { "type": "string" }, "sources": { "type": "array", "items": { "type": "object" } }, "declared_match": { "type": "boolean" }, "confidence": { "type": "number" } } } } }, "example": { "status": 200, "message": "string", "data": { "estimated_income": 0, "income_band": "string", "sources": [], "declared_match": true, "confidence": 0 } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/form-16-verification": { "post": { "operationId": "form_16_verification", "summary": "Form 16 Verification", "description": "Validate a Form 16 against the TDS records it claims to reflect.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "form16": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Form 16 PDF" }, "pan_number": { "type": "string", "title": "Employee PAN" } }, "required": [ "form16" ] }, "example": { "form16": "", "pan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "genuine": { "type": "boolean" }, "employer_name": { "type": "string" }, "employer_tan": { "type": "string" }, "assessment_year": { "type": "string" }, "gross_salary": { "type": "number" }, "tds_deducted": { "type": "number" }, "discrepancies": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "genuine": true, "employer_name": "string", "employer_tan": "string", "assessment_year": "string", "gross_salary": 0, "tds_deducted": 0, "discrepancies": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/uan-lookup": { "post": { "operationId": "uan_lookup", "summary": "UAN Lookup", "description": "Find a person's Universal Account Number from their mobile or PAN.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile": { "type": "string", "title": "Mobile number" }, "pan_number": { "type": "string", "title": "PAN" } } }, "example": { "mobile": "9999999999", "pan_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "uans": { "type": "array", "items": { "type": "object" } }, "name": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "uans": [], "name": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/icsi-verification": { "post": { "operationId": "icsi_verification", "summary": "ICSI Membership Verification", "description": "Verify a Company Secretary's membership with the Institute of Company Secretaries of India.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "membership_number": { "type": "string", "title": "ICSI membership number" } }, "required": [ "membership_number" ] }, "example": { "membership_number": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "member_name": { "type": "string" }, "membership_type": { "type": "string" }, "practice_status": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "member_name": "string", "membership_type": "string", "practice_status": "string", "status": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/employment-verification": { "post": { "operationId": "employment_verification", "summary": "emver Verification (Employer Confirmation)", "description": "Direct confirmation of tenure, designation and exit reason from the previous employer.", "tags": [ "Workforce & Assets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "candidate_name": { "type": "string", "title": "Candidate name" }, "employer_name": { "type": "string", "title": "Employer name" }, "employee_id": { "type": "string", "title": "Employee ID" }, "from_date": { "type": "string", "format": "date", "title": "Tenure from" }, "to_date": { "type": "string", "format": "date", "title": "Tenure to" }, "designation": { "type": "string", "title": "Designation" }, "documents": { "type": "string", "format": "byte", "description": "Base64-encoded file content.", "title": "Supporting documents" } }, "required": [ "candidate_name", "employer_name", "from_date" ] }, "example": { "candidate_name": "string", "employer_name": "string", "employee_id": "string", "from_date": "YYYY-MM-DD", "to_date": "YYYY-MM-DD", "designation": "string", "documents": "" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "request_id": { "type": "string" }, "status": { "type": "string" }, "tenure_confirmed": { "type": "boolean" }, "designation_confirmed": { "type": "boolean" }, "exit_reason": { "type": "string" }, "eligible_for_rehire": { "type": "boolean" }, "report_url": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "request_id": "string", "status": "string", "tenure_confirmed": true, "designation_confirmed": true, "exit_reason": "string", "eligible_for_rehire": true, "report_url": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/mobile-to-name": { "post": { "operationId": "mobile_to_name", "summary": "Mobile to Name", "description": "Find the name registered against a mobile number.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile": { "type": "string", "title": "Mobile number" }, "name": { "type": "string", "title": "Name to match" } }, "required": [ "mobile" ] }, "example": { "mobile": "9999999999", "name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "registered_name": { "type": "string" }, "name_match_score": { "type": "number" } } } } }, "example": { "status": 200, "message": "string", "data": { "registered_name": "string", "name_match_score": 0 } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/telecom-operator-lookup": { "post": { "operationId": "telecom_operator_lookup", "summary": "Telecom Operator Lookup", "description": "Operator, circle, connection type and porting status for any Indian mobile number.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile": { "type": "string", "title": "Mobile number" } }, "required": [ "mobile" ] }, "example": { "mobile": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "active": { "type": "boolean" }, "operator": { "type": "string" }, "circle": { "type": "string" }, "connection_type": { "type": "string" }, "ported": { "type": "boolean" }, "revoked": { "type": "boolean" } } } } }, "example": { "status": 200, "message": "string", "data": { "active": true, "operator": "string", "circle": "string", "connection_type": "string", "ported": true, "revoked": true } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/whatsapp-number-check": { "post": { "operationId": "whatsapp_number_check", "summary": "WhatsApp Number Check", "description": "Know whether a number is reachable on WhatsApp before you message it.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile": { "type": "string", "title": "Mobile number" } }, "required": [ "mobile" ] }, "example": { "mobile": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "on_whatsapp": { "type": "boolean" }, "account_type": { "type": "string" }, "business_name": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "on_whatsapp": true, "account_type": "string", "business_name": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/physical-address-verification": { "post": { "operationId": "physical_address_verification", "summary": "Physical Address Verification", "description": "A field agent visits the address and confirms residence with geotagged evidence.", "tags": [ "Contact & Address" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "title": "Name of the person" }, "address": { "type": "string", "title": "Full address" }, "pincode": { "type": "string", "title": "PIN code" }, "mobile": { "type": "string", "title": "Contact mobile" }, "address_type": { "type": "string", "title": "Address type (current / permanent / office)" } }, "required": [ "name", "address", "pincode", "mobile" ] }, "example": { "name": "string", "address": "string", "pincode": "string", "mobile": "9999999999", "address_type": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "request_id": { "type": "string" }, "status": { "type": "string" }, "outcome": { "type": "string" }, "visited_at": { "type": "string", "format": "date" }, "gps": { "type": "string" }, "photos": { "type": "array", "items": { "type": "object" } }, "report_url": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "request_id": "string", "status": "string", "outcome": "string", "visited_at": "YYYY-MM-DD", "gps": "string", "photos": [], "report_url": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/digital-footprint-check": { "post": { "operationId": "digital_footprint_check", "summary": "Digital Footprint Check", "description": "How established is this person online? Signals from phone, email and app presence.", "tags": [ "Risk & Compliance" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile": { "type": "string", "title": "Mobile number" }, "email": { "type": "string", "format": "email", "title": "Email address" }, "name": { "type": "string", "title": "Name" } }, "required": [ "mobile" ] }, "example": { "mobile": "9999999999", "email": "name@example.com", "name": "string" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "footprint_score": { "type": "number" }, "platforms": { "type": "array", "items": { "type": "object" } }, "consistency_flags": { "type": "array", "items": { "type": "object" } }, "risk_band": { "type": "string" } } } } }, "example": { "status": 200, "message": "string", "data": { "footprint_score": 0, "platforms": [], "consistency_flags": [], "risk_band": "string" } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/data-breach-check": { "post": { "operationId": "data_breach_check", "summary": "Data Breach Check", "description": "Has this email or phone appeared in known credential leaks?", "tags": [ "Risk & Compliance" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "title": "Email address" }, "mobile": { "type": "string", "title": "Mobile number" } } }, "example": { "email": "name@example.com", "mobile": "9999999999" } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "breached": { "type": "boolean" }, "breach_count": { "type": "integer" }, "last_seen": { "type": "string", "format": "date" }, "exposed_data_types": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "breached": true, "breach_count": 200, "last_seen": "YYYY-MM-DD", "exposed_data_types": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/case-status-lookup": { "post": { "operationId": "case_status_lookup", "summary": "Court Case Status Lookup", "description": "Track a specific case by CNR or case number: status, next hearing and orders.", "tags": [ "Risk & Compliance" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ClientReference" }, { "$ref": "#/components/parameters/Report" }, { "$ref": "#/components/parameters/MockScenario" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cnr_number": { "type": "string", "title": "CNR number" }, "court": { "type": "string", "title": "Court (when no CNR)" }, "case_number": { "type": "string", "title": "Case number" }, "year": { "type": "number", "title": "Case year" } } }, "example": { "cnr_number": "string", "court": "string", "case_number": "string", "year": 0 } } } }, "responses": { "200": { "description": "The verification result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "case_title": { "type": "string" }, "stage": { "type": "string" }, "parties": { "type": "array", "items": { "type": "object" } }, "next_hearing": { "type": "string", "format": "date" }, "orders": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": 200, "message": "string", "data": { "case_title": "string", "stage": "string", "parties": [], "next_hearing": "YYYY-MM-DD", "orders": [] } } } } }, "202": { "$ref": "#/components/responses/Accepted" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } } } }, "/requests/{request_id}": { "get": { "operationId": "get_request", "summary": "Get the status and answer of an earlier call", "tags": [ "Requests" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "description": "The request_id the call was answered with (also in the X-Request-Id header).", "schema": { "type": "string", "pattern": "^req_[a-z0-9]{24}$" } } ], "responses": { "200": { "description": "The call. status is processing (still waiting on the source), completed (answered \u2014 the answer is in result) or failed (not answered; never billed). result is omitted once your data retention window has passed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "completed", "failed" ] }, "api": { "type": "string" }, "environment": { "type": "string", "enum": [ "sandbox", "production" ] }, "client_reference": { "type": "string" }, "http_status": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" }, "result": { "type": "object", "description": "The exact body the call answered (or would have answered) with." }, "result_purged": { "type": "boolean" }, "report_url": { "type": "string", "format": "uri", "description": "Present while the call's document is kept (72 hours): where to download it with the same key." }, "report": { "$ref": "#/components/schemas/ReportDocument" } } } } } }, "4XX": { "$ref": "#/components/responses/ClientError" } } } }, "/requests/{request_id}/report": { "get": { "operationId": "get_request_report", "summary": "Download the document of an earlier call", "description": "Optional \u2014 the call's own answer already carries the file as report.base64. Use this to stream the file instead, or to fetch it again: it answers the raw file with its Content-Type (not JSON) for 72 hours after the call (report.expires_at), then 410. Applies to APIs that answer with a document and to JSON APIs called with ?report=pdf.", "tags": [ "Requests" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "description": "The request_id the call was answered with (also in the X-Request-Id header).", "schema": { "type": "string", "pattern": "^req_[a-z0-9]{24}$" } } ], "responses": { "200": { "description": "The document (a PDF, usually).", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "This call produced no document." }, "410": { "description": "The document has expired (kept 72 hours) or was deleted under your data retention policy." }, "4XX": { "$ref": "#/components/responses/ClientError" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your emver API key for the environment you are calling (sandbox keys only work on the sandbox server)." } }, "schemas": { "Error": { "type": "object", "properties": { "status": { "type": "integer", "description": "HTTP status code, repeated in the body." }, "message": { "type": "string", "description": "Human-readable explanation." }, "code": { "type": "string", "description": "Machine-readable reason where one applies, e.g. consent_required." } }, "required": [ "status", "message" ] }, "ReportDocument": { "type": "object", "description": "A document answer. base64 is the whole file \u2014 decode it and save it as filename; no second call is needed. url (= report_url) downloads the same file with the API key until expires_at (72 hours after the call).", "properties": { "format": { "type": "string", "example": "pdf" }, "mime": { "type": "string", "example": "application/pdf" }, "filename": { "type": "string", "example": "cibil-transunion-pdf-req_xxxxxxxxxxxxxxxxxxxxxxxx.pdf" }, "size": { "type": "integer", "description": "Bytes.", "example": 183422 }, "url": { "type": "string", "format": "uri" }, "expires_at": { "type": "string", "format": "date-time" }, "base64": { "type": "string", "format": "byte", "description": "The file, base64-encoded. Omitted in webhook payloads." } } } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (max 255). A retry with the same key within 24 hours returns the first answer (header Idempotent-Replayed: true) instead of running \u2014 and billing \u2014 the call again. A call that was not billed (402, 5xx) frees its key.", "schema": { "type": "string", "maxLength": 255 } }, "ClientReference": { "name": "X-Client-Reference", "in": "header", "required": false, "description": "Your own id for this call (max 255). Echoed back as a header, shown in the console logs and sent in webhooks.", "schema": { "type": "string", "maxLength": 255 } }, "Report": { "name": "report", "in": "query", "required": false, "description": "JSON APIs only: set to pdf to also receive a PDF report alongside the JSON, in the same report_url + report {base64, \u2026} shape a document API answers with (see components/schemas/ReportDocument). APIs that answer with a document do so on every call without this parameter.", "schema": { "type": "string", "enum": [ "pdf" ] } }, "MockScenario": { "name": "X-Mock-Scenario", "in": "header", "required": false, "description": "Sandbox keys in mock mode only (ignored otherwise): which sample answer to return. Overrides the test-input rule (first field ending in N = not_found, X = invalid_input, E = provider_error, else success). An unknown value is refused with 400. Mock answers carry \"mock\": true and are never billed.", "schema": { "type": "string", "enum": [ "success", "not_found", "invalid_input", "provider_error" ] } } }, "responses": { "Accepted": { "description": "Accepted \u2014 the source answers asynchronously. Fetch the result from status_url (GET /requests/{request_id}) or receive it on your webhook.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 202 }, "message": { "type": "string" }, "request_id": { "type": "string", "example": "req_3k9x0m2b7c4d1e5f6g8h9j0k" }, "status_url": { "type": "string", "format": "uri" } } } } } }, "ClientError": { "description": "The request was not accepted (invalid key, API not enabled, validation failed, consent missing or declined \u2014 `code` consent_required / consent_declined / consent_invalid \u2014 record not found, rate limit).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ServerError": { "description": "Temporary problem on the verification side. Retry with backoff; the call is not billed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }