api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "country": {
          "description": "Region as an ISO 3166-1 alpha-2 code — never a numeric calling code. It is null even on a VALID number from an ITU non-geographic range (+800 UIFN, +870 Inmarsat, +882 and +883 international networks, +979 premium), which belongs to no country: read 'country_code' for the dialing code there, and expect null when mapping this field onto an ISO table.",
          "type": [
            "string",
            "null"
          ]
        },
        "country_code": {
          "description": "E.164 country calling code as an integer (33 for France, 800 for UIFN…), set on every valid number — including those whose 'country' is null (non-geographic ranges).",
          "type": [
            "integer",
            "null"
          ]
        },
        "e164": {
          "type": [
            "string",
            "null"
          ]
        },
        "extension": {
          "description": "Extension (phone extension / poste) parsed from the input, null when the number carries none. It is never folded into 'e164': E.164 does not carry extensions and no ';ext=' form is invented — store 'extension' alongside 'e164' to keep it. 'national_format' shows it in the local reading form.",
          "type": [
            "string",
            "null"
          ]
        },
        "input": {
          "type": "string"
        },
        "issue": {
          "type": [
            "string",
            "null"
          ]
        },
        "national_format": {
          "type": [
            "string",
            "null"
          ]
        },
        "number_type": {
          "type": [
            "string",
            "null"
          ]
        },
        "valid": {
          "description": "Structural verdict. false is a SUCCESSFUL answer (HTTP 200), never an error: the number was read and rejected. On a false verdict every derived field ('e164', 'country', 'country_code', 'national_format', 'extension', 'number_type') is null and 'issue' carries a stable diagnostic code: BAD_FORMAT, TOO_SHORT, TOO_LONG, NOT_A_NUMBER, UNKNOWN_REGION or INVALID_FOR_REGION. 'issue' is null when 'valid' is true.",
          "type": "boolean"
        }
      },
      "required": [
        "country",
        "country_code",
        "e164",
        "extension",
        "input",
        "national_format",
        "number_type",
        "valid"
      ],
      "type": "object"
    },
    "provenance": {
      "properties": {
        "fetched_at": {
          "type": "string"
        },
        "freshness": {
          "properties": {
            "as_of": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            }
          },
          "required": [
            "as_of",
            "kind"
          ],
          "type": "object"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "fetched_at",
        "freshness",
        "source"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "provenance"
  ],
  "type": "object"
}