Getting Started

Quickstart

Make your first Deepvue API call in under 5 minutes. Get your credentials, generate an access token, and verify a PAN number.

Prerequisites

You will need:

A Deepvue account with API credentials from the Dashboard
cURL, Postman, or your preferred programming language

Base URL:

https://production.deepvue.tech

Make your first API call

Get your credentials

Generate an access token

Call the Authorize endpoint to get a Bearer token.

curl -X POST 'https://production.deepvue.tech/v1/authorize' \
  -F 'client_id=YOUR_CLIENT_ID' \
  -F 'client_secret=YOUR_CLIENT_SECRET'

You will receive a response like:

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer",
  "expiry": "2026-03-08T00:00:00Z"
}

Access tokens are valid for 24 hours. Store the token securely for use in subsequent requests.

Verify a PAN number

Use the PAN Basic API to verify a PAN number.

curl -X GET 'https://production.deepvue.tech/v1/verification/panbasic?pan_number=AAAPT0002F' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'x-api-key: YOUR_CLIENT_SECRET'

import requests

headers = {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'x-api-key': 'YOUR_CLIENT_SECRET'
}
response = requests.get(
    'https://production.deepvue.tech/v1/verification/panbasic',
    params={'pan_number': 'AAAPT0002F'},
    headers=headers
)
print(response.json())

const response = await fetch(
  'https://production.deepvue.tech/v1/verification/panbasic?pan_number=AAAPT0002F',
  {
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
      'x-api-key': 'YOUR_CLIENT_SECRET'
    }
  }
);
const data = await response.json();
console.log(data);

Check the response

A successful response looks like:

{
  "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"
    }
  }
}

Use the Postman collection

Prefer a visual interface? Import the official Deepvue Postman collection for ready-to-use requests across all APIs.

Next steps

Authentication

Learn about token management and API key usage.

API Reference

Explore the full API reference.

Error Handling

Understand error codes and troubleshooting.

Was this page helpful?

Built with Documentation.AI

Last updated 2 days ago