Kaleyra Cloud API Documentation

GET API Lookup

Kaleyra Cloud offers a simple API that will validate national and international phone numbers for you and perform a lookup of the details of the phone number.
Lookup is processed at real-time and the response returned provides comprehensive information like carrier, geographical location and line type data, number porting, roaming carriers and so on.

1. Sign up for free

Before you get started, sign up in Kaleyra Cloud for free and create an API key.

2. Get API Lookup

Use the following command:

curl -X GET "https://api.kaleyra.io/v1/<SID>/lookup/<PHONE_NUMBER>" \
     -H 'Content-Type: <CONTENT_TYPE>'\
     -H 'api-key: <API_KEY>'

Replace placeholders above with relevant values as described in the table below:

Replace

With

Examples

Mandatory?

Account SID (Security Identifier). Generated by Kaleyra Cloud while creating an API key.

HXXXXXXX071US

True

<PHONE_NUMBER>

The phone number you want to query. Multiple phone numbers must be separated with a comma.
Note: Ensure that the country code is prefixed to the number. (E164 format).

True

CONTENT_TYPE

Indicates the format of the content the API will be processing.

application/json

True

<API_KEY>

Your API Key generated by Kaleyra Cloud.
Example: Ac4XXXXX21f

Ac4XXXXX21f

True

3. View Response

As part of the response, this API returns information about the number queried. Details returned show information about the phone number's country, country code, the mobile country code (MCC) details and operator information. For each phone number queried, the API returns a Lookup ID. You can also query details about the phone number with just the Lookup ID using the GET Lookup Details by Lookup ID

{
    "code": "LKP200",
    "message": "Request processed successfully",
    "price": 0.80000000000000004,
    "id": "2019-09-30messagesfXXXdXaXXbdXXXXaXcXaaXXfXfeeXXbX",
    "total_processed_count": 4,
    "data": [
        {
            "lookup_id": "2019-09-30messagesfXXXdXaXXbdXXXXaXcXaaXXfXfeeXXbX:1",
            "mobile_number": "9190XXXXXX",
            "country": "IN",
            "country_code": 91,
            "current_mcc": "404",
            "current_mnc": "70",
            "current_operator": "",
            "original_mcc": "",
            "original_mnc": "",
            "original_operator": "Airtel // Rajasthan",
            "roaming_mcc": "",
            "roaming_mnc": "",
            "roaming_opearator": "",
            "is_ported": 0
        },
        {
            "lookup_id": "2019-09-30messagesfXXXdXaXXbdXXXXaXcXaaXXfXfeeXXbX:2",
            "mobile_number": "9190XXXXXX",
            "country": "IN",
            "country_code": 91,
            "current_mcc": "404",
            "current_mnc": "40",
            "current_operator": "Airtel // Chennai",
            "original_mcc": "",
            "original_mnc": "",
            "original_operator": "Airtel // Chennai",
            "roaming_mcc": "404",
            "roaming_mnc": "40",
            "roaming_opearator": "Airtel // Chennai",
            "is_ported": 0
        }
    ],
    "invalid_count": 0,
    "duplicate_count": 1
}

📘

Note:

In case of an error, ensure that the parameter values are correct in the above code. Refer to the Understand Error Codes page for detailed information.

Updated 8 days ago


GET API Lookup


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.