Complete API reference for all 15 services. Each endpoint requires a valid API key with appropriate permissions.
Get information about any mobile number including owner details, location, and service provider.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | number |
| key | string | Yes | Your API key |
| mobile | string | Yes | 10-digit mobile number |
Get family member details linked to an Aadhar number or other identifier.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | family |
| key | string | Yes | Your API key |
| term | string | Yes | Aadhaar / family ID |
Get mobile number associated with a username or user ID.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | user |
| key | string | Yes | Your API key |
| term | string | Yes | Username / user ID |
Get vehicle registration details including owner name, model, and registration info.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | vehicle |
| key | string | Yes | Your API key |
| registration | string | Yes | Vehicle RC number |
Trace mobile number details including complaints, owner name, SIM card, location, and more.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | calltracer |
| key | string | Yes | Your API key |
| mobile | string | Yes | 10-digit mobile number |
Get FreeFire player information including stats, rank, and profile details using UID.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | freefire |
| key | string | Yes | Your API key |
| uid | string | Yes | FreeFire player UID |
Get GitHub user profile information including repositories, followers, and activity.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | github |
| key | string | Yes | Your API key |
| username | string | Yes | GitHub username |
Get Instagram profile information including followers, posts, and bio.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | insta |
| key | string | Yes | Your API key |
| username | string | Yes | Instagram username |
Get location details for any Indian pincode including city, district, state, and delivery status.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | pincode |
| key | string | Yes | Your API key |
| pincode | string | Yes | 6-digit Indian pincode |
Get Aadhaar card holder information including name, address, and demographic details using Aadhaar number.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | aadhaar |
| key | string | Yes | Your API key |
| aadhaar | string | Yes | 12-digit Aadhaar number |
Get the registered mobile number linked to a vehicle registration number (RC).
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | vehicle_to_number |
| key | string | Yes | Your API key |
| registration | string | Yes | Vehicle RC number |
Get PAN card holder details including name, DOB, and status using a 10-character PAN number.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | pan |
| key | string | Yes | Your API key |
| pan | string | Yes | 10-character PAN (e.g. ABCDE1234F) |
Verify FamPay transactions using a single unified endpoint. Accepts UTR or TXN ID via the id parameter. Uses the API key's linked Gmail + App Password.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | fampay |
| key | string | Yes | API key with Gmail + App Password configured |
| id | string | Yes | UTR or TXN ID (both work) |
txn_id= and utr= params are still supported for backward compatibility.
Check Paytm transaction status via the official Paytm /merchant-status/getTxnStatus endpoint. Uses the API key's linked Merchant ID (MID).
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | paytm |
| key | string | Yes | API key with MID configured |
| order_id | string | Yes | Paytm Order ID |
Verify BharatPe transaction status via official merchant status API. Uses the API key's linked MID.
| Param | Type | Req | Description |
|---|---|---|---|
| type | string | Yes | bharatpe |
| key | string | Yes | API key with MID configured |
| reference | string | Yes | BharatPe reference number |
| mid | string | Optional | Override MID from key |
BHARATPE_STATUS_API_URL and BHARATPE_API_KEY in config.php.
Common error responses you may encounter:
| Error Message | Description |
|---|---|
Missing parameters: type and key required | Missing required parameters |
Invalid API key | API key not found |
API key expired on YYYY-MM-DD HH:MM:SS | Key expired |
This API key does not have permission for 'X' service | Not authorized |
External API not responding (timeout: 10s) | Third-party API down (fast APIs) |
Aadhaar API not responding (timeout: 300s) | Aadhaar API slow |
Gmail/App Password not configured for this key | FamPay key missing credentials |
MID not configured for this key | Paytm/BharatPe key missing MID |
Configure BHARATPE_STATUS_API_URL... | BharatPe not configured |
Please adhere to these guidelines when using the API:
developer and key_expiry fields@patelkrish_99)tag field is auto-replaced with the key's developer name