Skip to content
HALOWERK

Mobility, Warnings and Local Data

subdivision register country code consistency

Region validation checks whether an independently supplied country code agrees with a subdivision and returns its registry type. Use it when an agent needs address field consistency.

POST https://ort.halowerk.com/v1/subdivision-register-country-code-consistency

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
countrystringYes
codestringYes
Show full input schema
{
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "maxLength": 6,
      "minLength": 1
    },
    "code": {
      "type": "string",
      "maxLength": 20,
      "minLength": 1
    }
  },
  "required": [
    "country",
    "code"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "country": "FRA",
  "code": "FR-75C"
}

Result & documentation

Show published result schema
{
  "type": "object",
  "required": [
    "measured_at",
    "source",
    "data",
    "limitations"
  ],
  "properties": {
    "measured_at": {
      "type": "string"
    },
    "source": {
      "type": "object",
      "required": [
        "reference",
        "retrieved_at"
      ],
      "properties": {
        "reference": {
          "type": "string"
        },
        "retrieved_at": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "matches": {
          "type": "boolean"
        },
        "actual_country": {
          "type": "string"
        },
        "region_type": {
          "type": "string"
        }
      },
      "required": [
        "matches",
        "actual_country",
        "region_type"
      ]
    },
    "limitations": {
      "type": "string"
    }
  }
}

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-20 UTC.

More endpoints in this hub

All endpoints in this hub โ†’