API Documentation

Simple integration, powerful real-time caller ID.

Authentication

All API requests require an API key to be sent in the header. You can generate an API key from your dashboard.

api-key: your_api_key_here

Phone Lookup

This endpoint looks up caller information based on the provided phone number.

GET /api/lookup?phone={phone_number}

Example Request

curl -X GET "http://app.accunums.com/api/lookup?phone=+201001234567" \
     -H "api-key: cid_your_api_key"
import requests

url = "http://app.accunums.com/api/lookup"
headers = {"api-key": "cid_your_api_key"}
params = {"phone": "+201001234567"}

response = requests.get(url, headers=headers, params=params)
if response.status_code == 200:
    print(response.json())
else:
    print("Error", response.status_code)
<?php
$apiKey = "cid_your_api_key";
$phone = "+201001234567";
$url = "http://app.accunums.com/api/lookup?phone=" . urlencode($phone);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["api-key: " . $apiKey]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    echo $response;
} else {
    echo "Error: $httpCode";
}
?>

Example Response

{
  "message": "Success",
  "count": 2,
  "phone_number": "+201001234567",
  "data": [
    {
      "full_name": "John Doe",
      "email": "[email protected]"
    },
    {
      "full_name": "Jane Doe",
      "email": null
    }
  ],
  "credits_remaining": 99
}

Supported Phone Formats

Error Codes

HTTP Status Description
400 Missing phone parameter or invalid format
401 Invalid or missing API key
402 Insufficient credits
403 API key disabled
404 No records found

Credits