Nexmo's Number Insight API provides details about the validity, reachability and roaming status of a phone number, as well as giving you details on how to format the number properly in your application. There are three levels of Number Insight API available: Basic, Standard and Advanced. The advanced API is available asynchronously as well as synchronously.
Download OpenAPI 3 Definitionconst Nexmo = require('nexmo')
const nexmo = new Nexmo({
apiKey: NEXMO_API_KEY,
apiSecret: NEXMO_API_SECRET
})
AuthMethod auth = new TokenAuthMethod(NEXMO_API_KEY, NEXMO_API_SECRET);
NexmoClient client = new NexmoClient(auth);
$basic = new \Nexmo\Client\Credentials\Basic(NEXMO_API_KEY, NEXMO_API_SECRET);
$client = new \Nexmo\Client($basic);
The Number Insight object contains information about the request and details of the phone number information has been requested about.
| Code | Text |
|---|---|
| 0 | Success - request accepted for delivery by Nexmo. |
| 1 | Busy - you have made more requests in the last second than are permitted by your Nexmo account. Please retry. |
| 3 | Invalid - your request is incomplete and missing some mandatory parameters. |
| 4 | Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled. |
| 5 | Internal Error - the format of the recipient address is not valid. |
| 9 | Partner quota exceeded - your Nexmo account does not have sufficient credit to process this request. |
| Code | Text |
|---|---|
| 19 | Facility Not Allowed - your request makes use of a facility that is not enabled on your account. |
| 43, 44, 45 | Live mobile lookup not returned. Not all return parameters are available. |
| 999 | Request unparseable. |
0, 1, 3, 4, 5, 9, 19, 43, 44, 45or999
The status description of your request.
The unique identifier for your request. This is a alphanumeric string up to 40 characters.
The number in your request in international format.
The number in your request in the format used by the country the number belongs to.
Two character country code for number. This is in ISO 3166-1 alpha-2
format.
Three character country code for number. This is in ISO 3166-1 alpha-3
format.
The full name of the country that number is registered in.
The numeric prefix for the country that number is registered in.
The amount in EUR charged to your account.
If there is an internal lookup error, the refund_price will reflect the lookup price. If cnam is requested for a non-US number the refund_price will reflect the cnam price. If both of these conditions occur, refund_price is the sum of the lookup price and cnam price.
Your account balance in EUR after this request. Not returned with Number Insight Advanced Async API.
The https://en.wikipedia.org/wiki/Mobile_country_code
for the carriernumber is associated with. Unreal numbers are marked asunknown and the request is rejected altogether if the number is impossible according to the E.164
guidelines.
The full name of the carrier that number is associated with.
The country that number is associated with. This is in ISO 3166-1 alpha-2 format.
The type of network that number is associated with.
mobile, landline, landline_premium, landline_tollfree, virtual, unknownorpager
The https://en.wikipedia.org/wiki/Mobile_country_code
for the carriernumber is associated with. Unreal numbers are marked asunknown and the request is rejected altogether if the number is impossible according to the E.164
guidelines.
The full name of the carrier that number is associated with.
The country that number is associated with. This is in ISO 3166-1 alpha-2 format.
The type of network that number is associated with.
mobile, landline, landline_premium, landline_tollfree, virtual, unknownorpager
If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.
unknown, ported, not_ported, assumed_not_portedorassumed_ported
Is number outside its home carrier network.
unknown, roamingornot_roaming
If number is roaming, this is the code
of the country number is roaming in.
If number is roaming, this is the id of the carrier network number is roaming in.
If number is roaming, this is the name of the carrier network number is roaming in.
The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
business, consumerorunknown
Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
None
Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
business, consumerorunknown
Shows if all information about a phone number has been returned. Possible values:
| Code | Text |
|---|---|
| 0 | Success |
| 1 | Partial success - some fields populated |
| 2 | Failed |
0, 1or2
Shows if all information about a phone number has been returned.
Does number exist. This is applicable to mobile numbers only.
unknown, validornot_valid
Can you call number now. This is applicable to mobile numbers only.
unknown, reachable, undeliverable, absent, bad_numberorblacklisted
The ip address you specified in the request.
The match status between ip and number parameters.
countryormismatch
The country that ip is allocated to.
The city that ip is allocated to.
Warning levels for ip
unknownorno_warning
The unique identifier for your request. This is a alphanumeric string up to 40 characters.
The number in your request in international format.
Two character country code for number. This is in ISO 3166-1 alpha-2
format.
Three character country code for number. This is in ISO 3166-1 alpha-3
format.
The full name of the country that number is registered in.
The numeric prefix for the country that number is registered in.
The number in your request in the format used by the country the number belongs to.
The status code
The status description of your request.
If there is an internal lookup error, the refund_price will reflect the lookup price. If cnam is requested for a non-US number the refund_price will reflect the cnam price. If both of these conditions occur, refund_price is the sum of the lookup price and cnam price.
Your account balance in EUR after this request. Not returned with Number Insight Advanced Async API.
The https://en.wikipedia.org/wiki/Mobile_country_code
for the carriernumber is associated with. Unreal numbers are marked asunknown and the request is rejected altogether if the number is impossible according to the E.164
guidelines.
The full name of the carrier that number is associated with.
The country that number is associated with. This is in ISO 3166-1 alpha-2 format.
The type of network that number is associated with.
mobile, landline, landline_premium, landline_tollfree, virtual, unknownorpager
The https://en.wikipedia.org/wiki/Mobile_country_code
for the carriernumber is associated with. Unreal numbers are marked asunknown and the request is rejected altogether if the number is impossible according to the E.164
guidelines.
The full name of the carrier that number is associated with.
The country that number is associated with. This is in ISO 3166-1 alpha-2 format.
The type of network that number is associated with.
mobile, landline, landline_premium, landline_tollfree, virtual, unknownorpager
None
None
Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
business, consumerorunknown
Shows if all information about a phone number has been returned. Possible values:
| Code | Text |
|---|---|
| 0 | Success |
| 1 | Partial success - some fields populated |
| 2 | Failed |
0, 1or2
Shows if all information about a phone number has been returned.
Can you call number now. This is applicable to mobile numbers only.
unknown, reachable, undeliverable, absent, bad_numberorblacklisted
Is number outside its home carrier network.
unknown, roamingornot_roaming
If number is roaming, this is the code
of the country number is roaming in.
If number is roaming, this is the id of the carrier network number is roaming in.
If number is roaming, this is the name of the carrier network number is roaming in.
The ip address you specified in the request.
The match status between ip and number parameters.
countryormismatch
The country that ip is allocated to.
The city that ip is allocated to.
Does number exist. This is applicable to mobile numbers only.
unknown, validornot_valid
Warning levels for ip
unknownorno_warning
{
"status": 0,
"status_message": "Success",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"international_format_number": "447700900000",
"national_format_number": "07700 900000",
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44",
"request_price": "0.04000000",
"refund_price": "0.01500000",
"remaining_balance": "1.23456789",
"current_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"original_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"ported": "not_ported",
"roaming": {
"status": "roaming",
"roaming_country_code": "US",
"roaming_network_code": 12345,
"roaming_network_name": "Acme Inc"
},
"caller_identity": {
"caller_type": "consumer",
"caller_name": "John Smith",
"first_name": "John",
"last_name": "Smith",
"subscription_type": "unknown"
},
"caller_name": "John Smith",
"last_name": "Smith",
"first_name": "John",
"caller_type": "consumer",
"lookup_outcome": "0",
"lookup_outcome_message": "Success",
"valid_number": "valid",
"reachable": "reachable",
"ip": {
"address": "123.0.0.255",
"ip_match_level": "country",
"ip_country": "GB",
"ip_city": "London"
},
"ip_warnings": "no_warning"
}<?xml version="1.0" encoding="UTF-8"?>
<lookup>
<request_id>aaaaaaaa-bbbb-cccc-dddd-0123456789ab</request_id>
<international_format_number>447700900000</international_format_number>
<local_number country_code="GB" country_code_iso3="GBR" country_name="United Kingdom" country_prefix="44">
07700 900000
</local_number>
<error code="0">Success</error>
<request_price>0.01500000</request_price>
<remaining_balance>1.23456789</remaining_balance>
<current_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</current_carrier>
<original_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</original_carrier>
<ported>not_ported</ported>
<cnam caller-type="consumer" caller-name="John Smith" first-name="John" last-name="Smith" subscription-type="unknown">
</cnam>
<caller_name>John Smith</caller_name>
<last_name>Smith</last_name>
<firs_name>John</firs_name>
<caller_type>consumer</caller_type>
<lookup_outcome code="0">Success</lookup_outcome>
<reachable>reachable</reachable>
<roaming status="roaming" roaming_country_code="US" roaming_network_code="12345" roaming_network_name="Acme Inc">
</roaming>
<ip address="123.0.0.255" ip_match_level="country" ip_country="GB" ip_city="London">
</ip>
<valid_number>valid</valid_number>
<ip_warnings>no_warning</ip_warnings>
</lookup>
https://api.nexmo.com/ni
/:level/:format
The level of request you wish to make.
basic, standardoradvanced
standard
The format of the response
jsonorxml
json
A single phone number that you need insight about in national or international format.
447700900000
If a number does not have a country code or is uncertain, set the two-character country code. This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US. If you set country and number is already in E.164 format, country must match the country code in number.
GB
Indicates if the name of the person who owns the phone number should be looked up and returned in the response. Set to true to receive phone number owner name in the response. This features is available for US numbers only and incurs an additional charge.
true
false
The IP address of the user. If supplied, we will compare this to the country the user's phone is located in and return an error if it does not match.
123.0.0.255
curl https://api.nexmo.com/ni/standard/json \
-d 'api_key=NEXMO_API_KEY' \
-d 'api_secret=NEXMO_API_SECRET' \
-d 'number=447700900000'
{
"status": 0,
"status_message": "Success",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"international_format_number": "447700900000",
"national_format_number": "07700 900000",
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44"
}{
"status": 0,
"status_message": "Success",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"international_format_number": "447700900000",
"national_format_number": "07700 900000",
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44",
"request_price": "0.04000000",
"refund_price": "0.01500000",
"remaining_balance": "1.23456789",
"current_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"original_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"ported": "not_ported",
"roaming": {
"status": "roaming",
"roaming_country_code": "US",
"roaming_network_code": 12345,
"roaming_network_name": "Acme Inc"
},
"caller_identity": {
"caller_type": "consumer",
"caller_name": "John Smith",
"first_name": "John",
"last_name": "Smith",
"subscription_type": "unknown"
},
"caller_name": "John Smith",
"last_name": "Smith",
"first_name": "John",
"caller_type": "consumer"
}{
"status": 0,
"status_message": "Success",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"international_format_number": "447700900000",
"national_format_number": "07700 900000",
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44",
"request_price": "0.04000000",
"refund_price": "0.01500000",
"remaining_balance": "1.23456789",
"current_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"original_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"ported": "not_ported",
"roaming": {
"status": "roaming",
"roaming_country_code": "US",
"roaming_network_code": 12345,
"roaming_network_name": "Acme Inc"
},
"caller_identity": {
"caller_type": "consumer",
"caller_name": "John Smith",
"first_name": "John",
"last_name": "Smith",
"subscription_type": "unknown"
},
"caller_name": "John Smith",
"last_name": "Smith",
"first_name": "John",
"caller_type": "consumer",
"lookup_outcome": "0",
"lookup_outcome_message": "Success",
"valid_number": "valid",
"reachable": "reachable",
"ip": {
"address": "123.0.0.255",
"ip_match_level": "country",
"ip_country": "GB",
"ip_city": "London"
},
"ip_warnings": "no_warning"
}<?xml version="1.0" encoding="UTF-8"?>
<format>
<request_id>aaaaaaaa-bbbb-cccc-dddd-0123456789ab</request_id>
<international_format_number>447700900000</international_format_number>
<local_number country_code="GB" country_code_iso3="GBR" country_name="United Kingdom" country_prefix="44">
07700 900000
</local_number>
<error code="0">Success</error>
</format>
<?xml version="1.0" encoding="UTF-8"?>
<lookup>
<request_id>aaaaaaaa-bbbb-cccc-dddd-0123456789ab</request_id>
<international_format_number>447700900000</international_format_number>
<local_number country_code="GB" country_code_iso3="GBR" country_name="United Kingdom" country_prefix="44">
07700 900000
</local_number>
<error code="0">Success</error>
<request_price>0.01500000</request_price>
<remaining_balance>1.23456789</remaining_balance>
<current_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</current_carrier>
<original_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</original_carrier>
<ported>not_ported</ported>
<roaming status="unknown">
</roaming>
<cnam caller-type="consumer" caller-name="John Smith" first-name="John" last-name="Smith" subscription-type="unknown">
</cnam>
<caller_name>John Smith</caller_name>
<last_name>Smith</last_name>
<firs_name>John</firs_name>
<caller_type>consumer</caller_type>
</lookup>
<?xml version="1.0" encoding="UTF-8"?>
<lookup>
<request_id>aaaaaaaa-bbbb-cccc-dddd-0123456789ab</request_id>
<international_format_number>447700900000</international_format_number>
<local_number country_code="GB" country_code_iso3="GBR" country_name="United Kingdom" country_prefix="44">
07700 900000
</local_number>
<error code="0">Success</error>
<request_price>0.01500000</request_price>
<remaining_balance>1.23456789</remaining_balance>
<current_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</current_carrier>
<original_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</original_carrier>
<ported>not_ported</ported>
<cnam caller-type="consumer" caller-name="John Smith" first-name="John" last-name="Smith" subscription-type="unknown">
</cnam>
<caller_name>John Smith</caller_name>
<last_name>Smith</last_name>
<firs_name>John</firs_name>
<caller_type>consumer</caller_type>
<lookup_outcome code="0">Success</lookup_outcome>
<reachable>reachable</reachable>
<roaming status="roaming" roaming_country_code="US" roaming_network_code="12345" roaming_network_name="Acme Inc">
</roaming>
<ip address="123.0.0.255" ip_match_level="country" ip_country="GB" ip_city="London">
</ip>
<valid_number>valid</valid_number>
<ip_warnings>no_warning</ip_warnings>
</lookup>
https://api.nexmo.com/ni
/advanced/async/:format
The format of the response
jsonorxml
json
The callback URL
https://example.com/callback
A single phone number that you need insight about in national or international format.
447700900000
If a number does not have a country code or is uncertain, set the two-character country code. This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US. If you set country and number is already in E.164 format, country must match the country code in number.
GB
Indicates if the name of the person who owns the phone number should be looked up and returned in the response. Set to true to receive phone number owner name in the response. This features is available for US numbers only and incurs an additional charge.
true
false
The IP address of the user. If supplied, we will compare this to the country the user's phone is located in and return an error if it does not match.
123.0.0.255
curl https://api.nexmo.com/ni/standard/async/json \
-d 'api_key=NEXMO_API_KEY' \
-d 'api_secret=NEXMO_API_SECRET' \
-d 'number=447700900000' \
-d 'callback=https://example.com/webhooks/event'
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"number": "447700900000",
"remaining_balance": "1.23456789",
"request_price": "0.01500000",
"status": 0
}<?xml version="1.0" encoding="UTF-8"?>
<lookup>
<requestId>aaaaaaaa-bbbb-cccc-dddd-0123456789ab</requestId>
<number>447700900000</number>
<remainingBalance>1.23456789</remainingBalance>
<requestPrice>0.01500000</requestPrice>
<status>0</status>
</lookup>
Contains the response to your
https://example.com
/webhooks/event
| Code | Text |
|---|---|
| 0 | Success - request accepted for delivery by Nexmo. |
| 1 | Busy - you have made more requests in the last second than are permitted by your Nexmo account. Please retry. |
| 3 | Invalid - your request is incomplete and missing some mandatory parameters. |
| 4 | Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled. |
| 5 | Internal Error - the format of the recipient address is not valid. |
| 9 | Partner quota exceeded - your Nexmo account does not have sufficient credit to process this request. |
| Code | Text |
|---|---|
| 19 | Facility Not Allowed - your request makes use of a facility that is not enabled on your account. |
| 43, 44, 45 | Live mobile lookup not returned. Not all return parameters are available. |
| 999 | Request unparseable. |
0, 1, 3, 4, 5, 9, 19, 43, 44, 45or999
0
The status description of your request.
Success
The unique identifier for your request. This is a alphanumeric string up to 40 characters.
aaaaaaaa-bbbb-cccc-dddd-0123456789ab
The number in your request in international format.
447700900000
The number in your request in the format used by the country the number belongs to.
07700 900000
Two character country code for number. This is in ISO 3166-1 alpha-2
format.
GB
Three character country code for number. This is in ISO 3166-1 alpha-3
format.
GBR
The full name of the country that number is registered in.
United Kingdom
The numeric prefix for the country that number is registered in.
44
The amount in EUR charged to your account.
0.04000000
If there is an internal lookup error, the refund_price will reflect the lookup price. If cnam is requested for a non-US number the refund_price will reflect the cnam price. If both of these conditions occur, refund_price is the sum of the lookup price and cnam price.
0.01500000
Your account balance in EUR after this request. Not returned with Number Insight Advanced Async API.
1.23456789
The https://en.wikipedia.org/wiki/Mobile_country_code
for the carriernumber is associated with. Unreal numbers are marked asunknown and the request is rejected altogether if the number is impossible according to the E.164
guidelines.
12345
The full name of the carrier that number is associated with.
Acme Inc
The country that number is associated with. This is in ISO 3166-1 alpha-2 format.
GB
The type of network that number is associated with.
mobile, landline, landline_premium, landline_tollfree, virtual, unknownorpager
mobile
The https://en.wikipedia.org/wiki/Mobile_country_code
for the carriernumber is associated with. Unreal numbers are marked asunknown and the request is rejected altogether if the number is impossible according to the E.164
guidelines.
12345
The full name of the carrier that number is associated with.
Acme Inc
The country that number is associated with. This is in ISO 3166-1 alpha-2 format.
GB
The type of network that number is associated with.
mobile, landline, landline_premium, landline_tollfree, virtual, unknownorpager
mobile
If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.
unknown, ported, not_ported, assumed_not_portedorassumed_ported
not_ported
Is number outside its home carrier network.
unknown, roamingornot_roaming
roaming
If number is roaming, this is the code
of the country number is roaming in.
US
If number is roaming, this is the id of the carrier network number is roaming in.
12345
If number is roaming, this is the name of the carrier network number is roaming in.
Acme Inc
The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
business, consumerorunknown
consumer
Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
John Smith
First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
John
Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
Smith
None
unknown
Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
John Smith
Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
Smith
First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request.
John
The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.
business, consumerorunknown
consumer
Shows if all information about a phone number has been returned. Possible values:
| Code | Text |
|---|---|
| 0 | Success |
| 1 | Partial success - some fields populated |
| 2 | Failed |
0, 1or2
0
Shows if all information about a phone number has been returned.
Success
Does number exist. This is applicable to mobile numbers only.
unknown, validornot_valid
valid
Can you call number now. This is applicable to mobile numbers only.
unknown, reachable, undeliverable, absent, bad_numberorblacklisted
reachable
The ip address you specified in the request.
123.0.0.255
The match status between ip and number parameters.
countryormismatch
country
The country that ip is allocated to.
GB
The city that ip is allocated to.
London
Warning levels for ip
unknownorno_warning
no_warning
{
"status": 0,
"status_message": "Success",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"international_format_number": "447700900000",
"national_format_number": "07700 900000",
"country_code": "GB",
"country_code_iso3": "GBR",
"country_name": "United Kingdom",
"country_prefix": "44",
"request_price": "0.04000000",
"refund_price": "0.01500000",
"remaining_balance": "1.23456789",
"current_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"original_carrier": {
"network_code": "12345",
"name": "Acme Inc",
"country": "GB",
"network_type": "mobile"
},
"ported": "not_ported",
"roaming": {
"status": "roaming",
"roaming_country_code": "US",
"roaming_network_code": 12345,
"roaming_network_name": "Acme Inc"
},
"caller_identity": {
"caller_type": "consumer",
"caller_name": "John Smith",
"first_name": "John",
"last_name": "Smith",
"subscription_type": "unknown"
},
"caller_name": "John Smith",
"last_name": "Smith",
"first_name": "John",
"caller_type": "consumer",
"lookup_outcome": "0",
"lookup_outcome_message": "Success",
"valid_number": "valid",
"reachable": "reachable",
"ip": {
"address": "123.0.0.255",
"ip_match_level": "country",
"ip_country": "GB",
"ip_city": "London"
},
"ip_warnings": "no_warning"
}<?xml version="1.0" encoding="UTF-8"?>
<lookup>
<request_id>aaaaaaaa-bbbb-cccc-dddd-0123456789ab</request_id>
<international_format_number>447700900000</international_format_number>
<local_number country_code="GB" country_code_iso3="GBR" country_name="United Kingdom" country_prefix="44">
07700 900000
</local_number>
<error code="0">Success</error>
<request_price>0.01500000</request_price>
<remaining_balance>1.23456789</remaining_balance>
<current_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</current_carrier>
<original_carrier network_code="12345" name="Acme Inc" country="GB" network_type="mobile">
</original_carrier>
<ported>not_ported</ported>
<cnam caller-type="consumer" caller-name="John Smith" first-name="John" last-name="Smith" subscription-type="unknown">
</cnam>
<caller_name>John Smith</caller_name>
<last_name>Smith</last_name>
<firs_name>John</firs_name>
<caller_type>consumer</caller_type>
<lookup_outcome code="0">Success</lookup_outcome>
<reachable>reachable</reachable>
<roaming status="roaming" roaming_country_code="US" roaming_network_code="12345" roaming_network_name="Acme Inc">
</roaming>
<ip address="123.0.0.255" ip_match_level="country" ip_country="GB" ip_city="London">
</ip>
<valid_number>valid</valid_number>
<ip_warnings>no_warning</ip_warnings>
</lookup>