API Reference
Every Shadoweye endpoint with its parameters, sample requests in six languages and real response shapes. One key works for all of them.
38
Endpoints
5
Categories
6
Languages
Authentication
Send your secret API key in the header of every request. Never expose it in browser or app code.
HTTP status codes
| 200 OK | Request successful. |
| 400 Bad Request | Missing or invalid parameters. |
| 401 Unauthorized | Invalid or missing API Key. |
| 402 Payment Req | Insufficient wallet balance. |
| 403 Forbidden | Server IP is not whitelisted. |
| 502 Bad Gateway | Upstream data provider failed. |
GST Turnover API
Provides financial turnover details of businesses registered under GST. Useful for compliance checks and B2B risk assessment.
Body Parameters
|
GST_Number
Required
|
Valid 15-character GSTIN. |
|
Financial_Year
Optional
|
e.g., "Previous Financial", "2022-23", "2023-24". |
GST Info API
Offers basic GST-related information like GSTIN validity, business constitution, and registration status.
Body Parameters
|
GST_Number
Optional
|
Valid 15-character GSTIN. |
|
CIN_Number
Optional
|
Valid Corporate Identity Number (Provide GST or CIN). |
GST Contact Details
Retrieves the registered email address and mobile number associated with a specific GST Number.
Body Parameters
|
GST_Number
Required
|
Valid 15-character GSTIN. |
Find GST by Mobile
Performs a reverse lookup to find all GST Numbers associated with a specific Indian mobile number.
Body Parameters
|
Mobile_Number
Required
|
10-digit Indian Mobile Number. |
CIN Details
Fetches corporate information, registered addresses, capital structure, and current active directors using a CIN.
Body Parameters
|
CIN_Number
Required
|
Valid Corporate Identity Number. |
Vehicle Chassis Search
Retrieves strict manufacturing details like Registration Date, Engine Number, and Chassis Number.
Body Parameters
|
Vehicle_Number
Required
|
Valid Indian License Plate. |
RC by Mobile Number
Finds all Vehicle Registration Certificate (RC) numbers linked to a specific mobile number.
Body Parameters
|
Mobile_Number
Required
|
10-digit Indian Mobile Number. |
Vehicle Details Basic (V2)
A lighter, faster API offering standard vehicle details, insurance, PUC status, and basic owner info.
Body Parameters
|
Vehicle_Number
Required
|
Valid Indian License Plate. |
Vehicle Details (V3)
Comprehensive vehicle lookup including deep RTO info, detailed Insurance, PUC, and full Owner Information.
Body Parameters
|
Vehicle_Number
Required
|
Valid Indian License Plate. |
Vehicle Details (V4)
Alternative provider route for deep vehicle information and current RTO status.
Body Parameters
|
Vehicle_Number
Required
|
Valid Indian License Plate. |
RC Advance
Fetches extended RC validation data including owner profile, insurance, permit, blacklist, and financer information through the srv2 provider.
Body Parameters
|
reg_no
Required
|
Valid Indian vehicle registration number. |
Aadhaar PDF to PVC Extract
Uploads an e-Aadhaar PDF, validates the PDF password, extracts front/back card images, and returns card previews plus an A4 PDF in base64. Pass your API key in the X-Shadoweye-Api-Key header. If the PDF password is invalid, the API returns an error and wallet balance is not deducted.
Form Data Parameters
|
pdf_file
Required
|
Aadhaar PDF file uploaded as multipart file field. |
|
password
Required
|
Exact Aadhaar PDF password. Invalid password returns an error and no balance deduction. |
|
new_design
Optional
|
Use "true" for the new background design, or "false" for the old design. Default is false. |
|
design_mode
Optional
|
Alternative to new_design. Accepted values: "old" or "new". |
Aadhaar PDF to PVC Extract V2
Uploads an official UIDAI e-Aadhaar PDF, validates its password, detects older A4 and newer 612x792 UIDAI layouts automatically, extracts structured fields with text/OCR/QR fallbacks, and prints a fixed PVC V2 design with front/back card previews plus an A4 PDF download in base64.
Form Data Parameters
|
pdf_file
Required
|
Aadhaar PDF file uploaded as multipart file field. |
|
password
Required
|
Exact Aadhaar PDF password. Invalid password returns an error and no balance deduction. |
|
new_design
Optional
|
Use "true" for the PVC V2 design. |
|
design_mode
Optional
|
Alternative to new_design. Accepted values: "old" or "new". |
|
include_a4_preview
Optional
|
Use "true" only when you also need the A4 preview PNG. Default is false for faster responses. |
Aadhaar PVC V5
Same processing flow as Aadhaar PVC V2, but the front and back card backgrounds use afrontv4.jpg and abackv4.jpg.
Form Data Parameters
|
pdf_file
Required
|
Aadhaar PDF file uploaded as multipart file field. |
|
password
Required
|
Exact Aadhaar PDF password. Invalid password returns an error and no balance deduction. |
|
new_design
Optional
|
Use "true" for the PVC V5 design. |
|
design_mode
Optional
|
Alternative to new_design. Accepted values: "old" or "new". |
|
include_a4_preview
Optional
|
Use "true" only when you also need the A4 preview PNG. Default is false for faster responses. |
Aadhaar PVC Print V3
Uploads an official UIDAI e-Aadhaar PDF, validates its password, renders matched PVC front/back PNG images and an A4 print PDF, and returns every output as base64. Service price is Rs 4. Optional calibration JSON can adjust crop, photo, QR, text block, and A4 print position/size without changing code.
Form Data Parameters
|
pdf_file
Required
|
Aadhaar PDF file uploaded as multipart file field. |
|
password
Required
|
Exact Aadhaar PDF password. Invalid password returns an error and no balance deduction. |
|
extractor_mode
Optional
|
V3 render mode: "exact" keeps attachment-style printed regions, "fields" rebuilds from extracted photo/QR/text, and "auto" uses fields only when extraction is complete. Default is exact. |
|
calibration
Optional
|
Optional JSON for alignment/size tuning. Supports layout.front, layout.back, source_regions.front, source_regions.back, crop, text, and a4 keys. |
|
calibrator
Optional
|
Alias for calibration JSON. |
RC PDF Print Advance (PVC)
Generates a PVC-sized RC PDF using the RC Advance dataset. This endpoint streams a binary PDF file.
Query Parameters
|
vehicle
Required
|
Valid Indian License Plate passed in URL. |
|
format
Required
|
Pass "pvc" in URL. |
|
api_key
Required
|
Your secret API Key passed in URL. |
RC PDF Print Advance (A4)
Generates an A4 RC PDF using the RC Advance dataset. This endpoint streams a binary PDF file.
Query Parameters
|
vehicle
Required
|
Valid Indian License Plate passed in URL. |
|
format
Required
|
Pass "a4" in URL. |
|
api_key
Required
|
Your secret API Key passed in URL. |
RC Pdf Print server 3 (PVC)
Generates a PVC-sized RC PDF using the RC Advance Verification API and the RC PDF Print Advance layout.
Query Parameters
|
vehicle
Required
|
Valid Indian License Plate passed in URL. |
|
format
Required
|
Pass "pvc" in URL. |
|
api_key
Required
|
Your secret API Key passed in URL. |
RC Pdf Print server 3 (A4)
Generates an A4 RC PDF using the RC Advance Verification API and the RC PDF Print Advance layout.
Query Parameters
|
vehicle
Required
|
Valid Indian License Plate passed in URL. |
|
format
Required
|
Pass "a4" in URL. |
|
api_key
Required
|
Your secret API Key passed in URL. |
DL PDF Print (PVC)
Generates a PVC-sized Driving Licence PDF using DL Verification Plus data. This endpoint streams a binary PDF file.
Query Parameters
|
dlNumber
Required
|
Driving licence number passed in URL. |
|
dob
Required
|
Date of birth in DD-MM-YYYY format. |
|
format
Required
|
Pass "pvc" in URL. |
|
address
Optional
|
Optional address override when the DL provider does not return address. |
|
api_key
Required
|
Your secret API Key passed in URL. |
DL PDF Print (A4)
Generates an A4 Driving Licence PDF containing front and back sides. This endpoint streams a binary PDF file.
Query Parameters
|
dlNumber
Required
|
Driving licence number passed in URL. |
|
dob
Required
|
Date of birth in DD-MM-YYYY format. |
|
format
Required
|
Pass "a4" in URL. |
|
address
Optional
|
Optional address override when the DL provider does not return address. |
|
api_key
Required
|
Your secret API Key passed in URL. |
Mobile Prefill
BilAPI Mobile Prefill V2 lookup returning personal, phone, address, email, and linked identity information.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Mobile Data
Returns the complete BilAPI Mobile Prefill V2 response for a mobile number.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Mobile to PAN Find
Returns PAN numbers and personal information linked to a mobile number through BilAPI Mobile Prefill V2.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Find Address
Returns addresses reported against a mobile number through BilAPI Mobile Prefill V2.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Mobile to DL
Returns driving-licence numbers linked to a mobile number through BilAPI Mobile Prefill V2.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Mobile to Ration Card Number
Returns ration-card numbers linked to a mobile number through BilAPI Mobile Prefill V2.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Mobile by DIN/LinkedIn
Attempts to resolve a mobile number using either a Director Identification Number (DIN) or LinkedIn Username.
Body Parameters
|
DIN_Number
Optional
|
Valid DIN Number. |
|
Linkedin_Username
Optional
|
Valid LinkedIn Profile Handle. |
People Address
Returns addresses reported against a mobile number using BilAPI Mobile Prefill V2.
Body Parameters
|
mobile
Required
|
10-digit Indian mobile number. |
Voter Mobile Instant
Instant voter mobile linking through the active admin-selected provider. QRHUB keeps the previous flow, while RCVERIFICATION uses a built-in default signer name and returns an eSign URL.
Body Parameters
|
epic_no
Required
|
EPIC / voter number. |
|
mobile_no
Required
|
10-digit mobile number. |
Voter Mobile Instant V2
Dedicated RCVERIFICATION-based instant voter mobile linking API. Uses the built-in default signer name and returns eSign details in the same response.
Body Parameters
|
epic_no
Required
|
EPIC / voter number. |
|
mobile_no
Required
|
10-digit mobile number. |
PAN Details (V2)
Offers basic PAN verification, returning Full Name, Father Name, DOB, and masked Aadhaar linkage.
Body Parameters
|
PAN_Number
Required
|
Valid 10-character PAN. |
PAN Details (V3)
Deep PAN verification. Returns standard data plus linked address details and tax filing status.
Body Parameters
|
PAN_Number
Required
|
Valid 10-character PAN. |
PAN Details (V5)
Advanced PAN profile lookup through the srv2 provider with PAN status, Aadhaar linkage, name breakup, DOB, and allotment details.
Body Parameters
|
pan
Required
|
Valid 10-character PAN. |
DL Verify
Driving licence verification through the srv2 provider with validity blocks, address details, COV classes, and licence profile information.
Body Parameters
|
dlNumber
Required
|
Driving licence number. |
|
dob
Required
|
Date of birth in DD-MM-YYYY format. |
LPG Connection Details
Retrieves active gas connections, consumer ID, and distributor details linked to a phone number.
Body Parameters
|
Mobile_Number
Required
|
10-digit Indian Mobile Number. |
User UPI Lookup
Retrieves active UPI IDs and associated bank account names for a mobile number.
Body Parameters
|
Mobile_Number
Required
|
10-digit Indian Mobile Number. |
CIBIL Report
Triggers an asynchronous fetch of a user's credit history. Report is sent to your callback URL.
Body Parameters
|
Mobile_Number
Required
|
10-digit Indian Mobile Number. |
|
Callback_Url
Required
|
Your webhook URL to receive the async report. |