Developer Docs

Table of contents

Get Number Verifier status

The method allows you to get information about the Number Verifier request by the record ID (passed when creating a Number Verifier request) or an external request ID.

To get Number Verifier status, make a request to this URL:

GET https://api.bsg.world/rest/hlr/{id}

Request parameters:

ParameterRequiredTypeDescription 
idYesintegerA unique random identifier that is generated by the BSG platform. The record ID is passed in the /hlr/create method

or use alternative request:

To get Number Verifier status, make a request to this URL:

GET https://api.bsg.world/rest/hlr/{reference}

Request parameters:

ParameterRequiredTypeDescription 
referenceYesintegerExternal Number Verifier request ID. String up to 32 characters containing /a-zA-Z0-9/

Response parameters:

ParameterTypeDescription 
id integerInternal Number Verifier request ID.
country_namestringCountry name.
brandstringOperator (e.g. “Vodafone”).
brand_namestringOperator name (e.g. “PrJSC VF Ukraine”).
referencestringExternal Number Verifier request ID.
msisdnstringPhone number for which the Number Verifier request is performed.
networkstringMCC and MNC numbers (for absent and active statuses).
statusstringRequest status. Possible values: sent, absent, active, unknown, failed.
detailsstringNumber Verifier request details (full information is available when the status is active).
imsistringInternational Mobile Subscriber Identifier (Individual Subscriber Number) associated with each GSM, UMTS or CDMA mobile communication user.
portedbooleanIndicator whether the phone is ported or not (1 – ported, 0 – not).
roamingbooleanIndicator whether the phone is roaming or not. (1 – roaming, 0 – not).
createdDatetimestringDate when the Number Verifier request was created. Display format – Y-m-d H:i:s
statusDatetimestringDate and time when the Number verification status was received. (1 – roaming, 0 – not).
currencystringThe currency of the account, in which the Number Verifier request cost is specified.

Response sample

If request is successful, you will receive a response:

{
"id":"34298934543",
"country_name": "Ukraine",
"brand": "string",
"brand_name": "string",
"reference":"1234567",
"msisdn": "380932990000",
"network":"unknown",
"status":"unknown",
"details": {
"imsi": "string",
"ported": 0,
"roaming": 0
},
"createdDatetime":"2015-08-04T06:50:19+00:00",
"statusDatetime":"2015-08-04T06:50:19+00:00"
}

We use cookies (and other similar technologies) to collect data to improve your experience on our site. By using our website, you’re agreeing to the collection of data as described in our Website Data Collection Policy.