DOCSEARCHbyAlgolia
Submit Docs

Ideal Postcodes Documentation

website·Indexed 34 days ago

https://docs.ideal-postcodes.co.uk

Documentation for adding address search and validation to products. Includes guides for the Address Finder JavaScript package, the idpc command line interface (CLI) for managing API keys and validating emails or phone numbers, and details on the Standard Address object for UK and International addresses.

Tokens
198.5K
Snippets
621
Records
1.2K
Agent score
63%

What's inside Ideal Postcodes

  1. Overview of the Swisstopo Swiss Address File

    The Swisstopo dataset provides address information for Switzerland and Liechtenstein. Data is aggregated from three upstream Swisstopo products: the building address directory (gebaeudeadressverzeichnis), the street directory (strassenverzeichnis), and the official directory of towns and cities (amtovz). For multilingual records, the dataset provides one address per street name, with the language field identifying the specific language of the street name.

  2. Overview of the IE Address (ECAD) dataset

    The Eircode Address Database (ECAD) contains every ECAF postal address element along with GeoDirectory identifiers, building and organisation attributes, administrative area references, and An Post sorting information. English and Irish language versions of addresses are indexed separately and identified by the language field. Note that unavailable elements are returned as empty strings, never null.

  3. Overview of UK Address API capabilities

    The UK API provides endpoints specifically tailored for UK and Republic of Ireland address data. It supports two primary workflows: retrieving all registered addresses for a specific postcode (Postcode Lookup) and converting free-form, single-line address strings into structured, validated records (Address Cleansing).

  4. Overview of Ideal Postcodes for Dynamics 365 Business Central

    The Ideal Postcodes extension for Microsoft Dynamics 365 Business Central enables UK postcode lookup on any card page containing an Address FastTab. It provides accurate UK address data from national databases, ensures correct address formatting across standard fields, and improves data quality and entry speed.

  5. Overview of Ideal Postcodes Address Finder

    Address Finder is a JavaScript package that adds address validation and autocomplete suggestions to web forms. It provides rapid address entry (sub-100ms response), fuzzy search to handle spelling mistakes, support for word abbreviations (e.g., 'rd' for Road), and transposed letter handling. It is WCAG 2.1 AA compliant, supporting screen readers and keyboard operation. Key capabilities include geospatial filtering (bounding boxes), biasing suggestions via IP or geospatial points, and filtering by locality, country, or postcode areas.

  6. Overview of the BEV Austrian Address File

    The BEV Austrian Address File contains records from the Adressregister, Austria's official address register. Each record represents a single building at an address. The data structure joins an address (adrcd) to its building (subcd, objektnummer), municipality, locality, street, and census district. Field names generally follow the original German source. House numbers are decomposed into up to four parts (hausnrzahl1-hausnrzahl4) and also provided as pre-combined strings. Values from list columns (such as kgnr and objfunktkennziffer) are returned as comma-separated strings.

  7. Overview of Ideal Postcodes REST API

    Ideal Postcodes provides a REST service over HTTPS that returns data in JSON format. All requests must be authenticated using an API key.

  8. Overview of Sublicensing Keys

    Sublicensing Keys allow platform vendors to license multiple organizations or individuals (Licensees) under a single account. All usage is managed, controlled, and billed to the primary account holder. This is specifically designed for vendors providing services to multiple clients who each have their own users.

  9. Overview of Kartverket (Matrikkelen) address data

    Address records from Matrikkelen are provided by Kartverket (the Norwegian Mapping Authority) and cover Norway (NOR) and Svalbard and Jan Mayen (SJM). Data is aggregated from cadastre address, apartment level, and road address files. Because records originate from different files, the available fields vary; any field not present in the source data is returned as an empty string ("").

  10. Overview of Address Cleanse for Microsoft Excel

    The Address Cleanse add-in allows users to validate and enrich addresses directly within an Excel workbook using the Cleanse API. It writes 31 columns of structured data (including status, formatted address, confidence, geocodes, UPRN/UDPRN, and country) as plain static values to the right of the input. Because results are static values, workbooks can be shared and viewed by others without requiring the add-in or an API key. It is compatible with Excel for the Web, Excel for Windows (Microsoft 365), and Excel for Mac (Microsoft 365).

  11. Overview of Ideal Postcodes Browser Extensions

    Ideal Postcodes provides browser extensions for Chrome and Firefox that inject UK address search and validation into web-based applications. Key features include address autocompletion on the first address line of forms and the ability to retrieve a list of all addresses for a specific postcode by entering the exact postcode in the first address field. While the extension is free to install, a valid API Key is required for functionality.

  12. Overview of Ideal Postcodes Developer Solutions

    Ideal Postcodes provides a suite of tools for address search and validation. Their offerings include:

    • Address Finder: Real-time autocomplete suggestions ranked by relevance for HTML forms via a lightweight JS library.
    • Postcode Lookup: Instant retrieval of all UK addresses for a given postcode using Royal Mail data.
    • Place Search: Global search for geographical names and places worldwide.
    • Address Cleanse: Tools to standardize and complete address inputs.
    • Email Validation: Real-time email verification and bounce risk scoring.
    • Phone Validation: International phone number verification and network information.