Deepvue

Developer Documentation

Introduction

API Keys

Authentication

Offline Aadhaar eKYC API

Initiate Session

Generate OTP

Verify OTP

Reload Captcha

Digilocker API

Access Token

E-Aadhaar API

Issued Files

Download File

KYC APIs

Aadhaar Verification API - Basic

PAN Verification API - Basic

PAN Verification API - Plus

Pan-Aadhaar Link Status API

Vehicle RC Verification API - Advanced

Bank Account Verification API - Penny Drop

IFSC Verification API

UPI Verification API

Mobile To UPI API

Name Match API

Document OCR

India

Document Forensics

Authenticity Check

Aadhaar Masking API

Face Forensics

Face Match API

Liveness Check API

Async APIs

Transport APIs

MSME APIs

GST APIs

GSTIN Verification API - Basic

GSTIN Verification API - Advanced

PAN to GSTIN API

Track GST Return Status API

GST Taxpayer

Session Expiry

Refresh Taxpayer Access

Cash ITC Balance

Cash Ledger

ITC Ledger

Taxpayer

TAN Verification API

TDS Compliance Check API - 206AB & 206CCA

ITR APIs

Create client

Download ITR API

Download 26AS API

Get ITR Details API

Get 26AS Details API

MCA APIs

CIN Verification API

DIN Verification API

Pan Udyam Msme Status API

Financial Services

Credit Score API

Default

Developers

Dive into Deepvue's API Infrastructure for Financial Integrations and Insights to launch products faster.

Deepvue Integration APIs

<p class="slate-p" placeholder="Type / for widgets">Welcome to the <span style="color:#0C5394" class="slate-color">Deepvue Developer Hub! </span>🎉 </p><p class="slate-p" placeholder="Type / for widgets">Here, you&apos;ll find all the tools and resources you need to dive deep into Deepvue.</p><p class="slate-p" placeholder="Type / for widgets">Whether you&apos;re digging into detailed guides or exploring our docs, we&apos;ve got your back. </p><p class="slate-p" placeholder="Type / for widgets">Ready to dive in and start building awesome stuff? Let&apos;s do this! 💻 🚀</p>

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! 💻 🚀

<p class="slate-p" placeholder="Type / for widgets">Deepvue&apos;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&apos; specific needs.</p><p class="slate-p" placeholder="Type / for widgets">The Deepvue APIs are well organised around <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer" target="_blank">REST</a>. All the APIs have predictable resource-oriented URLs, accept query parameters, <a href="https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms" target="_blank">form-encoded</a> request bodies, returns <a href="http://www.json.org/" target="_blank">JSON-encoded</a> responses,
and uses standard HTTP response codes, error codes, and authentication.</p><p class="slate-p" placeholder="Type / for widgets">Just getting started? Let&apos;s integrate step-by-step 💻 </p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Lazy to write code?</h2><p class="slate-p" placeholder="Type / for widgets">Use your <a href="https://dashboard.deepvue.tech/" target="_self">API Dashboard</a> to get started with Deepvue — no code required.</p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Ready to integrate?</h2><p class="slate-p" placeholder="Type / for widgets">Get started with our postman collection - in no time. Here is the <a href="https://hi.deepvue.tech/postman" target="_blank">Link to Postman</a> Collection.</p><div style="text-align:left"><a href="https://hi.deepvue.tech/postman" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1711086868305.png" alt="" style="width:5%"/></a></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

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 

. All the APIs have predictable resource-oriented URLs, accept query parameters, 

 responses,
and uses standard HTTP response codes, error codes, and authentication.

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

 to get started with Deepvue — no code required.

Get started with our postman collection - in no time. Here is the 

