Pan Aadhaar Link Status API

Sections

Developer Documentation

Welcome to the Deepvue Developer Hub! 🎉

Here, you'll find all the tools and resources you need to dive deep into Deepvue.

Whether you're digging into detailed guides or exploring our docs, we've got your back.

Ready to dive in and start building awesome stuff? Let's do this! 💻 🚀

Was this section helpful?

What made this section unhelpful for you?

Introduction

Deepvue's API Infrastructure for Financial Integrations and Insights enables businesses to launch financial products 10X faster. We provide various API products across Identity Verification, Banking, Credit, and more to cater to business' specific needs.

The Deepvue APIs are well organised around REST. All the APIs have predictable resource-oriented URLs, accept query parameters, form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, error codes, and authentication.

Just getting started? Let's integrate step-by-step 💻

Lazy to write code?

Use your API Dashboard to get started with Deepvue — no code required.

Ready to integrate?

Get started with our postman collection - in no time. Here is the Link to Postman Collection.

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://production.deepvue.tech

Language Box

API Keys

Use API keys to Authenticate API requests.

Deepvue authenticates your API requests using your account’s API keys. If a request doesn’t include a valid key, Deepvue returns an invalid request error. If a request includes a deleted or expired key, Deepvue returns an authentication error.

Use the Deepvue Dashboard to find keys. To access your API keys, navigate to credential section on the Dashboard.

Trial account secret keys have the prefix free_tier and live account secret keys have live as prefix and your organization id. Alternatively, you can use ask our chat support to help you navigating API integrations and even scheduling an API integration call or a product demo.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Keep your keys safe

Anyone can use your live mode API key to make any API call on behalf of your account. Keep your keys safe by following these best practices:

  1. Grant access only to those who need it.
  2. Don’t store keys in a version control system.
  3. Control access to keys with a password manager or secrets management service.
  4. Don’t embed a key where it could be exposed to an attacker, such as in a mobile application.

View the API request logs

To open the API request logs, click the API Logs on your deepvue dashboard, then select data range and products. Opening the logs redirects you to the main Deepvue Dashboard.

Was this section helpful?

What made this section unhelpful for you?

Authentication

Deepvue APIs require authentication for access. We support OAuth2 and client_id/client_secret based authentication methods. Please refer to the below Authorize section for more details.

You will need an Authorization token to access most of the Platform APIs. While APIs such as Aadhaar eKYC and Digilocker can be accessed using your client_id and client_secret.


Authorize

The Authorize API Endpoint allows developers to securely authenticate their applications using their API keys.

By providing the required client_id and client_secret, users can obtain the necessary access_token to access protected resources within the API. This process ensures secure communication between the application and the API, enabling seamless integration and data exchange.

  • Authorization Token will be valid for only 24 hours from the time of generating the token
  • After 24 hours, you need to refresh the token by using the Authorize API Endpoint.

You can find your client_id & client_secret on your dashboard under credentials tab. Your 'x-api-key' is the same as your client_secret.

Body Parameters

client_idstring Required

required CLIENT_ID provided to you

client_secretstring Required

required CLIENT_SECRET provided to you

Responses

200
Object

Response Attributes

access_tokenstring
token_typestring
expirystring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object

Response Attributes

detailarray

Show child attributes

500
Object

Response Attributes

detailstring
Was this section helpful?

What made this section unhelpful for you?

POST

/v1/authorize

Select
1 2 3 curl --location 'https://production.deepvue.tech/v1/authorize' \ --form 'client_id="YOUR CLIENT_ID"' \ --form 'client_secret="YOUR CLIENT_SECRET"'

Response

{
  "access_token": "string",
  "token_type": "string",
  "expiry": "string"
}

Offline Aadhaar eKYC API

With these APIs, users can seamlessly integrate Offline Aadhaar ekyc processes into their applications, ensuring a secure and simplified user identification experience.

Offline Aadhaar KYC, or OKYC, is a legally compliant KYC method as per UIDAI guidelines. Your customers can provide their Aadhaar number and verify with an OTP sent to their Aadhaar-linked mobile number, to access a downloadable XML file with their Aadhaar details.

How does Offline Aadhaar Verification work?

Provide Consent: Customers agree or disagree to continue at the initial screen.

Share Aadhaar Number: Customers provide their Aadhaar number to proceed with the verification.

Verify with OTP: Verify with an OTP sent to their Aadhaar-linked mobile number by UIDAI, to access a downloadable XML file with their Aadhaar details in a share code manner.

Realtime liveness & face match for liveness detection: The Aadhaar Offline document has Name, Address, Photo, Gender, DOB. Optionally, the photo in the UIDAI Issued Aadhaar document can be matched with customers' live photo or a selfie in real time to ensure face match and liveness checks.

As per the compliances by UIDAI on sharing and storage of Aadhaar number is not allowed. Service Providers shall not share, publish or display either Share Code or XML file or its contents with anyone else. Any non-compliance of these actions shall invite actions under Sections 17 and 25 of The Aadhaar (Authentication) Regulation, 2016, Sections 4 and 6 of The Aadhaar (Sharing of Information) Regulation, 2016 and Sections 29(2), 29 (3), and 37 of The Aadhaar Act, 2016. Consent should be mandatorily stored at the company end to proceed with verification.

If you want to integrate Aadhaar eKYC in your web application or want to build your own customized workflow you can use our Aadhaar eKYC APIs as detailed below.

Embed offline eKYC Aadhaar flow to verify users on your application using a simple flow.

  • Initiate Session: This API allows the platform to initiate a session to get the captcha before passing the Aadhaar number of the customer.
  • Generate OTP: This API allows the platform to pass the Aadhaar number to generate OTP to the linked mobile number.
  • Verify OTP: This API allows the platform to pass the OTP to Deepvue.tech to fetch the customer's Aadhaar information from UIDAI.

If the customer or the platform wishes to restart the session, a new captcha can be generated using the Reload Captcha API.

Offline Aadhaar eKYC API - V2

We’re excited to introduce v2 of Deepvue’s Aadhaar eKYC APIs, bringing faster verifications, higher success rates, and improved integration capabilities.

What’s New in v2?

No Captcha Required – A frictionless experience with reduced user input.

Higher Success Rates – Enhanced backend optimizations for improved reliability.

Improved Error Handling – Clear, customer-centric responses with detailed sub_code for seamless backend integration.

Automated PDF Generation – Instant Aadhaar eKYC PDFs for easy record-keeping and compliance.

As per the compliances by UIDAI on sharing and storage of Aadhaar number is not allowed. Service Providers shall not share, publish or display either Share Code or XML file or its contents with anyone else. Any non-compliance of these actions shall invite actions under Sections 17 and 25 of The Aadhaar (Authentication) Regulation, 2016, Sections 4 and 6 of The Aadhaar (Sharing of Information) Regulation, 2016 and Sections 29(2), 29 (3), and 37 of The Aadhaar Act, 2016. Consent should be mandatorily stored at the company end to proceed with verification.

Digilocker API

Digilocker is an initiative under Digital India Program which aims to remove the dependency on physical documents and power the sharing of verified electronic documents across authorised agencies.

Benefits of Digilocker

  1. Documents can be shared online, accessed anytime, anywhere.
  2. Documents can be authenticated by the users, legally on a par with originals.
  3. It's simple to use and very convenient.
  4. Documents are issued directly by the registered issuers such as Income Tax Department, CBSE, Registrar Office, etc.

Product Flow

Initiate Session : This API creates a session in which DigiLocker journey can be completed with other APIs in the flow.

Get User Access Token : This API allows the platform to get user access token from Digilocker by passing the authorisation code generated from Digilocker.

Download e-Aadhar : This API allows the platform to download the Aadhaar XML from Digilocker.

Get Issued Files : This API allows the platform to fetch a list of issued documents from Digilocker.

Download File : This API allows the platform to download the file from Digilocker by passing the URI for a particular document.

KYC APIs

With these APIs, users can seamlessly integrate identity verification processes into their applications, ensuring compliance and enhancing security measures.

Was this section helpful?

What made this section unhelpful for you?

Aadhaar Verification API - Basic

Aadhaar is an important identification document used by businesses to establish identity of user for customer KYC.

With Aadhaar Verification, just enter the 12-digit Aadhaar number and know whether the Aadhaar is valid or not along with details like age_bandgenderstate and the last three digits of their registered mobile_number, in seconds.

Key Features of this API are:

  • Online Aadhaar Verification
  • Simple & easy integration
  • Verification status in real-time

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

aadhaar_numberstring Required

Responses

200
Object
RESPONSE_VALID_AADHAAR

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_AADHAAR

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_AADHAAR_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/aadhaar?aadhaar_number=AADHAAR NUMBER

Select
1 2 3 curl --location 'https://production.deepvue.tech/v1/verification/aadhaar?aadhaar_number=AADHAAR%20NUMBER' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738007863367,
  "transaction_id": "089ea138792640a48b8075e175918e6f",
  "sub_code": "SUCCESS",
  "message": "Aadhaar Verified Successfully.",
  "data": {
    "age_range": "20-30",
    "aadhaar_number": "825328778091",
    "state": "Karnataka",
    "gender": "M",
    "last_digits": "761",
    "is_mobile": true
  }
}

PAN Verification API - Basic

The primary objective of PAN is to use a universal identification key to track financial transactions that might have a taxable component to prevent tax evasion.

The PAN number remains unaffected by the change of address throughout India.

This API lets you verify PANs. You can also check whether the given PAN is valid or not.

You will get basic information such as NameCategory, and Status of PAN.

Verify PAN numbers by taking in the pan and receiving information pertaining to the PAN.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

pan_numberstring Required
namestring

Responses

