Skip to content
Number Lookup API/
/
Lookup number

Number Lookup Api v2 (0.1.0)

With quick and easy access to Number Lookup, you can enhance your communications and keep your database as clean as a whistle. Number Lookup checks against first-party numbering sources and provides real-time feedback. Improve communication by validating and verifying numbers, boosting delivery conversion rates, and saving money on marketing campaigns. Test numbers to ensure your recipients are ready and waiting to receive your messages!

Download OpenAPI description
number-lookup-v2.json
number-lookup-v2.yaml
Overview
URL
https://www.sinch.com/contact-us/
Sinch
support@sinch.com
License
MIT
Languages
Servers
https://lookup.api.sinch.com/

Lookup number

Request

Performs a number lookup. You can make a minimal request or add additional options to the features array.

Security
Basic or OAuth2
Path
projectIdstringrequired
Bodyapplication/json
numberstringnon-emptyrequired

MSISDN in E.164 format to query.

Example: "+12312312312"
featuresArray of strings(ApiFeature)

Contains requested features. Fallback to LineType if not provided.

Items Enum ValueDescription
LineType

Use to return line type information for the phone number.

SimSwap

Use to determine whether the phone number is SIM swapped.

VoIPDetection

Use to determine if the carrier is associated with a VoIP provider (alpha).

RND

Use to determine whether the phone number has been disconnected (alpha).

rndFeatureOptionsobject or null
curl -i -X POST \
  -u <username>:<password> \
  'https://lookup.api.sinch.com/v2/projects/{projectId}/lookups' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "+12312312312"
  }'

Responses

Successful response

Bodyapplication/json
lineobject or null
simSwapobject or null
voIPDetectionobject or null
rndobject or null
countryCodestring

ISO 3166-1 alpha-2 two-letter country identifier

traceIdstring

The identifier for a trace.

Example: "84c1fd4063c38d9f3900d06e56542d48"
numberstring

Requested MSISDN in E.164 format.

Example: "+12312312312"
Response
application/json
{
  "line": {
    "carrier": "T-Mobile USA",
    "type": "Mobile",
    "mobileCountryCode": "310",
    "mobileNetworkCode": "260",
    "ported": true,
    "portingDate": "2000-01-01T00:00:00+00:00",
    "error": { … }
  },
  "simSwap": {
    "swapped": true,
    "swapPeriod": "SP24H",
    "error": { … }
  },
  "voIPDetection": {
    "probability": "High",
    "error": { … }
  },
  "rnd": {
    "disconnected": true,
    "error": { … }
  },
  "countryCode": "string",
  "traceId": "84c1fd4063c38d9f3900d06e56542d48",
  "number": "+12312312312"
}