What is a Caller ID API?

A Caller ID API is a software interface that allows applications to retrieve information about a phone number, such as the caller's name, location, and other relevant details. It enables businesses and developers to integrate real-time phone number identification and validation into their systems, enhancing communication, security, and user experience.

How do Caller ID APIs work?

Caller ID APIs work by querying vast databases of phone number information. When a phone number is submitted to the API, it searches these databases and returns available information. Many modern APIs use real-time data scraping techniques to gather the most up-to-date information from various online sources, ensuring accuracy and relevance of the data provided.

What information can a Caller ID API provide?

A Caller ID API can typically provide various types of information, including: the caller's name, phone number type (mobile, landline, VoIP), carrier information, location data (country, state, city), spam risk assessment, line type (personal or business), and sometimes additional data like social media profiles or email addresses associated with the number.

Are Caller ID APIs legal and compliant with privacy regulations?

Caller ID APIs can be legal and compliant with privacy regulations, but it depends on how they're implemented and used. Reputable API providers ensure compliance with regulations like GDPR and CCPA by only processing legally obtainable data, implementing strict data security measures, and providing transparency in data collection and usage practices. Users of these APIs should also ensure their own compliance when handling the data.

How accurate are Caller ID APIs?

The accuracy of Caller ID APIs can vary depending on the provider and the specific number being queried. APIs that use real-time data scraping from multiple sources tend to be more accurate as they provide the most up-to-date information. However, accuracy can be affected by factors such as how frequently the source data is updated, the geographical region of the number, and whether the number is listed or unlisted.

What are common use cases for Caller ID APIs?

Common use cases for Caller ID APIs include: enhancing customer relationship management (CRM) systems, improving call center efficiency, fraud detection and prevention, spam call filtering, verifying user identities during account creation, personalizing user experiences in communication apps, and enriching contact databases with additional information.

How can businesses integrate a Caller ID API into their systems?

Businesses can integrate Caller ID APIs into their systems through various methods: using RESTful API endpoints, implementing SDK libraries for popular programming languages, setting up webhook support for real-time notifications, or utilizing direct integrations with popular CRM and communication platforms. The specific integration method often depends on the API provider and the business's technical requirements.

Can Caller ID APIs help in preventing spam calls and fraud?

Yes, Caller ID APIs can be effective in preventing spam calls and fraud. Many APIs offer features such as spam risk assessment, which evaluates the likelihood of a number being associated with spam or fraudulent activities. They may also provide real-time blacklist checking, call type identification (e.g., distinguishing between human-initiated calls and robocalls), and customizable filtering rules, all of which can significantly enhance spam and fraud prevention measures.

What should be considered when choosing a Caller ID API provider?

When choosing a Caller ID API provider, consider factors such as: data accuracy and freshness, coverage of phone numbers (local and international), types of information provided, pricing structure, API performance and reliability, ease of integration, quality of documentation and support, compliance with relevant regulations, and additional features like fraud detection or number validation services.

Are there any limitations to Caller ID APIs?

Caller ID APIs do have some limitations. These may include: incomplete or outdated information for some numbers, particularly unlisted or recently changed numbers; potential inaccuracies due to reliance on third-party data sources; limited information for certain geographic regions or countries; and privacy restrictions that may limit the amount of personal information that can be legally provided. Additionally, API usage often comes with rate limits and costs that need to be considered for large-scale implementations.

How accurate is CallerAPI's phone number identification and validation service?

CallerAPI strives to provide highly accurate phone number identification and validation services through real-time data scraping from multiple reliable sources, aggregating information from popular mobile apps and online platforms, cross-referencing data from various sources, and continuously adapting our scraping algorithms to maintain data quality.

Is CallerAPI compliant with data privacy regulations like GDPR and CCPA?

Yes, CallerAPI is fully compliant with major data privacy regulations, including GDPR and CCPA. We prioritize user privacy and data protection by processing only legally obtainable data, implementing strict data security measures, providing transparency in our data collection and usage practices, offering data subject rights management tools, and regularly auditing our compliance measures.

What types of phone numbers does CallerAPI support?

CallerAPI offers comprehensive support for various types of phone numbers, including mobile numbers, landline numbers, VoIP numbers, toll-free numbers, and international numbers across multiple countries and regions.

How can businesses integrate CallerAPI into their existing systems?

