Resolve address cascade steps for a number order

Addresses for ordering a number from a region outside the listing. This walks the carrier's cascading directory: send psc and get municipalities, add obec and get districts, cobce returns streets, and ulice returns building numbers. Once cp is picked, a readable address arrives in the recap field. Don't invent codes - only the ones returned here are valid. A faster path that skips the cascade is query, see the callout below.

get/v1/numbers/address-options

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/numbers/address-options
  • Auth: HTTP bearer

Query parameters

querystring

Free-text address (e.g. "Nadrazni 100, 702 00 Ostrava") to resolve automatically. Cannot be combined with psc/obec/cobce/ulice/cp.

pscstring

Premises postal code, five digits (e.g. 70200).

obecstring

Municipality code from the previous cascade step.

cobcestring

Municipality part code from the previous cascade step.

ulicestring

Street code from the previous cascade step, when the municipality part has streets.

cpstring

House number code from the previous cascade step.

Response

Address cascade options

recapstring nullable required
ambiguousLevel'obec' | 'cobce' | 'ulice' | 'cp'
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.