Reference

API Documentation

Real-time validation of US and Canada phone numbers: carrier DIP, line type, portability, deliverability, and geolocation in a single REST call. Sign up for a free API key (500 lookups/month, hard-capped).

POST https://api.checkthatphone.com/v1/lookup

Authentication

Pass the API key from your dashboard as a bearer token in the Authorization header. Keep it secret: anyone with the key can spend your credits.

Header Value
Authorization Bearer YOUR_API_KEY
Content-Type application/json

Request Body

Send a JSON body with the following fields:

Parameter Type Required Description
phone string Yes US or Canada phone number. Accepts any common format — non-digit characters (spaces, dashes, parentheses, +) are stripped and the result must be 10 or 11 digits. A leading 1 country code is fine. E.g. "8182925409", "(818) 292-5409", "+1-818-292-5409".
ip string No IPv4 or IPv6 address of the subscriber. Enables precise GeoIP/timezone enrichment when available.
litigatorFilter boolean No Check the number against our TCPA litigator database. Adds litigator, litigator_type, litigator_name to the response. +1 credit per lookup.
landlineSmsLookup boolean No If the number is a landline, perform an SMS eligibility lookup. Adds dipMessaging* fields. Mobile numbers are unaffected. +1 credit per landline lookup.

Response Envelope

Every response is wrapped in a standard envelope:

Field Type Description
success boolean true if the lookup completed
credits_used number Credits this call consumed: 1 for the base lookup plus 1 for each add-on applied. Also returned in the X-Credits-Used response header. Failed lookups (HTTP 4xx/5xx errors, or upstream service errors) do not consume credits.
data.* object The per-field result described in the Response Fields section below

Code Examples

cURL

curl --request POST \
  --url 'https://api.checkthatphone.com/v1/lookup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"phone":"8182925409","ip":"136.38.145.14","litigatorFilter":false,"landlineSmsLookup":false}'

JavaScript

const response = await fetch('https://api.checkthatphone.com/v1/lookup', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    phone: '8182925409',
    ip: '136.38.145.14',
    litigatorFilter: false,
    landlineSmsLookup: false,
  }),
});
const result = await response.json();
console.log(result.data);

Python

import requests

response = requests.post(
    'https://api.checkthatphone.com/v1/lookup',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'phone': '8182925409',
        'ip': '136.38.145.14',
        'litigatorFilter': False,
        'landlineSmsLookup': False,
    },
)
result = response.json()
print(result['data'])

With add-on features

# Set litigatorFilter and/or landlineSmsLookup to true to enable add-ons
curl --request POST \
  --url 'https://api.checkthatphone.com/v1/lookup' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"phone":"8182925409","litigatorFilter":true,"landlineSmsLookup":true}'

Example Response

{
  "success": true,
  "credits_used": 1,
  "data": {
    "subscriber": "4155551234",
    "optDate": "2026-05-23T06:58:42.048Z",
    "action": "send",
    "deliverable": "true",
    "reason": "",
    "nanpType": "mobile",
    "blackList": "false",
    "dip": "success",
    "dipLrn": "4155551234",
    "dipPorted": "false",
    "dipOcn": "6214",
    "dipCarrier": "AT&T",
    "dipCarrierSubType": "WIRELESS",
    "dipCarrierType": "mobile",
    "geoState": "CA",
    "geoCity": "san francisco",
    "geoCountry": "US",
    "geoSource": "area-code",
    "timezone": "America/Los_Angeles",
    "tzOffset": 8,
    "error": "false"
  }
}

Response Fields

All fields below appear inside data on the response envelope. Fields in the Landline SMS Lookup and Litigator Filter groups are only present when the corresponding request flag is enabled.

Subscriber Info

Field Type Description Example
subscriber string The phone number that was queried. "8182925409"
optDate string ISO 8601 timestamp of when the query was processed. "2026-05-21T18:55:56.532Z"

Deliverability

Field Type Description Example
action string Recommended SMS list action. Returns one of:
  • "send" — the number is reachable. Safe to message.
  • "unsubscribe" — don't message. Triggered by a TCPA litigator match, a non-mobile / non-SMS-capable carrier, an internal blacklist hit, or a carrier deactivation in the last 45 days. Check reason for the specific cause and blackList / deactivationDate for the extras.
  • "error" — the request was malformed (missing or invalid phone). Retrying produces the same error.
"send"
deliverable string Composite reachability summary covering line type, blacklist, litigator filter, and 45-day deactivation checks. Always agrees with action"true" when action is "send", "false" when action is "unsubscribe". Not a real-time delivery probe; carriers do not guarantee actual delivery. "true"
error string "true" if an error occurred while processing this lookup. Inspect reason for details. "false"
reason string Human-readable explanation for the action. The exact strings we return:
  • "Associated with TCPA Litigator DO NOT CONTACT"
  • "Not a valid mobile number"
  • "Blacklisted Subscriber"
  • "Number deactivated by carrier id <N> on <date>"
"Number deactivated by carrier id 6529 on 2025-12-04"
deactivationDate string Date of the most recent deactivation for this number, when known. Our deactivation data refreshes daily; expect a 1–7 day lag between an actual carrier deactivation and the value appearing here. Entries expire after 45 days as the carrier recycles the number. "2019-06-01"
blackList string "true" when the number is on our internal blacklist of flagged numbers OR when the litigator filter matched (litigator hits force this flag). Inspect reason and litigator to disambiguate which check triggered it. Not a DNC or third-party list. "false"

NANP

Field Type Description Example
nanpType string Line type per the North American Numbering Plan. Values: "mobile", "landline", "not-mobile". "mobile"
nanpCarrier string Carrier name per NANP. Not authoritative due to number porting — prefer dipCarrier when available. "verizon"

Carrier DIP

Field Type Description Example
dip string Status of the carrier DIP (Database Dip) lookup. One of "success", "error", "invalid". "success"
dipLrn string Local Routing Number — the number used for actual call/SMS routing. Critical for ported numbers. "8182925409"
dipPorted string "true" when dipLrn differs from subscriber — the standard industry method for detecting that a number has been ported (transferred) to a different carrier than originally assigned. "false"
dipOcn string Operating Carrier Numeric ID — unique identifier code for the current carrier operating this number. "6010"
dipCarrier string Authoritative carrier name from DIP lookup. "AT&T"
dipCarrierType string Broad carrier type. One of "mobile", "landline", "invalid", "undefined". "mobile"
dipCarrierSubType string Carrier sub-classification. Plain-English codes: WIRELESS (mobile carrier), PCS (Personal Communications Service — also mobile), CLEC (Competitive Local Exchange Carrier — landline), ILEC (Incumbent Local Exchange Carrier — wireline), RBOC (Regional Bell Operating Company), IPES (IP-Enabled Service / VoIP), CAP (Competitive Access Provider), LRSL (Local Resale carrier), ULEC (Unbundled Local Exchange Carrier), WRSL (Wireless Resale / MVNO), GENERAL (unclassified). The literal string "undefined" occasionally appears as upstream-data noise from carrier records and is not our classification. "WIRELESS"

Landline SMS Lookup

Field Type Description Example
dipMessagingLookup string Returned only when landlineSmsLookup: true is set. "true" if a landline messaging lookup was actually performed (the number is a landline); "false" if the add-on was requested but the lookup did not apply (e.g. a mobile number). Omitted entirely when the add-on is not requested. "false"
dipMessagingEnabled string Returned only when landlineSmsLookup: true is set. "true" if landline messaging is enabled for this number. Only meaningful alongside dipMessagingLookup: "true". "false"
dipMessagingProvider string Name of the messaging provider serving this landline number. Populated only when the landline messaging lookup returned a positive match. "Google (Grand Central) - SVR"
dipMessagingRefId string Messaging provider's reference ID for this number. "us_acme"
dipMessagingCountryCode string Two-letter country code of the messaging provider. "US"

Litigator Filter

Field Type Description Example
litigator string "true" if the subscriber is a suspected TCPA litigator. Do not contact. Returned when litigatorFilter: true is set on the request. "false"
litigator_type string Litigator classification. One of "litigator", "plaintiff", "agitator". All three carry the same recommended action ("unsubscribe") — the value is informational about how the match was classified in our source data; treat the action identically across all three. "plaintiff"
litigator_name string Name on record for the matched litigator. Present when a likely name is on record; not all matches have a name. Treat as potentially sensitive — handle carefully and do not log unnecessarily. "John Smith"

IP & Geolocation

Field Type Description Example
ipResult string Validation result for the IP address provided with the request. Examples: "valid-v4", "valid-v6". Only populated when an ip parameter is included. "valid-v4"
geoCountry string Two-letter country code where the number is registered. "US"
geoState string Two-letter US state code. "CA"
geoCity string City associated with the phone number, derived from the area code or the provided IP address. "Riverside"
geoMetro number Metro area code (DMA code) for the geographic region of the phone number. 803
geoSource string Source of the geographic data. "ip" when derived from a provided IP address, "area-code" when derived from the phone number itself. "ip"
timezone string IANA timezone identifier for the phone number's location. "America/Los_Angeles"
tzOffset number UTC offset in hours for the phone number's timezone. 8

Errors

Standard HTTP status codes apply. The response envelope carries a structured error when applicable.

Status Meaning
401 Missing or invalid API key.
429 Rate limit exceeded, or your monthly quota is used up (Free tier). Back off and retry, or upgrade your plan. No credit charged.
502 Upstream validation service errored. No credit charged. Safe to retry; contact support if it persists.

Verifying a large list?

You can also upload a CSV from your dashboard. No SDK or batching code required. Up to 1M rows per file, same fields per row, same per-unique-number pricing as this API. See Features → Two ways to call.

Ready to get started?

Sign up free and get an API key in seconds: 500 lookups per month on the free tier.