Download OpenAPI specification:Download

NumberLookup

Performs a number lookup.

Request
Request Body schema: application/json
number
string

MSISDN in E.164 format to query.

features
Array of strings (ApiFeature)
Items Enum: "LineType" "SimSwap" "VoIPDetection" "RND"
Responses
200

Successful response

Response Schema: application/json
(LineResponse (object or null))

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

(SimSwapResponse (object or null))

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

(VoIPDetectionResponse (object or null))

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

countryCode
string

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

traceId
string

The identifier for a trace.

number
string

Requested MSISDN in E.164 format.

400

Bad Request

401

Invalid Authorization

402

Account Locked

403

API disabled

404

Not Found

429

Too Many Requests

500

Internal Error

post/v1/lookups
Request samples
application/json
{
  • "number": "+1235559988",
  • "features": [
    • "LineType",
    • "SimSwap"
    ]
}
Response samples
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": {
      }
    },
  • "countryCode": "string",
  • "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  • "number": 12312312312
}