Businesses can integrate CallerAPI into their existing systems through multiple options: RESTful API endpoints, SDK libraries for popular programming languages, webhook support for real-time notifications, and direct integrations with popular CRM platforms.

What are the key features of CallerAPI's phone number validation service?

Key features include real-time number validation, caller identification, number type detection, carrier information, spam risk assessment, line type identification, number portability check, and international number formatting.

How does CallerAPI's pricing work, and are there different plans available?

CallerAPI offers flexible pricing options including a Basic Plan ($25/month), Premium Plan ($99/month), and Enterprise Plan with custom pricing. We also offer a pay-as-you-go option for businesses with fluctuating needs.

How does CallerAPI ensure data security and protect sensitive information?

CallerAPI ensures data security through end-to-end encryption, regular security audits, strict access controls, compliance with industry-standard security certifications, data anonymization techniques, and secure data centers with physical and virtual protection measures.

Can CallerAPI help with blocking spam calls and preventing fraud?

Yes, CallerAPI offers features to combat spam calls and prevent fraud, including spam risk assessment, fraud detection using machine learning algorithms, real-time blacklist checking, call type identification, and customizable filtering rules.

What kind of support does CallerAPI provide to its customers?

CallerAPI provides comprehensive support including 24/7 technical support, detailed documentation, access to a developer community, dedicated account managers for enterprise customers, regular webinars and training sessions, and custom integration assistance.

How does CallerAPI gather and update its caller information?

CallerAPI uses advanced web scraping techniques to gather caller information in real-time from various online resources, including popular mobile apps and internet resources. We don't maintain a static database, ensuring that each query fetches the most up-to-date information available online.

Authentication

To use the CallerAPI, include your API key in the header of each request:

X-Auth: YOUR_API_KEY

Replace YOUR_API_KEY with the actual API key provided in your CallerAPI dashboard.

API Key

••••••••••••••••••••••••••••••

Get User Information

Retrieve information about the authenticated user.

GET https://callerapi.com/api/me

Response

{
    "status": "success",
    "email": "[email protected]",
    "credits_spent": 23498,
    "credits_monthly": 250000,
    "credits_left": 226502
}

Code Examples

curl -H 'X-Auth: YOUR_API_KEY' 'https://callerapi.com/api/me'

import requests

