NumberLookup

Performs a number lookup.

Request

Security

Basic or Application

Bodyapplication/json

numberstring, non-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 Value	Description
LineType	LineType
SimSwap	SimSwap
VoIPDetection	VoIPDetection (alpha).
RND	RND (alpha).

rndFeatureOptionsobject or null(RndFeatureOptions)

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(LineResponse)

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

simSwapobject or null(SimSwapResponse)

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

voIPDetectionobject or null(VoIPDetectionResponse)

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

rndobject or null(RndResponse)

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

{
  "line": {
    "carrier": "T-Mobile USA",
    "type": "Mobile",
    "mobileCountryCode": "310",
    "mobileNetworkCode": "260",
    "ported": true,
    "portingDate": "2000-01-01 00: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"
}

We'd love to hear from you!