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.
••••••••••••••••••••••••••••••
Retrieve information about the authenticated user.
GET https://callerapi.com/api/me
{ "status": "success", "email": "[email protected]", "credits_spent": 23498, "credits_monthly": 250000, "credits_left": 226502 }
curl -H 'X-Auth: YOUR_API_KEY' 'https://callerapi.com/api/me'
Retrieve detailed information about a specific phone number.
GET https://callerapi.com/api/lookup/{phone}?hlr=true
Replace {phone}
with the phone number you want to look up. The phone number should be in E.164 format (e.g., +16502530000). Add the optional hlr=true
parameter to include HLR (Home Location Register) data in the response. HLR lookup adds 1-3 seconds to the response time but incurs no additional cost.
{ "status": "success", "data": { "phone": "+16502530000", "entity_type": "BUSINESS", "reputation": "SPAM", "total_complaints": 50, "is_spam": true, "spam_score": 100, "business_info": { "business_name": "Google, Inc.", "category": "services", "city": "Mountain View", "industry": "Internet Products & Services", "state": "CA", "verified": false }, "carrier_info": { "country": { "code": "1", "iso": "US", "name": "United States" }, "network": { "carrier": "Level 3/1", "ocn": "152550", "type": "LANDLINE", "spid": "152550", "original": { "carrier": "MCImetro Former Worldcom/1", "ocn": "152202", "spid": "152202" } }, "number": { "msisdn": "16502530000", "local_format": "(650) 253-0000", "type": "LANDLINE", "landline": true, "mobile": false, "lrn": "4159686199", "valid": "undetermined", "reachable": "undetermined", "ported": true, "timezone": "America/Los_Angeles" } }, "complaints": [ { "CreatedDate": "2025-03-17T09:18:11Z", "ViolationDate": "2025-03-06T12:00:00Z", "ConsumerState": "Georgia", "Subject": "Reducing your debt (credit cards, mortgage, student loans)", "RecordedMessageOrRobocall": "Y" } // ... more complaints ... ] } }
entity_type
: Type of entity (BUSINESS, PERSONAL, UNKNOWN)reputation
: Overall reputation (SPAM, VERIFIED, UNKNOWN)total_complaints
: Total number of FTC complaintsis_spam
: Whether the number is marked as spamspam_score
: Spam likelihood score (0-100)business_name
: Name of the businesscategory
: Business categoryindustry
: Industry classificationcity
: Business city locationstate
: Business state/provinceverified
: Whether the business is verifiedcountry
: Country information (code, ISO, name)network
: Network details:carrier
: Current carrier nameocn
: Operating Company Numberspid
: Service Provider IDtype
: Network type (LANDLINE, MOBILE, VOIP, TOLLFREE)original
: Original carrier informationnumber
: Number details:msisdn
: Full phone numberlocal_format
: Local number formattype
: Line type (LANDLINE, MOBILE, VOIP, TOLLFREE)landline
: Whether it's a landlinemobile
: Whether it's a mobile numberlrn
: Location Routing Numbervalid
: Number validity statusreachable
: Number reachability statusported
: Whether number is portedtimezone
: Number timezoneCreatedDate
: When the complaint was filedViolationDate
: When the violation occurredConsumerState
: State where complaint originatedSubject
: Type of complaintRecordedMessageOrRobocall
: Whether it was a robocall (Y/N)curl -H 'X-Auth: YOUR_API_KEY' 'https://callerapi.com/api/lookup/+16502530000?hlr=true'
These endpoints provide advanced phone number intelligence. Each endpoint requires authentication with your API key.
Note: 1 credit = $0.0039. Credits will be deducted based on the equivalent cost of each request.
Check if a number has been ported and get the most recent porting date.
GET https://callerapi.com/api/ported/{phone}
{ "ported": true, "ported_date": "2016-12-30 15:15:19", "ported_date_type": "exact", "status": 0, "status_message": "Success" }
ported
: Boolean indicating if the number has been ported from its original networkported_date
: Timestamp of the most recent porting event in "YYYY-MM-DD HH:MM:SS" formatported_date_type
: Indicates the reliability of the porting date:current_network
: Information about the current network operator:mcc
: Mobile Country Codemnc
: Mobile Network Codename
: Operator namespid
: Service Provider IDlrn
: 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 messagecurl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/ported/40721987086'
Retrieve the complete history of porting events for a number.
GET https://callerapi.com/api/porting-history/{phone}
{ "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" }
porting_history
: Array of porting events since logging began for the country, ordered from most recent to oldestaction
: Type of porting action:tmtnetwork
: Unique identifier for the network operator involved in the eventi_type
: Network type identifier:ts
: Timestamp of the event in ISO 8601 formatcurrent_network
: Information about the current network operator:mcc
: Mobile Country Codemnc
: Mobile Network Codename
: Operator namespid
: Service Provider IDlrn
: Location Routing Number (if applicable)ported
: Boolean indicating if the number is currently portedstatus
: Response status code (0 = Success)status_message
: Human-readable status messagecurl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/porting-history/40739521819'
Assess the risk of port-out fraud for a number based on recent porting activity.
GET https://callerapi.com/api/port-fraud/{phone}
{ "port_fraud_risk": "low", "status": 0, "status_message": "Success" }
port_fraud_risk
: Assessment of the risk level for potential port-out fraud:risk_factors
: Array of detected risk factors (if any):last_port
: Information about the most recent porting event (if any):date
: Date of the last porting eventfrom
: Source network operatorto
: Destination network operatorstatus
: Response status code (0 = Success)status_message
: Human-readable status messageNote: Port fraud risk assessment combines historical porting data with real-time network signaling checks to evaluate the likelihood of fraudulent porting activity.
curl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/port-fraud/40721987086'
Check if a number is linked to various online platforms and services.
GET https://callerapi.com/api/online-presence/{phone}
{ "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" }
online_presence
: Object containing presence status for various platforms1
: Active - phone number is linked to an active account0
: Inactive - phone number is not linked to an account-1
: Unknown - platform status could not be determined-2
: Error - error occurred while checking platformwhatsapp
: WhatsApp messaging servicetelegram
: Telegram messaging serviceamazon
: Amazon shopping platformgoogle
: Google account servicesoffice365
: Microsoft Office 365instagram
: Instagram social medialinkedin
: LinkedIn professional networktwitter
: Twitter/X social mediaskype
: Skype calling serviceviber
: Viber messaging appfacebook
: Facebook social networkflipkart
: Flipkart shopping platform (India)bukalapak
: Bukalapak shopping platform (Indonesia)error
: Error codeerror_description
: Human-readable error messagestatus
: Response status code:status_message
: Human-readable status messageNote: Platform availability may vary by country. Some platforms are only available in specific regions.
Values: 1 = active, 0 = not active, -1 = unknown
curl -H 'X-Auth: YOUR_API_KEY' \
'https://callerapi.com/api/online-presence/40721987086'
Verify identity information against mobile network operator records.
POST https://callerapi.com/api/kyc/{phone}
{ "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]" }
{ "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" }
name
: Object containing name components to verifyfirst_name
: First/given namemiddle_name
: Middle name (optional)last_name
: Last/family namedob
: Object containing date of birth componentsday
: Day of birth (1-31)month
: Month of birth (1-12)year
: Year of birth (4-digit format)address
: Object containing address componentsstreet
: Street namestreet_no
: Street numberunit_no
: Apartment/unit number (optional)city
: City/town namestate
: State/province/regionpostcode
: Postal/ZIP codecountry
: Country code (ISO 2-letter)email
: Email address to verifykyc_results
: Object containing match scores for each verified fieldfirst_name_score
: Match score for first namemiddle_name_score
: Match score for middle namelast_name_score
: Match score for last nameaddress_score
: Overall match score for the entire addressstreet_name_score
: Match score for street namestreet_no_score
: Match score for street numberunit_no_score
: Match score for unit numbercity_score
: Match score for cityprovince_score
: Match score for state/provincepostcode_score
: Match score for postal codecountry_score
: Match score for countrydob
: Match score for date of birthemail_score
: Match score for email addressstatus
: Response status code (0 = Success)status_message
: Human-readable status message100
: Perfect match - exact match with carrier records75-99
: Strong match - high confidence in data accuracy50-74
: Partial match - some matching elements found1-49
: Weak match - low confidence in data accuracy0
: No match - data exists but does not match-1
: Unknown - carrier has no data for comparisonNote: 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.
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'