Overview
This API provides comprehensive information about the phone number.
In addition to determining the country of origin of the phone number provided, you can also retrieve the mobile network operator, check if the phone number is active on the network, and in countries with mobile number portability, you can use this API to determine of the number has been ported from another network. It also allows to know if roaming is enabled on the number, get the last date a SIM swap was performed and determine if call divert has been activated.
FEATURED BUNDLE
Mobile Carrier InformationFEATURES
Get detailed phone number information
View roaming status
Check SIM Swap Date
Know if number is active
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
callDivertIsEnabled string
TRUE,FALSE,NONE
lastSimSwapDate string
The date when the last sim swap performed on the SIM of the phoneNumber provided represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format. If the date cannot be determined, the value will be an empty string
transactionId string
transaction ID for tracing.
{
"statusCode": "string",
"statusMessage": "string",
"phoneNumber": "string",
"data": {
"country": "string",
"mobileNetwork": "string",
"subscriberIsActive": "string",
"simIsPorted": "string",
"roamingIsEnabled": "string",
"callDivertIsEnabled": "string",
"lastSimSwapDate": "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"
}