200
Object
RESPONSE_VALID_PAN_BASIC

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_PAN_BASIC

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_PAN_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/panbasic?pan_number={{PAN Number}}&name={{Name}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/panbasic?pan_number={{PAN%20Number}}&name={{Name}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738040933033,
  "transaction_id": "ece94d5e2749482faa10184962e9e34a",
  "data": {
    "@entity": "pan",
    "pan": "AAAPT0002F",
    "full_name": "RATAN NAVAL TATA",
    "status": "VALID",
    "category": "Individual",
    "name_information": {
      "pan_name_cleaned": "Ratan Naval Tata"
    }
  }
}

PAN Verification API - Plus

The Pan Plus Authentication API provides additional details compared to Advanced Authentication. Verify additional details such as DOB, Gender, and Aadhaar Linking from PAN Number.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

pan_numberstring Required

Responses

200
Object
RESPONSE_INDIVIDUAL_PAN_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_COMPANY_PAN_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_PAN_PLUS

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_PAN_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/pan-plus?pan_number=PAN-Number

Select
1 2 3 curl --location 'https://production.deepvue.tech/v1/verification/pan-plus?pan_number=PAN-Number' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1737862347191,
  "transaction_id": "f75cc1f157ac46cd85abf58035adf994",
  "sub_code": "SUCCESS",
  "message": "Pan Verified Successfully.",
  "data": {
    "pan_number": "AAAPT0002F",
    "full_name": "RATAN NAVAL TATA",
    "full_name_split": [
      "RATAN",
      "NAVAL",
      "TATA"
    ],
    "masked_aadhaar": "XXXXXXXX8901",
    "gender": "M",
    "dob": "1937-12-28",
    "aadhaar_linked": true,
    "category": "person"
  }
}

PAN Verification API - Plus - V2

We're thrilled to announce the return of our much-awaited Pan Plus API - V2! 🎉

The Pan Plus Authentication API - V2 provides additional details compared to Advanced Authentication. Verify additional details such as DOB, Gender, Address, Email, Phone from PAN Number.

What’s New in v2?

🏠 Address Verification: Confirm the address with absolute accuracy.

Masked Mobile & Email Retrieval: Securely obtain a masked mobile number and email associated with the PAN.

💯 Ease of Integration: Seamlessly integrate our API into your existing systems by just updating base URL from v1 to v2. That simple, yeah.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

pan_numberstring Required

Responses

200
Object
RESPONSE_INDIVIDUAL_PAN_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_COMPANY_PAN_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_PAN_PLUS

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_PAN_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/v2/verification/pan-plus?pan_number=PAN-Number

Select
1 2 3 curl --location 'https://production.deepvue.tech/v2/verification/pan-plus?pan_number=PAN-Number' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1741205460834,
  "transaction_id": "1030ac206a564103b68c45eaa924d6b4",
  "sub_code": "SUCCESS",
  "message": "Pan Verified Successfully.",
  "data": {
    "pan_number": "AAAPT0002F",
    "full_name": "RATAN NAVAL TATA",
    "full_name_split": [
      "RATAN",
      "NAVAL",
      "TATA"
    ],
    "masked_aadhaar": "XXXXXXXX8901",
    "address": {
      "line_1": "HAKEKAI 169B- 171",
      "line_2": "LOWER COLABA ROAD",
      "street_name": "Mumbai",
      "zip": "400005",
      "city": "Mumbai",
      "state": "MAHARASHTRA",
      "country": "INDIA",
      "full": "HAKEKAI 169B- 171 LOWER COLABA ROAD Mumbai Mumbai MAHARASHTRA 400005"
    },
    "email": "hd*****ra@tata.com",
    "phone_number": "92XXXXXX26",
    "gender": "M",
    "dob": "1937-12-28",
    "aadhaar_linked": true,
    "category": "person"
  }
}

Pan-Aadhaar Link Status API

API to check if PAN and Aadhaar are linked with each other.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

pan_numberstring Required
aadhaar_numberstring

Responses

