Telecom/API v2

Look up a phone prefix

GET/api/v2/telecom/phone-numbers/lookup

Good to know. Offline format validation and Google prefixes. No subscriber identity, active-line check, current carrier or physical location.

Read the response

data: The requested results, as an object or an array.

meta: Dataset sources, license and dates. null means unknown or unavailable.

API v2 is the canonical path. Older /api/v1 paths remain compatibility aliases for the currently published behavior, including pagination; no removal date is scheduled.

Response fields 26

[] means each item in a list. null means unknown or unavailable, never zero. The guide language does not translate source values.

dataobject

Requested result: a single object or a list.

data.is_possibleboolean

Length fits the numbering plan; does not prove the number exists.

data.is_valid_formatboolean

Format matches the parser metadata; does not prove assignment or reachability.

data.is_allocated_rangenull

Unknown here: the prefix dataset is not an official allocation registry.

Accepted values: null

data.has_known_prefixboolean

A prefix matches the dataset, independently of number validity.

data.e164string | null

Normalized international number with +212, Morocco’s country calling code.

data.national_numberstring | null

Number in Moroccan national format, including its leading zero.

data.number_typestring | null

Parser-recognized type, such as mobile or fixed line.

data.reasonstring | null

Code explaining why a number was rejected; null when there is no rejection reason.

data.matched_prefixstring | null

Most specific prefix matched for this number.

data.original_operatorobject | null

Operator associated with the prefix in the source; may differ from the current operator.

data.original_operator.codestring

Operator identifier inside an operator object; national prefix inside a phone area.

data.original_operator.namestring

Resource name, grouped by language where applicable.

data.current_operatornull

Unknown: number portability allows changing operator without changing number.

Accepted values: null

data.geographic_areaobject | null

Area associated with the prefix, not the caller’s actual location.

data.geographic_area.codestring

Operator identifier inside an operator object; national prefix inside a phone area.

data.geographic_area.international_prefixstring

International form of the prefix, with +212 replacing the leading zero.

data.geographic_area.descriptionobject

Prefix description in the available languages.

data.geographic_area.description.arnull

Arabic value; null when no translation is provided.

Accepted values: null

data.geographic_area.description.frstring

French value; null when no translation is provided.

data.geographic_area.description.enstring

English value; null when no translation is provided.

data.geographic_area.areasobject

Areas served according to the source, grouped by language; not precise administrative boundaries.

data.geographic_area.areas.arnull

Arabic value; null when no translation is provided.

Accepted values: null

data.geographic_area.areas.frstring[]

French value; null when no translation is provided.

data.geographic_area.areas.enstring[]

English value; null when no translation is provided.

data.geographic_area.hcp_codenull

null: no verified HCP administrative mapping is provided for these phone areas.

Accepted values: null

Data structure

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "is_possible",
        "is_valid_format",
        "is_allocated_range",
        "has_known_prefix",
        "e164",
        "national_number",
        "number_type",
        "reason",
        "matched_prefix",
        "original_operator",
        "current_operator",
        "geographic_area"
      ],
      "properties": {
        "is_possible": {
          "type": "boolean",
          "description": "Length compatibility with the numbering plan."
        },
        "is_valid_format": {
          "type": "boolean",
          "description": "Validity against the pinned parser metadata; does not prove line assignment or reachability."
        },
        "is_allocated_range": {
          "type": "string",
          "description": "Unknown: the prefix mapping dataset is not an official allocation registry.",
          "nullable": true,
          "enum": [
            null
          ]
        },
        "has_known_prefix": {
          "type": "boolean",
          "description": "A prefix mapping exists, independently of format validity."
        },
        "e164": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "national_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "number_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "reason": {
          "anyOf": [
            {
              "enum": [
                "INVALID_CHARACTERS",
                "INVALID_LENGTH",
                "NOT_MOROCCAN",
                "INVALID_NUMBER_PATTERN"
              ]
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "matched_prefix": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "original_operator": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "code",
                "name"
              ],
              "properties": {
                "code": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              }
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "current_operator": {
          "type": "string",
          "description": "Cannot be inferred from a prefix after number portability.",
          "nullable": true,
          "enum": [
            null
          ]
        },
        "geographic_area": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "code",
                "international_prefix",
                "description",
                "areas",
                "hcp_code"
              ],
              "properties": {
                "code": {
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 6,
                  "pattern": "^0[5-8][0-9]{0,4}$"
                },
                "international_prefix": {
                  "type": "string"
                },
                "description": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "ar",
                    "fr",
                    "en"
                  ],
                  "properties": {
                    "ar": {
                      "type": "string",
                      "nullable": true,
                      "enum": [
                        null
                      ]
                    },
                    "fr": {
                      "type": "string"
                    },
                    "en": {
                      "type": "string"
                    }
                  }
                },
                "areas": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "ar",
                    "fr",
                    "en"
                  ],
                  "properties": {
                    "ar": {
                      "type": "string",
                      "nullable": true,
                      "enum": [
                        null
                      ]
                    },
                    "fr": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "en": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                },
                "hcp_code": {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              }
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "phone-numbers"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "Apache-2.0"
          ]
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "transformation_version": {
          "type": "string"
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "Apache-2.0"
                ]
              },
              "source_updated_at": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Sources and pagination 13

metaobject

Result context: sources, dates, license and pagination where applicable.

meta.datasetstring

Name of the dataset for this result or source.

Accepted values: "phone-numbers"

meta.totalinteger

Number of matching records before pagination; not the size of this page.

meta.licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "Apache-2.0"

meta.retrieved_atstring

Date the project retrieved the source file; not the observation date.

meta.transformation_versionstring

Version of the dataset conversion rules; separate from the API version.

meta.sourcesobject[]

Sources used for this result, with their publishers and licenses.

meta.sources[].datasetstring

Name of the dataset for this result or source.

meta.sources[].producerstring

Organization publishing the original data.

meta.sources[].source_urlstring

Source publication or dataset landing page.

meta.sources[].resource_urlstring

Link to the actual file or resource used.

meta.sources[].licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "Apache-2.0"

meta.sources[].source_updated_atstring | null

Last update reported by the source; not the retrieval date.

Errors

400: Invalid or missing parameter.

Errors return error.code, error.message and error.request_id.

errorobject: Details of a failed request; replaces data and meta.
error.codestring: Stable error code, such as RESOURCE_NOT_FOUND; use it in application logic.
error.messagestring: Human-readable error explanation; use code for application logic.
error.request_idstring: Identifier for this request, useful when reporting a problem.

Look up a phone prefix

Parameters

Your request