url = "https://callerapi.com/api/me"
headers = {
    "X-Auth": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

fetch('https://callerapi.com/api/me', {
    headers: {
        'X-Auth': 'YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone_number = "18006927753";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/phone/info/$phone_number");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth: YOUR_API_KEY'));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);

Get Phone Number Information

Retrieve detailed information about a specific phone number.

GET https://callerapi.com/api/phone/info/{phone}

Replace {phone} with the phone number you want to look up. The phone number should be in E.164 format (e.g., +18006927753).

Response

The response is a JSON object containing information from various sources. Here's a breakdown of the main sections:

callerapi: Internal spam and block data
truecaller: Basic phone number validation and carrier info
callapp: Detailed business information and social media profiles
viewcaller: Community-sourced names and spam reports
eyecon: Contact name information
hiya: Reputation data and user comments

{
    "status": "success",
    "callerapi": {
        "name": null,
        "spam_count": 0,
        "block_count": 0,
        "is_spam": false,
        "spam_score": 0
    },
    "truecaller": {
        "number": "+1 800-692-7753",
        "is_valid": true,
        "country_code": 1,
        "national_number": 8006927753,
        "country": "United States",
        "number_type": 3,
        "number_type_label": "Toll free",
        "provider": "",
        "time_zones": ["America/New_York", "America/Chicago", "America/Denver", "America/Los_Angeles"]
    },
    "eyecon": "Apple Inc.",
    "callapp": {
        "name": "apple inc.",
        "websites": [
            {"websiteUrl": "http://www.apple.com/"},
            {"websiteUrl": "https://www.apple.com/"},
            {"websiteUrl": "http://m.yelp.com/biz/apple-computer-headquarters-cupertino"}
        ],
        "addresses": [
            {"type": 1, "street": "Summit Boulevard, 35243, Vestavia Hills"},
            {"type": 1, "street": "320 S Capital of Texas Hwy, West Lake Hills, TX 78746, USA"}
        ],
        "photoUrl": "https://lh3.googleusercontent.com/p/AF1QipPmIDDqiF56xI9-dF3etwxfTYmlZrpKJKn_2T9r=k",
        "categories": [
            {"name": "Shopping & Retail"},
            {"name": "Computer & Equipment Dealers"}
        ],
        "avgRating": 4.6,
        "priceRange": 3,
        "description": "Apple retail store showcasing the brand's phones, tablets & more in sleekly designed spaces.",
        "openingHours": {
            "sunday": ["07:00 - 16:00"],
            "monday": ["05:00 - 20:00"],
            "tuesday": ["05:00 - 20:00"],
            "wednesday": ["05:00 - 20:00"],
            "thursday": ["05:00 - 20:00"],
            "friday": ["05:00 - 20:00"],
            "saturday": ["07:00 - 16:00"]
        },
        "facebookID": {"id": "114092991968595", "sure": true, "version": 1},
        "linkedinPubProfileUrl": {"id": "http://www.linkedin.com/pub/claudia-smith/30/565/a31", "sure": true, "version": 1},
        "twitterScreenName": {"id": "djsetroc", "sure": true, "version": 1},
        "googlePlusID": {"id": "115474023033355232032", "sure": true, "version": 1},
        "foursquareID": {"id": "12550046", "sure": true, "version": 1},
        "instagramID": {"id": "230216465", "sure": true, "version": 1},
        "pinterestID": {"id": "caseybrunetti", "sure": true, "version": 1},
        "lat": 30.30219640000001,
        "lng": -97.8296238,
        "url": "https://maps.google.com/?cid=2099657283551182410",
        "googlePlacesId": "ChIJfTemqIdKW4YRopyJNzlsVwE",
        "huaweiPlacesId": "798EC49D94E53FA0CC39A9A66E3FCA90",
        "spamScore": 343,
        "priority": 37744
    },
    "viewcaller": [
        {
            "name": "apple inc.",
            "prefix": "1",
            "number": "8006927753",
            "spamCounter": 0,
            "spam": false,
            "names": [
                {
                    "name": "apple inc.",
                    "occurrences": 9273,
                    "isSpam": false
                },
                {
                    "name": "apple",
                    "occurrences": 609,
                    "isSpam": false
                }
            ],
            "namesCount": 2
        }
    ],
    "hiya": {
        "name": "Apple Inc.",
        "type": "Business",
        "is_spam": false,
        "reputation": "UNCERTAIN",
        "spam_score": 0,
        "reputation_score": 100,
        "category": "Technology",
        "comments": {
            "reports": [
                {
                    "id": "unique-id",
                    "phone": "1/8006927753",
                    "timestamp": "2024-02-14T12:53:21.190Z",
                    "comment": {
                        "languageTag": "en-US",
                        "str": "Apple Support"
                    },
                    "category": 1
                }
            ]
        }
    }
}

Field Descriptions

CallerAPI Fields

spam_count: Number of spam reports
block_count: Number of times the number was blocked
is_spam: Whether the number is marked as spam
spam_score: Spam likelihood score (0-100)

Truecaller Fields

is_valid: Whether the number is valid
country: Country of the phone number
number_type_label: Type of number (mobile, landline, etc.)
provider: Carrier/provider name

CallApp Fields

websites: Associated websites
addresses: Physical addresses
categories: Business categories
openingHours: Business hours
spamScore: Spam likelihood score

ViewCaller Fields

spamCounter: Number of spam reports
names: List of reported names with occurrence counts
namesCount: Total number of reported names

Hiya Fields

reputation: Overall reputation (GOOD, SPAM, UNCERTAIN)
spam_score: Spam likelihood score (0-100)
comments: User-submitted reports and comments

Comment Categories

Not Spam Type

1: Not Spam - Legitimate calls

Nuisance Type

2: General Spam - Non-specific spam calls
3: Debt Collector - Collection agency calls
4: Political - Campaign or political calls
5: Nonprofit - Charity or nonprofit organization calls
6: Telemarketer - Sales and marketing calls
7: Survey - Market research or survey calls

Risk Type

8: Fraud - Scam or fraudulent calls
10: Robocaller - Automated calling systems

Code Examples

curl -H 'X-Auth: YOUR_API_KEY' 'https://callerapi.com/api/phone/info/18006927753'

import requests

phone_number = "18006927753"
url = f"https://callerapi.com/api/phone/info/{phone_number}"
headers = {
    "X-Auth": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())

const phoneNumber = '18006927753';
fetch(`https://callerapi.com/api/phone/info/${phoneNumber}`, {
    headers: {
        'X-Auth': 'YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone_number = "18006927753";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/phone/info/$phone_number");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth: YOUR_API_KEY'));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);

KYC API

These endpoints provide advanced phone number intelligence. Each endpoint requires authentication with your API key.

Pricing

Network Intelligence

Ported Date €0.008
Porting History €0.02
Port Fraud Risk €0.02

Advanced Verification

Online Presence €0.15
KYC Match €0.30

Note: 1 credit = $0.0039. Credits will be deducted based on the equivalent cost of each request.

Get Porting Information

Check if a number has been ported and get the most recent porting date.

GET https://callerapi.com/api/ported/{phone}

Response

{
    "ported": true,
    "ported_date": "2016-12-30 15:15:19",
    "ported_date_type": "exact",
    "status": 0,
    "status_message": "Success"
}

Field Descriptions

Porting Information Fields

ported: Boolean indicating if the number has been ported from its original network
ported_date: Timestamp of the most recent porting event in "YYYY-MM-DD HH:MM:SS" format
ported_date_type: Indicates the reliability of the porting date:

"exact": Precise porting date and time from network records
"estimate": Approximate date based on available data
"unknown": Porting occurred but exact date cannot be determined

current_network: Information about the current network operator:

mcc: Mobile Country Code
mnc: Mobile Network Code
name: Operator name
spid: Service Provider ID
lrn: Location Routing Number (if applicable)

origin_network: Information about the original network operator that issued the number (same fields as current_network)
present: Indicates if the number is currently active in the network ("yes", "no", or "n/a")
status: Response status code (0 = Success)
status_message: Human-readable status message

Code Examples

curl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/ported/40721987086'

import requests

phone = "40721987086"
url = f"https://callerapi.com/api/ported/{phone}"
headers = {
    "X-Auth": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const phone = '40721987086';
fetch(`https://callerapi.com/api/ported/${phone}`, {
    headers: {
        'X-Auth': 'YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone = "40721987086";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/ported/$phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth: YOUR_API_KEY'));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

Get Porting History

Retrieve the complete history of porting events for a number.

GET https://callerapi.com/api/porting-history/{phone}

Response

{
    "porting_history": [
        {
            "action": "D",
            "tmtnetwork": 4018720,
            "i_type": "m",
            "ts": "2022-01-31T00:00:00"
        },
        {
            "action": "A",
            "tmtnetwork": 4018740,
            "i_type": "m",
            "ts": "2021-03-18T00:00:00"
        }
    ],
    "status": 0,
    "status_message": "Success"
}

Field Descriptions

Porting History Fields

porting_history: Array of porting events since logging began for the country, ordered from most recent to oldest
Each porting event contains:

action: Type of porting action:

"A": Addition - number added to network
"D": Deletion - number removed from network
"C": Change - network details changed
"P": Port - number ported between networks
"R": Return - number returned to original network

tmtnetwork: Unique identifier for the network operator involved in the event
i_type: Network type identifier:

"m": Mobile network operator
"f": Fixed/landline network
"v": VoIP provider
"o": Other network type

ts: Timestamp of the event in ISO 8601 format

current_network: Information about the current network operator:

mcc: Mobile Country Code
mnc: Mobile Network Code
name: Operator name
spid: Service Provider ID
lrn: Location Routing Number (if applicable)

ported: Boolean indicating if the number is currently ported
status: Response status code (0 = Success)
status_message: Human-readable status message

Code Examples

curl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/porting-history/40739521819'

import requests

phone = "40739521819"
url = f"https://callerapi.com/api/porting-history/{phone}"
headers = {
    "X-Auth": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const phone = '40739521819';
fetch(`https://callerapi.com/api/porting-history/${phone}`, {
    headers: {
        'X-Auth': 'YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone = "40739521819";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/porting-history/$phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth: YOUR_API_KEY'));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

Get Port Fraud Risk

Assess the risk of port-out fraud for a number based on recent porting activity.

GET https://callerapi.com/api/port-fraud/{phone}

Response

{
    "port_fraud_risk": "low",
    "status": 0,
    "status_message": "Success"
}

Field Descriptions

Port Fraud Risk Fields

port_fraud_risk: Assessment of the risk level for potential port-out fraud:

"none": No risk detected - no recent porting activity or suspicious patterns
"low": Minimal risk - normal porting activity within expected patterns
"medium": Moderate risk - some unusual porting patterns detected
"high": Significant risk - multiple suspicious porting events or patterns
"critical": Very high risk - clear indicators of potential port-out fraud

risk_factors: Array of detected risk factors (if any):

"recent_port": Recent porting activity within last 30 days
"multiple_ports": Multiple porting events in short timeframe
"suspicious_pattern": Unusual porting pattern detected
"known_fraud": Previous fraud activity associated with number
"cross_border": International porting activity

last_port: Information about the most recent porting event (if any):

date: Date of the last porting event
from: Source network operator
to: Destination network operator

status: Response status code (0 = Success)
status_message: Human-readable status message

Note: Port fraud risk assessment combines historical porting data with real-time network signaling checks to evaluate the likelihood of fraudulent porting activity.

Code Examples

curl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/port-fraud/40721987086'

import requests

phone = "40721987086"
url = f"https://callerapi.com/api/port-fraud/{phone}"
headers = {
    "X-Auth": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const phone = '40721987086';
fetch(`https://callerapi.com/api/port-fraud/${phone}`, {
    headers: {
        'X-Auth': 'YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone = "40721987086";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/port-fraud/$phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth: YOUR_API_KEY'));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

Get Online Presence

Check if a number is linked to various online platforms and services.

GET https://callerapi.com/api/online-presence/{phone}

Response

{
    "online_presence": {
        "whatsapp": 1,
        "telegram": 0,
        "amazon": 1,
        "google": 1,
        "office365": 1,
        "instagram": 1,
        "linkedin": -1,
        "twitter": 1,
        "skype": 0,
        "viber": 0
    },
    "status": 0,
    "status_message": "Success"
}

Field Descriptions

Online Presence Fields

online_presence: Object containing presence status for various platforms
Status values for each platform:

1: Active - phone number is linked to an active account
0: Inactive - phone number is not linked to an account
-1: Unknown - platform status could not be determined
-2: Error - error occurred while checking platform

Supported platforms:

whatsapp: WhatsApp messaging service
telegram: Telegram messaging service
amazon: Amazon shopping platform
google: Google account services
office365: Microsoft Office 365
instagram: Instagram social media
linkedin: LinkedIn professional network
twitter: Twitter/X social media
skype: Skype calling service
viber: Viber messaging app
facebook: Facebook social network
flipkart: Flipkart shopping platform (India)
bukalapak: Bukalapak shopping platform (Indonesia)

Error response fields (when status = 4):

error: Error code
error_description: Human-readable error message

status: Response status code:

0: Success - all platforms checked successfully
4: Partial Reply - some platform checks failed

status_message: Human-readable status message

Note: Platform availability may vary by country. Some platforms are only available in specific regions.

Values: 1 = active, 0 = not active, -1 = unknown

Code Examples

curl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/online-presence/40721987086'

import requests

phone = "40721987086"
url = f"https://callerapi.com/api/online-presence/{phone}"
headers = {
    "X-Auth": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const phone = '40721987086';
fetch(`https://callerapi.com/api/online-presence/${phone}`, {
    headers: {
        'X-Auth': 'YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone = "40721987086";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/online-presence/$phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth: YOUR_API_KEY'));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

KYC Match

Verify identity information against mobile network operator records.

POST https://callerapi.com/api/kyc/{phone}

Request Body

{
    "name": {
        "first_name": "John",
        "middle_name": "Robert",
        "last_name": "Smith"
    },
    "dob": {
        "day": "2",
        "month": "11",
        "year": "1985"
    },
    "address": {
        "street": "Omnia",
        "street_no": "23",
        "unit_no": "11A",
        "city": "Toronto",
        "state": "Ontario",
        "postcode": "M4B1B3",
        "country": "CA"
    },
    "email": "[email protected]"
}

Response

{
    "kyc_results": {
        "first_name_score": 100,
        "last_name_score": 100,
        "middle_name_score": -1,
        "address_score": 78,
        "dob": 50,
        "email_score": 100
    },
    "status": 0,
    "status_message": "Success"
}

Field Descriptions

Request Fields

name: Object containing name components to verify

first_name: First/given name
middle_name: Middle name (optional)
last_name: Last/family name

dob: Object containing date of birth components

day: Day of birth (1-31)
month: Month of birth (1-12)
year: Year of birth (4-digit format)

address: Object containing address components

street: Street name
street_no: Street number
unit_no: Apartment/unit number (optional)
city: City/town name
state: State/province/region
postcode: Postal/ZIP code
country: Country code (ISO 2-letter)

email: Email address to verify

Response Fields

kyc_results: Object containing match scores for each verified field

Name component scores:

first_name_score: Match score for first name
middle_name_score: Match score for middle name
last_name_score: Match score for last name

Address component scores:

address_score: Overall match score for the entire address
street_name_score: Match score for street name
street_no_score: Match score for street number
unit_no_score: Match score for unit number
city_score: Match score for city
province_score: Match score for state/province
postcode_score: Match score for postal code
country_score: Match score for country

dob: Match score for date of birth
email_score: Match score for email address

status: Response status code (0 = Success)
status_message: Human-readable status message

Score Values

100: Perfect match - exact match with carrier records
75-99: Strong match - high confidence in data accuracy
50-74: Partial match - some matching elements found
1-49: Weak match - low confidence in data accuracy
0: No match - data exists but does not match
-1: Unknown - carrier has no data for comparison

Note: Different carriers may use different matching algorithms. Some use percentage-based scoring while others use simple match/no-match (converted to 100/0). All responses are normalized to the -1 to 100 scale.

Code Examples

curl -X POST -H 'X-Auth: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
    "name": {
        "first_name": "John",
        "middle_name": "Robert",
        "last_name": "Smith"
    },
    "dob": {
        "day": "2",
        "month": "11",
        "year": "1985"
    },
    "address": {
        "street": "Omnia",
        "street_no": "23",
        "unit_no": "11A",
        "city": "Toronto",
        "state": "Ontario",
        "postcode": "M4B1B3",
        "country": "CA"
    },
    "email": "[email protected]"
}' \
'https://callerapi.com/api/kyc/40721987086'

import requests

phone = "40721987086"
url = f"https://callerapi.com/api/kyc/{phone}"
headers = {
    "X-Auth": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "name": {
        "first_name": "John",
        "middle_name": "Robert",
        "last_name": "Smith"
    },
    "dob": {
        "day": "2",
        "month": "11",
        "year": "1985"
    },
    "address": {
        "street": "Omnia",
        "street_no": "23",
        "unit_no": "11A",
        "city": "Toronto",
        "state": "Ontario",
        "postcode": "M4B1B3",
        "country": "CA"
    },
    "email": "[email protected]"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const phone = '40721987086';
const data = {
    name: {
        first_name: "John",
        middle_name: "Robert",
        last_name: "Smith"
    },
    dob: {
        day: "2",
        month: "11",
        year: "1985"
    },
    address: {
        street: "Omnia",
        street_no: "23",
        unit_no: "11A",
        city: "Toronto",
        state: "Ontario",
        postcode: "M4B1B3",
        country: "CA"
    },
    email: "[email protected]"
};

fetch(`https://callerapi.com/api/kyc/${phone}`, {
    method: 'POST',
    headers: {
        'X-Auth': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

$phone = "40721987086";
$data = array(
    'name' => array(
        'first_name' => "John",
        'middle_name' => "Robert",
        'last_name' => "Smith"
    ),
    'dob' => array(
        'day' => "2",
        'month' => "11",
        'year' => "1985"
    ),
    'address' => array(
        'street' => "Omnia",
        'street_no' => "23",
        'unit_no' => "11A",
        'city' => "Toronto",
        'state' => "Ontario",
        'postcode' => "M4B1B3",
        'country' => "CA"
    ),
    'email' => "[email protected]"
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://callerapi.com/api/kyc/$phone");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'X-Auth: YOUR_API_KEY',
    'Content-Type: application/json'
));

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

API Reference

Authentication

API Key

Get User Information

Response

Code Examples

Get Phone Number Information

Response

Field Descriptions

CallerAPI Fields

Truecaller Fields

CallApp Fields

ViewCaller Fields

Hiya Fields

Comment Categories

Not Spam Type

Nuisance Type

Risk Type

Code Examples

KYC API

Pricing

Network Intelligence

Advanced Verification

Get Porting Information

Response

Field Descriptions

Porting Information Fields

Code Examples

Get Porting History

Response

Field Descriptions

Porting History Fields

Code Examples

Get Port Fraud Risk

Response

Field Descriptions

Port Fraud Risk Fields

Code Examples

Get Online Presence

Response

Field Descriptions

Online Presence Fields

Code Examples

KYC Match

Request Body

Response

Field Descriptions

Request Fields

Response Fields

Score Values

Code Examples