Download OpenAPI specification:Download

NumberLookupV2

Performs a number lookup.

SecurityBasic or OAuth2
Request
path Parameters
projectId
required
string
Request Body schema: application/json
number
required
string non-empty

MSISDN in E.164 format to query.

features
Array 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).

object or null

Required when RND feature is requested.

Responses
200

Successful response

Response Schema: application/json
object or null

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

object or null

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

object or null

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

object or null

An object containing information whether number is disconnected.

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/v2/projects/{projectId}/lookups
Request samples
application/json
{
  • "number": "+12312312312"
}
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": {
      }
    },
  • "rnd": {
    • "disconnected": true,
    • "error": {
      }
    },
  • "countryCode": "string",
  • "traceId": "84c1fd4063c38d9f3900d06e56542d48",
  • "number": "+12312312312"
}