Validate MSISDN

Validates a phone number (MSISDN) and returns information about its country, operator, validity, and normalized format.

Authentication

Required

Request Header

Header	Type	Required	Description
`x-merchant-ref`	String	Yes	Your unique merchant reference.

Request

POST /api/v1/...

Request Body

{
  "msisdn": "2348126329414"
}

Response

Success Response

{
  "status": "success",
  "message": "Fetched",
  "data": {
    "data": {
      "country": {
        "alt": [
          "NG"
        ],
        "id": "NG"
      },
      "isFormallyValid": true,
      "isValid": true,
      "normalized": "2348126329414",
      "operator": {
        "alt": [
          1,
          18,
          19,
          20,
          2662
        ],
        "confidence": 0,
        "id": "20"
      },
      "original": "2348126329414"
    }
  }
}

Response Fields

Field	Type	Description
`status`	String	Indicates whether the request was successful.
`message`	String	Description of the response.
`country.id`	String	ISO country code identified from the MSISDN.
`country.alt`	Array	Alternative country identifiers associated with the number.
`isFormallyValid`	Boolean	Indicates whether the MSISDN conforms to the expected phone number format.
`isValid`	Boolean	Indicates whether the MSISDN is considered valid.
`normalized`	String	The MSISDN converted to its normalized international format.
`original`	String	The original MSISDN submitted for validation.
`operator.id`	String	Identifier of the detected mobile network operator.
`operator.alt`	Array	Alternative operator identifiers associated with the detected operator.
`operator.confidence`	Number	Confidence level of the detected operator.

Example

For the MSISDN 2348126329414:

Country: Nigeria (NG)
Formally valid: true
Valid: true
Normalized MSISDN: 2348126329414
Operator ID: 20

Updated 27 days ago

Did this page help you?