Skip to content
Number Lookup API/
/NumberLookup

Number Lookup Api v1 (0.1.0)

This is public api specification, for number lookup product.

Download OpenAPI description
number-lookup.json
number-lookup.yaml
Overview
URL

https://www.sinch.com/contact-us/

Sinch

support@sinch.com

License

MIT

Languages
Servers

https://number-lookup.api.sinch.com/

NumberLookup

Operations

Performs a number lookup.

Request

Security
Basic or Application
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

LineType

SimSwap

SimSwap

VoIPDetection

VoIPDetection (alpha).

RND

RND (alpha).

rndFeatureOptionsobject or null

Required when RND feature is requested.

curl -i -X POST \
  -u <username>:<password> \
  https://number-lookup.api.sinch.com/v1/lookups \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "+12312312312",
    "features": [
      "LineType"
    ],
    "rndFeatureOptions": {
      "contactDate": "2019-08-24"
    }
  }'

Responses

Successful response

Bodyapplication/json
lineobject or null

An object containing information about the line type of the number.

simSwapobject or null

An object containing information about the SimSwap verification performed on the number.

voIPDetectionobject or null

An object containing information about the VoIP detection performed on the number.

rndobject or null

An object containing information whether number is disconnected.

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.0000000+00:00",
    "error": { … }
  },
  "simSwap": {
    "swapped": true,
    "swapPeriod": "SP24H",
    "error": { … }
  },
  "voIPDetection": {
    "probability": "High",
    "error": { … }
  },
  "rnd": {
    "disconnected": true,
    "error": { … }
  },
  "countryCode": "string",
  "traceId": "84c1fd4063c38d9f3900d06e56542d48",
  "number": "+12312312312"
}