API HLR Lookup

With the CaptainVerify API, you can integrate the HLR lookup verification in your own applications. We advise to use the API "a posteriori" because a verification can be more or less long (1 minutes). You can also take a look at HLR documentation.

API key

An account is necessary to generate the key for the API, this is what will give you access to the service.

The request

To make a request to the API, simply call the GET protocol to this URL:

https://api.captainverify.com/verify?phone={PHONE_NUMBER}&apikey=XXXXXXXXXXXXXXXXXXXX

Replace {PHONE_NUMBER} with the mobile number to check (international format : +447...)

API limits

The API is limited to a maximum of 2 simultaneous connections and 50 checks per minute. When you integrate the API, make sure your application does not exceed this limit.

The answer

A JSON table will be returned with these variables:

Variables Possible value

status

true, false.
The status of the request.

credits

89
Credits available to your account.

message

default : null
When the status is false, an error message will be sent.

requested_number

447000000000
The mobile number to question.

formatted_number

+447000000000
International mobile format number.

network

T-MOBILE UK
Network name.

original_network

3
The original name of the network.

roaming

true, false
The current itinerant state.

ported

true, false
If the user has changed operator with the same number.

country

UNITED KINGDOM
The full name of the country for the requested number.

country_prefix

44
The digital prefix of the country of the number.

details

DELIVERED_TO_HANDSET, UNDELIVERABLE_NOT_DELIVERED
DELIVERED_TO_HANDSET : HLR verification has been processed (assigned number).
UNDELIVERABLE_NOT_DELIVERED: HLR verification has not been to the end (number not attributed).

result

The status of the number: Valid, Invalid, Unknow
If all your credits have been exhausted, the unknown status will always be returned, so as not to block your application.

To find out the validity of a mobile number in real time.
Register now!