{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-developer-resources/ingrid-api/guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"United Kingdom (GB)","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"united-kingdom-gb","__idx":0},"children":["United Kingdom (GB)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["UK addresses use an alphanumeric postal code with a significant space, place the"," ","house number before the street name, and often include building names. The"," ","hierarchical address system makes ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developer-resources/ingrid-api/guides/address-autocomplete"},"children":["autocomplete"]}," ","particularly valuable — a single street can contain dozens of individual"," ","premises."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":1},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"countryCode\": \"GB\",\n  \"postalCode\": \"SW1A 2AA\",\n  \"addressLines\": [\"10 Downing Street\"],\n  \"locality\": \"London\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"field-requirements","__idx":2},"children":["Field requirements"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"GB\""]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alphanumeric with space"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addressLines"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes (for shipment)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Index 0: number and street name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locality"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes (for shipment)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Post town"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["administrativeArea"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["County — not required for delivery"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subLocality"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["London district or neighborhood, e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Westminster\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"postal-code","__idx":3},"children":["Postal code"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Format:"]}," Alphanumeric, with a space separating the outward and inward parts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pattern:"]}," Various formats (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["A9 9AA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["A99 9AA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["A9A 9AA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AA9 9AA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AA99 9AA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AA9A 9AA"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"SW1A 2AA\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"EC2R 8AH\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"M1 1AE\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sanitization:"]}," The API preserves spaces. Letters are uppercased."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The space in UK postal codes is significant. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"SW1A 2AA\""]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"SW1A2AA\""]}," may"," ","be handled differently by carriers. Always include the space."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"address-lines","__idx":4},"children":["Address lines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The house number comes ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["before"]}," the street name. Building names, when present,"," ","go on a preceding line."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"addressLines value"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addressLines"]}," value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"10 Downing Street\"]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["With building name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"Buckingham Palace\", \"The Mall\"]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["With flat number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"Flat 3\", \"10 Buckingham Street\"]"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Building names are common in the UK and may replace a house number entirely"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developer-resources/ingrid-api/guides/address-autocomplete"},"children":["autocomplete endpoint"]}," returns building names"," ","in the correct position"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"locality","__idx":5},"children":["Locality"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locality"]}," field is the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["post town"]},", which may differ from the colloquial"," ","city name."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"London\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Manchester\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Edinburgh\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For London addresses, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subLocality"]}," can capture the specific district"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"autocomplete-considerations","__idx":6},"children":["Autocomplete considerations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["UK addresses benefit significantly from autocomplete due to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Multi-premise buildings:"]}," A single building may contain many flats, each"," ","a separate address. The expand/resolve pattern handles this naturally."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Building names:"]}," Many UK addresses use building names instead of or in"," ","addition to house numbers, making free-text entry error-prone."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PAF data:"]}," The UK has a comprehensive Postcode Address File. The"," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developer-resources/ingrid-api/guides/address-autocomplete"},"children":["autocomplete endpoint"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["focus=postalCode"]}," ","enables postcode-first lookups common in UK checkouts."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-mistakes","__idx":7},"children":["Common mistakes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Mistake"},"children":["Mistake"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Problem"},"children":["Problem"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fix"},"children":["Fix"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"postalCode\": \"sw1a 2aa\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lowercase postal code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accepted — the API uppercases automatically"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"postalCode\": \"SW1A2AA\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing space"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include the space: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"SW1A 2AA\""]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"addressLines\": [\"Downing Street 10\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Street before number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UK uses number-first: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"10 Downing Street\"]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing building name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Building-only addresses fail delivery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use autocomplete to capture building names"]}]}]}]}]}]},"headings":[{"value":"United Kingdom (GB)","id":"united-kingdom-gb","depth":1},{"value":"Example","id":"example","depth":2},{"value":"Field requirements","id":"field-requirements","depth":2},{"value":"Postal code","id":"postal-code","depth":2},{"value":"Address lines","id":"address-lines","depth":2},{"value":"Locality","id":"locality","depth":2},{"value":"Autocomplete considerations","id":"autocomplete-considerations","depth":2},{"value":"Common mistakes","id":"common-mistakes","depth":2}],"frontmatter":{"title":"United Kingdom (GB)","description":"Address requirements, postal code format, and field rules for the United Kingdom","seo":{"title":"United Kingdom (GB)"}},"lastModified":"2026-02-24T19:14:57.409Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-resources/ingrid-api/guides/country-reference/united-kingdom","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}