<h2 class="slate-h2">Use API keys to Authenticate API requests.</h2><p class="slate-p" placeholder="Type / for widgets">
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.</p><p class="slate-p" placeholder="Type / for widgets">Use the <a href="https://dashboard.deepvue.tech/dashboard/credentials" target="_blank">Deepvue Dashboard</a> to find keys. To access your API keys, navigate to credential section on the Dashboard.</p><p class="slate-p" placeholder="Type / for widgets">Trial account secret keys have the prefix <span style="background-color:var(--s-1y3js6w);color:var(--vvi71e);font-size:0.85em" class="slate-color"><span style="background-color:var(--s-1y3js6w);color:var(--vvi71e);font-size:0.85em" class="slate-backgroundColor"><code style="background-color:var(--s-1y3js6w);color:var(--vvi71e);font-size:0.85em" class="slate-code">free_tier</code></span></span> and live account secret keys have <span style="background-color:var(--s-1y3js6w);color:var(--vvi71e);font-size:0.85em" class="slate-color"><span style="background-color:var(--s-1y3js6w);color:var(--vvi71e);font-size:0.85em" class="slate-backgroundColor"><code style="background-color:var(--s-1y3js6w);color:var(--vvi71e);font-size:0.85em" class="slate-code">live</code></span></span> 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.</p><p class="slate-p" placeholder="Type / for widgets">All API requests must be made over <a href="http://en.wikipedia.org/wiki/HTTP_Secure" target="_blank">HTTPS</a>. Calls made over plain HTTP will fail. API requests without authentication will also fail.</p><h2 class="slate-h2">Keep your keys safe</h2><p class="slate-p" placeholder="Type / for widgets">
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:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative">Grant access only to those who need it.</div></li><li class="slate-li"><div style="position:relative">Don’t store keys in a version control system.</div></li><li class="slate-li"><div style="position:relative">Control access to keys with a password manager or secrets management service.</div></li><li class="slate-li"><div style="position:relative">Don’t embed a key where it could be exposed to an attacker, such as in a mobile application.</div></li></ol><h2 class="slate-h2">View the API request logs</h2><p class="slate-p" placeholder="Type / for widgets">To open the API request logs, click the <a href="https://dashboard.deepvue.tech/dashboard/logs" target="_blank">API Logs</a> on your deepvue dashboard, then select data range and products. Opening the logs redirects you to the main Deepvue Dashboard.</p><p class="slate-p" placeholder="Type / for widgets"></p>

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.

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

Trial account secret keys have the prefix 

 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.

. Calls made over plain HTTP will fail. API requests without authentication will also fail.


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:

 on your deepvue dashboard, then select data range and products. Opening the logs redirects you to the main Deepvue Dashboard.

<p class="slate-p" placeholder="Type / for widgets">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.</p><p class="slate-p" placeholder="Type / for widgets"></p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><span style="color:#1155CB" class="slate-color">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.</span></p></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2">Authorize</h2><p class="slate-p" placeholder="Type / for widgets">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. </p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Authorization Token will be valid for only 24 hours from the time of generating the token</div></li><li class="slate-li"><div style="position:relative">After 24 hours, you need to refresh the token by using the Authorize API Endpoint.</div></li></ul><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(238, 241, 255);color:rgb(74, 89, 175);font-size:14px" class="slate-color"><span style="background-color:rgb(238, 241, 255);color:rgb(74, 89, 175);font-size:14px" class="slate-backgroundColor">You can find your client_id &amp; client_secret on your dashboard under credentials tab. Your &apos;x-api-key&apos; is the same as your client_secret.</span></span></p></div></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

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.

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. 

client_id

client_secret

Content-Type

access_token

token_type

expiry

detail

<p>With these APIs, users can seamlessly integrate Offline Aadhaar ekyc processes into their applications, ensuring a secure and simplified user identification experience.</p><p>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 download</p>

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?

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

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

: 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.

 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.

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.

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

<p>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.</p><h2><strong>Benefits of Digilocker</strong></h2><ol><li><div>Documents can be shared online, accessed anytime, anywhere.</div></li><li></li></ol>

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.

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

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

 : This API allows the platform to download the Aadhaar XML from Digilocker.

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

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

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

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

<p>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.</p><p></p>

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 

<p><span>Set of APIs that help with document forensic checks like template validation, image quality, photocopy, and spoof checks.</span></p><p></p>

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

<p><span>APIs for facial recognition and liveliness verification in real time.</span>
<span>The Face Match API employs advanced algorithms for reliable facial matching, crucial for secure access control and compliance.</span>
<span>The Passive Liveness API</span></p>

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.

<p><span>Verify other Identity documents such as </span><mark><span>Driving</span></mark><span> License, Vehicle Registration Certificate etc. in real time for fast KYC ch</span></p>

Verify other Identity documents such as 

 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.

<p><span>Set of APIs that help with GST Registered business verification and onboarding.</span></p><p></p>

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

<p>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.</p><p>Use the following workflow to access the GST Taxpayer APIs:</p><ol><li><div>The GST taxpayer is authenticated using </div></li></ol>

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:

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:

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

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

<p>ITR APIs includes ITR Verification APIs including 26AS.</p><p>ITR APIs helps businesses download ITR information, such as ITR ID, Filing Year, Acknowledgement Number, ITR Form, Filing Date, ITR status, etc..</p><p></p>

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..

<p><span>Set of APIs that help fetch MCA's Director Master Data &amp; Company Master Data.</span></p><p></p>

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

<p><span>Set of APIs that help with MSME Registered business verification and onboarding.</span></p>

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

<p>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.</p><p>Some of the key things that you can do here are:</p><ol><li><div>Fetch the Credit Report from any of our partner credit bureaus.</div></li></ol>

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: