Overview
The home location API allows you to determine the Mobile Network Code (MNC) and Mobile Country Code of the supplied phone number. It returns the phone number's home network and country.
Common use cases of this API is to determine the best route for SMS message delivery or finding out which country a phone number belongs to in order apply local billing on the mobile wallet.
FEATURED BUNDLE
Mobile Carrier DataFEATURES
Determine Home Country
View the Home Network
Enables Billing Routing
Specifications
Available
endpoints
200OK
statusCode string
HTTP error code extension
statusMessage string
Message.
phoneNumber string
phoneNumber provided in the input
data
country string
Country of origin of the phoneNumber provided.
mobileNetwork string
Mobile Network Operator of the phoneNumber provided.
subscriberIsActive string
TRUE,FALSE,NONE
simIsPorted string
TRUE,FALSE,NONE
roamingIsEnabled string
TRUE,FALSE,NONE
transactionId string
transaction ID for tracing.
{
"statusCode": "string",
"statusMessage": "string",
"phoneNumber": "string",
"data": {
"country": "string",
"mobileNetwork": "string",
"subscriberIsActive": "string",
"simIsPorted": "string",
"roamingIsEnabled": "string"
},
"transactionId": "string"
}400Bad Request
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}401Unauthorized
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}403Forbidden
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}404Not Found
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}405Method Not Allowed
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}406Not Acceptable
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}500Internal Server Error
statusCode integer
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
SupportMessage string
Support Message
{
"statusCode": 1,
"statusMessage": "string",
"SupportMessage": "string"
}