200
Object
RESPONSE_PAN_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
200
Object
RESPONSE_INVALID_PAN_PLUS

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
200
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
200
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_PAN_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/pan-aadhaar-link-status?pan_number={{PAN Number}}&aadhaar_number={{AADHAAR}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/pan-aadhaar-link-status?pan_number={{PAN%20Number}}&aadhaar_number={{AADHAAR}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 422,
  "timestamp": 1738007802265,
  "transaction_id": "34f8989186d741b38cd64f8b54ed4580",
  "sub_code": "INVALID_INPUT",
  "message": "Invalid Pan Pattern."
}

PAN To Father Name API

This API allows users to find the father's name associated with the provided PAN number.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

pan_numberstring Required

Responses

200
Object
RESPONSE_PAN_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_PAN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_PAN_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/pan-to-fathername?pan_number={{PAN Number}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/pan-to-fathername?pan_number={{PAN%20Number}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738007863367,
  "transaction_id": "cc74ead3be1e4d6aac9dbc7510703a85",
  "sub_code": "SUCCESS",
  "message": "Pan details fetched successfully.",
  "data": {
    "father_name": "PRAVIN FADTE",
    "full_name": "PRABHA CHANDRAMOHAN FADTE",
    "full_name_split": [
      "PRABHA",
      "CHANDRAMOHAN",
      "FADTE"
    ],
    "individual_pan": true
  }
}

PAN-KRA Verification API

The PAN KRA Verification API facilitates the verification of an individual or entity's PAN Number through the KRA (Know Your Customer Registration Agency) system.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

pan_numberstring Required

Responses

200
Object
RESPONSE_PAN_KRA_VERIFICATION_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_PAN_KRA_NO_DETAILS_FOUND

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_PAN_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/pan-kra-status?pan_number={{PAN Number}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/pan-kra-status?pan_number={{PAN%20Number}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738007863352,
  "transaction_id": "e08573c50c0b456aa2a9da636bbb9aa5",
  "sub_code": "SUCCESS",
  "message": "PAN-KRA status fetched successfully",
  "data": {
    "pan_number": "AFVPG9986M",
    "pan_kra_status": true,
    "pan_kra_status_description": "KYC REGISTERED WITH CVLKRA",
    "kra_status": true,
    "pan_kra_agency": "CVL KRA",
    "modification_status_details": {
      "modification_status": "KYC REGISTERED WITH CVLKRA",
      "modification_status_date": "2016-06-28T16:42:11",
      "modification_remarks": "--"
    }
  }
}

Passport Verification API

Use this API to verify passport information and ensure the identity of your customer. Provide the passport file number and dob(YYYY-MM-DD format) in the request and we help you verify the details instantly.

Header Parameters

Authorizationstring

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring

required CLIENT_SECRET provided to you

Query Parameters

file_numberstring
dobstring

Responses

200
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/passport?file_number={{PASSPORT_FILE_NO}}&dob={{YYYY-MM-DD}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/passport?file_number={{PASSPORT_FILE_NO}}&dob={{YYYY-MM-DD}}' \ --header 'Authorization: Bearer <ACCESS_TOKEN>' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": null,
  "transaction_id": "string",
  "sub_code": "SUCCESS",
  "message": "Passport verification successful",
  "data": {
    "file_number": "string",
    "name": "string",
    "dob": "string",
    "application_type": "string",
    "application_received_date": "string",
    "status": "string"
  }
}

Vehicle RC Verification API - Advanced

The Vehicle Registration-Advanced Verification API helps to establish a link between the vehicle and its owner, thereby minimizing the potential for fraud. Alongside vehicle basic details, this API also provides vehicle chasis, engine, insurance, insurer, permit details and many more.

Header Parameters

Authorizationstring Required

The Authorization header parameter is required and should contain the ACCESS_TOKEN generated from the authorize endpoint in the format "Bearer ".

x-api-keystring Required

The x-api-key header parameter is required and should contain the CLIENT_SECRET provided to you.

Query Parameters

rc_numberstring

The rc_number query parameter is used to specify the RC number for advanced verification.

Responses

200
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
INVALID_RC_NUMBER

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/rc-advanced?rc_number={{RC Number}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/rc-advanced?rc_number={{RC%20Number}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738007863555,
  "transaction_id": "7c71390513b348eca6c5164a8a313844",
  "sub_code": "SUCCESS",
  "message": "RC Verified Successfully.",
  "data": {
    "rc_number": "MH02BY2727",
    "registration_date": "2010-03-30",
    "owner_name": "M/S ARBAAZ KHAN PRODUCTION P LTD",
    "father_name": "NOT APPLICABLE",
    "present_address": "1-2 CORAL REEF CHS LTD 55 CHIMBAI, RD BANDRA W, MUMBAI, , Maharashtra, 400050",
    "permanent_address": "1-2 CORAL REEF CHS LTD 55 CHIMBAI, RD BANDRA W, MUMBAI, , Maharashtra, 400050",
    "mobile_number": "",
    "vehicle_category": "LMV",
    "vehicle_chasi_number": "SALLMAM23AA314132",
    "vehicle_engine_number": "0406774368DT",
    "maker_description": "JAGUAR LAND ROVER INDIA LIMITED",
    "maker_model": "RANGE ROVER SPORTS 3.6 TD V8",
    "body_type": "SALOON",
    "fuel_type": "DIESEL",
    "color": "A WHITE",
    "norms_type": "Not Available",
    "fit_up_to": "2025-03-29",
    "financer": "HDFC BANK LTD",
    "financed": true,
    "insurance_company": "Tata AIG General Insurance Co. Ltd.",
    "insurance_policy_number": "62035646240000",
    "insurance_upto": "2025-10-10",
    "manufacturing_date": "3/2009",
    "manufacturing_date_formatted": "2009-03",
    "registered_at": "MUMBAI (WEST)",
    "latest_by": "2025-01-28",
    "less_info": true,
    "tax_upto": null,
    "tax_paid_upto": "LTT",
    "cubic_capacity": "3628",
    "vehicle_gross_weight": "3175",
    "no_cylinders": "8",
    "seat_capacity": "5",
    "sleeper_capacity": null,
    "standing_capacity": null,
    "wheelbase": null,
    "unladen_weight": "2675",
    "vehicle_category_description": "Motor Car",
    "pucc_number": "MH00201050006983",
    "pucc_upto": "2025-02-01",
    "permit_number": "",
    "permit_issue_date": null,
    "permit_valid_from": null,
    "permit_valid_upto": null,
    "permit_type": "",
    "national_permit_number": null,
    "national_permit_upto": null,
    "national_permit_issued_by": null,
    "non_use_status": null,
    "non_use_from": null,
    "non_use_to": null,
    "blacklist_status": null,
    "noc_details": null,
    "owner_number": "1",
    "rc_status": "ACTIVE",
    "masked_name": false,
    "challan_details": null,
    "variant": null
  }
}

RC Challan Details API

Helps to get the challan related details of a vehicle by providing the Vehicle RC Number.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

rc_numberstring

Responses

200
Object
REPONSE_RC_CHALLAN_DETAILS_SUCCESS

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_NO_CHALLAN_FOUND

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
401
Object
RESPONSE_UNAUTHENTICATED_ACCESS

Response Attributes

detailstring
401
Object
RESPONSE_INVALID_CLIENT

Response Attributes

detailstring
401
Object
RESPONSE_INVALID_CREDENTIALS

Response Attributes

detailstring
401
Object
RESPONSE_AUTHORIZATION_FAILURE

Response Attributes

detailstring
403
Object
RESPONSE_TOKEN_EXPIRED

Response Attributes

detailstring
403
Object
RESPONSE_ACCESS_FORBIDDEN

Response Attributes

detailstring
422
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object
RESPONSE_INTERNAL_SERVER_ERROR

Response Attributes

detailstring
500
Object
RESPONSE_SOURCE_FAILURE

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/rc-challan-details?rc_number={{RC Number}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/rc-challan-details?rc_number={{RC%20Number}}' \ --header 'Authorization: ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738007665809,
  "transaction_id": "9a893cf1287a434285793d8c5f0a5cf4",
  "sub_code": "SUCCESS",
  "message": "Challan details fetched successfully",
  "data": {
    "challan_details": {
      "challans": [
        {
          "number": 1,
          "challan_number": "25738882",
          "offense_details": "NO PARKING",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2018-07-04",
          "challan_date_time": "2018-07-04T16:07:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 100,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 2,
          "challan_number": "29999394",
          "offense_details": "PILLION RIDER - NOT WEARING HELMET",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2019-07-10",
          "challan_date_time": "2019-07-10T17:26:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 100,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 3,
          "challan_number": "29999393",
          "offense_details": "RIDING  WITHOUT HELMET",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2019-07-10",
          "challan_date_time": "2019-07-10T17:26:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 100,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 4,
          "challan_number": "30291001",
          "offense_details": "RIDING  WITHOUT HELMET",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2019-07-30",
          "challan_date_time": "2019-07-30T09:12:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 100,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 5,
          "challan_number": "30283691",
          "offense_details": "PILLION RIDER - NOT WEARING HELMET",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2019-07-30",
          "challan_date_time": "2019-07-30T09:12:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 100,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 6,
          "challan_number": "31366256",
          "offense_details": "PILLION-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2019-10-21",
          "challan_date_time": "2019-10-21T10:18:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 7,
          "challan_number": "37084353",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2021-01-20",
          "challan_date_time": "2021-01-20T10:26:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 8,
          "challan_number": "40821268",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2021-06-30",
          "challan_date_time": "2021-06-30T10:35:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 9,
          "challan_number": "47399375",
          "offense_details": "PARKING NEAR TRAFFIC LIGHT / STOPPING ON ZEBRA CROSS",
          "offense_details_list": [],
          "challan_place": "CHANDRA LAYOUT ATTIGUPPA",
          "challan_date": "2022-04-29",
          "challan_date_time": "2022-04-29T09:09:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 1000,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 10,
          "challan_number": "47810405",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2022-04-30",
          "challan_date_time": "2022-04-30T14:32:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 11,
          "challan_number": "52642819",
          "offense_details": "PILLION-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2022-10-08",
          "challan_date_time": "2022-10-08T15:43:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 12,
          "challan_number": "53443792",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2022-10-08",
          "challan_date_time": "2022-10-08T15:43:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 13,
          "challan_number": "52460548",
          "offense_details": "PILLION-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2022-10-15",
          "challan_date_time": "2022-10-15T13:32:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 14,
          "challan_number": "52493691",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2022-10-15",
          "challan_date_time": "2022-10-15T13:32:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 15,
          "challan_number": "53278852",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "DIGITAB VIOLATION",
          "challan_date": "2022-11-15",
          "challan_date_time": "2022-11-15T10:27:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 16,
          "challan_number": "61678214",
          "offense_details": "RIDER-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": " JP Nagar,35th Main Rd, 15 cross Jn (ITMS CAMERA)",
          "challan_date": "2023-10-21",
          "challan_date_time": "2023-10-21T01:44:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 17,
          "challan_number": "62288378",
          "offense_details": "JUMPING TRAFFIC SIGNALS",
          "offense_details_list": [],
          "challan_place": "8th main 9th cross JP nagar (ITMS CAMERA)",
          "challan_date": "2023-11-19",
          "challan_date_time": "2023-11-19T18:04:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 18,
          "challan_number": "62309756",
          "offense_details": "PILLION-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "8th main 9th cross JP nagar (ITMS CAMERA)",
          "challan_date": "2023-11-19",
          "challan_date_time": "2023-11-19T18:04:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 19,
          "challan_number": "65166292",
          "offense_details": "PILLION-NOT WEARING PROTECTIVE HEAD GEAR",
          "offense_details_list": [],
          "challan_place": "8th main 9th cross JP nagar (ITMS CAMERA)",
          "challan_date": "2024-03-19",
          "challan_date_time": "2024-03-19T23:00:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 20,
          "challan_number": "65160822",
          "offense_details": "JUMPING TRAFFIC SIGNALS",
          "offense_details_list": [],
          "challan_place": "8th main 9th cross JP nagar (ITMS CAMERA)",
          "challan_date": "2024-03-19",
          "challan_date_time": "2024-03-19T23:00:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 21,
          "challan_number": "65940909",
          "offense_details": "PARKING NEAR TRAFFIC LIGHT / STOPPING ON ZEBRA CROSS",
          "offense_details_list": [],
          "challan_place": "Jayanagar 4th main 27th cross (ITMS CAMERA)",
          "challan_date": "2024-04-19",
          "challan_date_time": "2024-04-19T10:39:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 1000,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        },
        {
          "number": 22,
          "challan_number": "69479903",
          "offense_details": "JUMPING TRAFFIC SIGNALS",
          "offense_details_list": [],
          "challan_place": " JP Nagar,35th Main Rd, 15 cross Jn (ITMS CAMERA)",
          "challan_date": "2024-11-01",
          "challan_date_time": "2024-11-01T02:01:00",
          "state": "KA",
          "rto": null,
          "upstream_code": "KA",
          "accused_name": "MOHAMMAD NIHAR",
          "amount": 500,
          "challan_status": "Not Paid",
          "court_challan": null,
          "court_name": ""
        }
      ],
      "blacklist": [],
      "successful_backends": [
        "ECHALLAN",
        "KA"
      ],
      "failed_backends": []
    }
  }
}

Bank Account Verification API - Penny Drop

Bank account verification or penny drop check is a way to verify the authenticity of a customer's bank account. We take the Bank Account details and deposit 1 INR into the account. In return, we are able to fetch the Account Information

The API verifies a bank account and IFSC code combination.

A successful response is billable only in case of a 200 Response Status Code.

Header Parameters

Authorizationstring Required

required ACCESS_TOKEN generated from authorize endpoint. e.g. Bearer

x-api-keystring Required

required CLIENT_SECRET provided to you

Query Parameters

account_numberstring
ifscstring
namestring

Responses

200
Object
RESPONSE_BAV_SUCCESSFUL

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_ACCTNO_OR_IFSC

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

200
Object
RESPONSE_ACCT_BLOCKED

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_IFSC

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

200
Object
RESPONSE_NRE_ACCT

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
424
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
424
Object
RESPONSE_SOURCE_BANK_DECLINED

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
424
Object
RESPONSE_BENEFICIARY_BANK_OFFLINE

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
424
Object
RESPONSE_IMPS_MODE_FAIL

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
424
Object
RESPONSE_NPCI_UNAVAILABLE

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
500
Object

Response Attributes

detailstring
501
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/bankaccount?account_number={{Bank Account Number}}&ifsc={{Bank IFSC code}}&name={{Name}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/bankaccount?account_number={{Bank%20Account%20Number}}&ifsc={{Bank%20IFSC%20code}}&name={{Name}}' \ --header 'Authorization: Bearer <ACCESS_TOKEN>' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1738042952419,
  "transaction_id": "fe104a7a-f3a9-4365-9390-e3af0e4193e5",
  "data": {
    "message": "Bank Account details verified successfully.",
    "account_exists": true,
    "name_at_bank": "Master NIHAR  .",
    "utr": "502811454367",
    "amount_deposited": 1,
    "name_information": {
      "name_at_bank_cleaned": "Master Nihar"
    }
  }
}

IFSC Verification API

IFSC code is a unique identifier for a bank branch. Businesses verify IFSC before performing penny-drop to ensure successful payouts.

Verify IFSC code and receive details of the bank branch associated with that IFSC Code.

IFSC Verification API helps verifying IFSC code against RBI's IFSC Master and provide bank & branch details.

Header Parameters

Authorizationstring Required

The ACCESS_TOKEN generated from the authorize endpoint. Include the token in the format "Bearer ". This header parameter is required for authorization.

x-api-keystring Required

The CLIENT_SECRET provided to you. This header parameter is required for authentication.

Query Parameters

ifscstring Required

The IFSC code of the bank branch to be verified.

Responses

200
Object

Response Attributes

messagestring
codenumber
transaction_idstring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object

Response Attributes

pascodenumber
timestampnumber
transaction_idstring
messagestring
500
Object

Response Attributes

detailstring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/ifsc?ifsc={{IFSC Code}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/ifsc?ifsc={{IFSC%20Code}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "message": "Invalid IFSC",
  "code": 422,
  "transaction_id": "3d8f62f0c49441b396069966dd4898fa"
}

UPI Verification API

You can verify the UPI details of your customer before adding them to your payouts account using the UPI Verification feature. This helps you in making successful transfers to your customers.

Some of the businesses may want to verify the customer name against the UPI, or if want to validate if the given UPI exists, this can be done instantly with UPI Verification.

The API verifies a UPI ID. A successful response is billable only in case of a 200 Response Status Code.

Header Parameters

Authorizationstring Required

Required header parameter that represents the ACCESS_TOKEN generated from the authorize endpoint in the format Bearer .

x-api-keystring Required

Required header parameter that represents the CLIENT_SECRET provided to you.

Query Parameters

vpastring Required

Query parameter used for UPI verification.

namestring

Responses

200
Object
RESPONSE_VALID_UPI

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_UPI

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_VPA_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/upi?vpa={{UPI ID}}&name={{Name}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/upi?vpa={{UPI%20ID}}&name={{Name}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1737634320519,
  "transaction_id": "c149c0d2da834ab7b77870edb56d5a93",
  "sub_code": "SUCCESS",
  "message": "UPI Successfully Verified",
  "data": {
    "account_exists": true,
    "name_at_bank": "NIHAR",
    "name_information": {
      "name_at_bank_cleaned": "Nihar"
    }
  }
}

UPI Advanced Verification API

API to verify UPI information of your customers along with IFSC and the name as registered in the bank records.

Header Parameters

Authorizationstring Required

Required header parameter that represents the ACCESS_TOKEN generated from the authorize endpoint in the format Bearer .

x-api-keystring Required

Required header parameter that represents the CLIENT_SECRET provided to you.

Query Parameters

vpastring Required

Query parameter used for UPI verification.

Responses

200
Object
RESPONSE_VALID_UPI

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
RESPONSE_INVALID_UPI

Response Attributes

codenumber
timestampnumber
transaction_idstring
dataobject

Show child attributes

400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_INVALID_VPA_PATTERN

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
500
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/upi-advanced?vpa={{UPI ID}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/upi-advanced?vpa={{UPI%20ID}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": null,
  "transaction_id": "string",
  "sub_code": "SUCCESS",
  "message": "VPA Advance verification successful",
  "data": {
    "name_at_bank": "string",
    "ifsc": "string",
    "ifsc_details": {
      "bank": "string",
      "neft": "string",
      "imps": "string",
      "rtgs": "string",
      "upi": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "branch": "string",
      "category": "string",
      "swift_code": "string",
      "micr": "string",
      "nbin": "string"
    }
  }
}

Mobile To UPI API

API to fetch the account holder name along with the UPI ID of the user by providing the phone number.

Header Parameters

Authorizationstring Required

A required ACCESS_TOKEN generated from the authorize endpoint in the format: Bearer .

x-api-keystring Required

A required CLIENT_SECRET provided to you for authentication.

Query Parameters

mobile_numberstring Required

The mobile number for which UPI verification is being requested.

Responses

200
Object
Linked VPA Fetched Successfully

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
dataobject

Show child attributes

200
Object
NO_VPA_LINKED

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/verification/mobile-to-vpa?mobile_number={{Mobile Number}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/verification/mobile-to-vpa?mobile_number={{Mobile%20Number}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "timestamp": 1737920868205,
  "transaction_id": "6ad91a7b213e483f8e24f546750e5c38",
  "sub_code": "SUCCESS",
  "message": "Linked VPA Fetched Successfully.",
  "data": {
    "mobile_number": "8117182000",
    "vpa": "81171827000@ptyes",
    "name_at_bank": "MOHAMMAD  NIHAR"
  }
}

Name Match API

Name Matching is the process of finding occurrences of a substring from one name in another. It involves comparing patterns against the text to identify matches or similarities, and gives a score for that.

Use this API to verify names that have enormous variations. Provide us the names you want to verify, and we will tell you whether they match and provide score.

Header Parameters

Authorizationstring Required

A required ACCESS_TOKEN generated from the authorize endpoint in the format: Bearer .

x-api-keystring Required

A required CLIENT_SECRET provided to you for authentication.

Query Parameters

name1string
name2string

Responses

200
Object
RESPONSE_NAME_MATCH

Response Attributes

codenumber
sub_codestring
messagestring
timestampnumber
transaction_idstring
dataobject

Show child attributes

400
Object

Response Attributes

detailstring
401
Object

Response Attributes

detailstring
403
Object

Response Attributes

detailstring
422
Object
RESPONSE_NAME_EMPTY

Response Attributes

codenumber
timestampnumber
transaction_idstring
sub_codestring
messagestring
500
Object

Response Attributes

detailstring
503
Object

Response Attributes

codenumber
timestampnumber
transaction_idstring
messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/v1/name-match?name1={{str1}}&name2={{str2}}

Select
1 2 3 curl --location --globoff 'https://production.deepvue.tech/v1/name-match?name1={{str1}}&name2={{str2}}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'x-api-key: API_KEY(a.k.a CLIENT_SECRET)' \

Response

{
  "code": 200,
  "sub_code": "SUCCESS",
  "message": "Request processed successfully",
  "timestamp": 1711688769712,
  "transaction_id": "b6b95b94-2c58-4dc3-8de5-969d52d57938",
  "data": {
    "cleaned_name1": "Chandra Shekhar Kandpal",
    "cleaned_name2": "Chandra Shekhar Kandppal",
    "score": 98,
    "tokenwise_match": [
      {
        "first_name1": "Chandra",
        "first_name2": "Chandra",
        "score": 100
      },
      {
        "middle_name1": "Shekhar",
        "middle_name2": "Shekhar",
        "score": 100
      },
      {
        "last_name1": "Kandpal",
        "last_name2": "Kandppal",
        "score": 93
      }
    ]
  }
}

Bank Aadhaar Seeding Status

Document OCR

The Document OCR section allows developers to extract text from images and PDF files through optical character recognition (OCR) technology. By utilizing these API endpoint, developers can enable their applications to automatically process and extract text data from various document formats, enhancing efficiency and streamlining document management workflows.

Our systems use Modern & Latest OCR technology to scan the document images for field’s like full name, dob, address, etc. on the photo IDs and extract these fields as key-value pairs.

Mobile Number Intelligence

Find, verify, and fetch multiple data points associated with a mobile number, including the Full Name, KYC Details, UPI ID, IFSC code, Network Details, Digital Age, Employment Information, and more.

Document Forensics

Set of APIs that help with document forensic checks like template validation, image quality, photocopy, and spoof checks.

Face Forensics

APIs for facial recognition and liveliness verification in real time. The Face Match API employs advanced algorithms for reliable facial matching, crucial for secure access control and compliance. The Passive Liveness API enhances security by detecting and confirming the liveliness of faces during authentication, providing an additional layer of protection against impersonation and fraud.

Async APIs

Verify other Identity documents such as Driving License, Vehicle Registration Certificate etc. in real time for fast KYC checks. These are Asynchronous APIs which return a request ID and use a webhook mechanism to return the response back to your servers. You can then use this request ID and feed this into our GET API to consume the response.

GST APIs

Set of APIs that help with GST Registered business verification and onboarding.

GST Taxpayer

The GST Taxpayer APIs are provided by the GSTN for public usage. These APIs, together, mirror the GST Portal. Therefore, you can use these APIs to integrate GST compliance into your workflow itself.

Use the following workflow to access the GST Taxpayer APIs:

  1. The GST taxpayer is authenticated using OTP Verification.
  2. After successful authentication, the GST Taxpayer APIs can be accessed.
    1. Ledger APIs - Fetch the taxpayer's ledger like a) Cash ITC Balance, b) Cash Ledger, c) ITC Ledger.
    2. Returns APIs - Fetch the taxpayer's detailed summaries of GSTR -1 and GSTR -3B Returns

Generate Otp

First the taxpayer has to allow access to the GST Portal and enable it on his own GST Portal Account.

Follow the following steps to do the same:

  1. Login to your GST Account on https://gst.gov.in
  2. Click 'View Profile' on Dashboard
  3. In the 'Quick Links' section, go to Manage API Access
  4. Set 'Enable API Access Request' to Yes
  5. Set 'Duration' to 30days
  • Once the taxpayer has enabled API access onto GST Portal, the OTP verification can be carried out.
  • First, Generate One Time Password API is called.
  • This API takes in the gstin & username as per GST Portal. And then sends OTP to the phone number and email id of the GST Taxpayer.

OTP Message is as follows and OTP sent will be valid for 10 minutes.

OTP Message Sent to the Taxpayer

Dear taxpayer,

{{OTP}} is the OTP to verify your GST registration: {{GSTIN}}.

OTP is valid till {{hh:mm:ss IST}}. Do not share OTP with anyone.

Business Compliance

Taxpayer

Taxpayer APIs includes TAN Verification.

Taxpayer APIs help businesses verify their vendors, customers & employees using TAN. APIs also provide publicly available data such as name, address, and contact details that can be verified against physical documents.

ITR APIs

ITR APIs includes ITR Verification APIs including 26AS.

ITR APIs helps businesses download ITR information, such as ITR ID, Filing Year, Acknowledgement Number, ITR Form, Filing Date, ITR status, etc.

MCA APIs

Set of APIs that help fetch MCA's Director Master Data & Company Master Data.

MSME APIs

Set of APIs that help with MSME Registered business verification and onboarding.

Financial Services

Suite that provides you whole array of APIs to serve multiple financial services and fetch data for an organisation or individual from various data sources in a streamlined manner.

Some of the key things that you can do here are:

  1. Fetch the Credit Report from any of our partner credit bureaus.
  2. Fetch customer's Customer Data Pull basis mobile number and name to simplify your onboarding.

EPFO

Real-time UAN Verification API to extract employment details of employees and verify EPFO details.

Bulk Validations

Set of APIs to perform bulk operations for different checks.