1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[849],{6164(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"sdks":[{"type":"link","href":"/docs/sdks/","label":"SDKs","docId":"sdks/sdks","unlisted":false},{"type":"category","collapsed":false,"label":"TypeScript","items":[{"type":"link","href":"/docs/sdks/typescript/","label":"TypeScript SDK","docId":"sdks/typescript/index","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/setup","label":"Setup","docId":"sdks/typescript/setup","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/autocomplete","label":"Autocomplete","docId":"sdks/typescript/autocomplete","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/filter-and-bias","label":"Filter and Bias","docId":"sdks/typescript/filter-and-bias","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/address-ver
1ify","label":"Address Verification","docId":"sdks/typescript/address-verify","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/react","label":"React and Preact","docId":"sdks/typescript/react","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/errors","label":"Error Handling","docId":"sdks/typescript/errors","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/common","label":"Common","docId":"sdks/typescript/common","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/","label":"Endpoints","className":"sidebar-heading","docId":"sdks/typescript/endpoints/index","unlisted":false},{"type":"category","label":"Address Search","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/address-verify","label":"addressVerify","docId":"sdks/typescript/endpoints/address-verify","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/find-address","label":"findAddress","docId":"sdks/typescript/endpoints/find-address","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/retrieve-address","label":"retrieveAddress","docId":"sdks/typescript/endpoints/retrieve-address","unlisted":false}],"collapsible":true},{"type":"category","label":"Keys","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/key-availability","label":"keyAvailability","docId":"sdks/typescript/endpoints/key-availability","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/key-details","label":"keyDetails","docId":"sdks/typescript/endpoints/key-details","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/update-key-details","label":"updateKeyDetails","docId":"sdks/typescript/endpoints/update-key-details","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/key-usage","label":"keyUsage","docId":"sdks/typescript/endpoints/key-usage","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/key-logs","label":"keyLogs","docId":"sdks/typescript/endpoints/key-logs","unlisted":false}],"collapsible":true},{"type":"category","label":"Licensees","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/list-licensees","label":"listLicensees","docId":"sdks/typescript/endpoints/list-licensees","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/create-licensee","label":"createLicensee","docId":"sdks/typescript/endpoints/create-licensee","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/delete-licensee","label":"deleteLicensee","docId":"sdks/typescript/endpoints/delete-licensee","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/retrieve-licensee","label":"retrieveLicensee","docId":"sdks/typescript/endpoints/retrieve-licensee","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/update-licensee","label":"updateLicensee","docId":"sdks/typescript/endpoints/update-licensee","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/regenerate-licensee-key","label":"regenerateLicenseeKey","docId":"sdks/typescript/endpoints/regenerate-licensee-key","unlisted":false}],"collapsible":true},{"type":"category","label":"Configs","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/list-configs","label":"listConfigs","docId":"sdks/typescript/endpoints/list-configs","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/create-config","label":"createConfig","docId":"sdks/typescript/endpoints/create-config","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/delete-config","label":"deleteConfig","docId":"sdks/typescript/endpoints/delete-config","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/retrieve-config","label":"retrieveConfig","docId":"sdks/typescript/endpoints/retrieve-config","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/update-config","label":"updateConfig","docId":"sdks/typescript/endpoints/update-config","unlisted":false}],"collapsible":true},{"type":"category","label":"Emails","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/email-validation","label":"emailValidation","docId":"sdks/typescript/endpoints/email-validation","unlisted":false}],"collapsible":true},{"type":"category","label":"Phone Numbers","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/phone-number-validation","label":"phoneNumberValidation","docId":"sdks/typescript/endpoints/phone-number-validation","unlisted":false}],"collapsible":true},{"type":"category","label":"Place Search","collapsed":true,"items":[{"type":"link","href":"/docs/sdks/typescript/endpoints/find-place","label":"findPlace","docId":"sdks/typescript/endpoints/find-place","unlisted":false},{"type":"link","href":"/docs/sdks/typescript/endpoints/resolve-place","label":"resolvePlace","docId":"sdks/typescript/endpoints/resolve-place","unlisted":false}],"collapsible":true}],"collapsible":true}],"openApiSidebar":[{"type":"category","collapsed":false,"label":"API","items":[{"type":"link","href":"/docs/api/api-reference","label":"Introduction","docId":"api-reference","unlisted":false},{"type":"category","collapsed":false,"label":"Address Search","items":[{"type":"link","href":"/docs/api/find-address","label":"Find Address","className":"api-method get","docId":"api/find-address","unlisted":false},{"type":"link","href":"/docs/api/retrieve-address","label":"Retrieve Address","className":"api-method get","docId":"api/retrieve-address","unlisted":false}
1,{"type":"link","href":"/docs/api/address-verify","label":"Verify Address","className":"api-method post","docId":"api/address-verify","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Keys","items":[{"type":"link","href":"/docs/api/key-availability","label":"Key Availability","className":"api-method get","docId":"api/key-availability","unlisted":false},{"type":"link","href":"/docs/api/key-details","label":"Key Details","className":"api-method get","docId":"api/key-details","unlisted":false},{"type":"link","href":"/docs/api/update-key-details","label":"Update Key Details","className":"api-method put","docId":"api/update-key-details","unlisted":false},{"type":"link","href":"/docs/api/key-usage","label":"Key Usage","className":"api-method get","docId":"api/key-usage","unlisted":false},{"type":"link","href":"/docs/api/key-logs","label":"Key Logs","className":"api-method get","docId":"api/key-logs","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Emails","items":[{"type":"link","href":"/docs/api/email-validation","label":"Email Validation","className":"api-method get","docId":"api/email-validation","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Phone Numbers","items":[{"type":"link","href":"/docs/api/phone-number-validation","label":"Phone Number Validation","className":"api-method get","docId":"api/phone-number-validation","unlisted":false}],"collapsible":true},{"type":"category","label":"Place Search","className":"sidebar-hidden-category","items":[{"type":"link","href":"/docs/api/find-place","label":"Find Place","className":"api-method get","docId":"api/find-place","unlisted":false},{"type":"link","href":"/docs/api/resolve-place","label":"Resolve Place","className":"api-method get","docId":"api/resolve-place","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Licensees","className":"sidebar-hidden-category","items":[{"type":"link","href":"/docs/api/list-licensees","label":"List Licensees","className":"api-method get","docId":"api/list-licensees","unlisted":false},{"type":"link","href":"/docs/api/create-licensee","label":"Create Licensee","className":"api-method post","docId":"api/create-licensee","unlisted":false},{"type":"link","href":"/docs/api/retrieve-licensee","label":"Retrieve Licensee","className":"api-method get","docId":"api/retrieve-licensee","unlisted":false},{"type":"link","href":"/docs/api/update-licensee","label":"Update Licensee","className":"api-method put","docId":"api/update-licensee","unlisted":false},{"type":"link","href":"/docs/api/delete-licensee","label":"Cancel Licensee","className":"api-method delete","docId":"api/delete-licensee","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Configs","className":"sidebar-hidden-category","items":[{"type":"link","href":"/docs/api/list-configs","label":"List Configurations","className":"api-method get","docId":"api/list-configs","unlisted":false},{"type":"link","href":"/docs/api/create-config","label":"Create Configuration","className":"api-method post","docId":"api/create-config","unlisted":false},{"type":"link","href":"/docs/api/retrieve-config","label":"Retrieve Configuration","className":"api-method get","docId":"api/retrieve-config","unlisted":false},{"type":"link","href":"/docs/api/update-config","label":"Update Configuration","className":"api-method post","docId":"api/update-config","unlisted":false},{"type":"link","href":"/docs/api/delete-config","label":"Delete Configuration","className":"api-method delete","docId":"api/delete-config","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Sign Up","className":"sidebar-hidden-category","items":[{"type":"link","href":"/docs/api/sign-up-mint-token","label":"Mint CLI Signup Token","className":"api-method post","docId":"api/sign-up-mint-token","unlisted":false},{"type":"link","href":"/docs/api/sign-up-claim","label":"Poll CLI Signup Token","className":"api-method get","docId":"api/sign-up-claim","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/api"}],"switch":[{"type":"link","href":"/docs/how-to-switch","label":"Getting Started","docId":"how-to-switch/home","unlisted":false}
1,{"type":"link","href":"/docs/how-to-switch/search-boundaries","label":"Search Boundaries","docId":"how-to-switch/search-boundaries","unlisted":false},{"type":"link","href":"/docs/how-to-switch/additional-configuration","label":"Additional Configuration","docId":"how-to-switch/additional-configuration","unlisted":false},{"type":"category","collapsed":true,"label":"Style Adjustments","items":[{"type":"link","href":"/docs/styling-with-css","label":"Styling With CSS","docId":"how-to-switch/styling-with-css","unlisted":false},{"type":"link","href":"/docs/styling-with-javascript","label":"Styling With JavaScript","docId":"how-to-switch/styling-with-javascript","unlisted":false}],"collapsible":true}],"integrations":[{"type":"link","href":"/docs/integrations","label":"Getting Started","docId":"integrations/home","unlisted":false},{"type":"link","href":"/docs/integrations/build-with-ai","label":"Build with AI","docId":"integrations/build-with-ai","unlisted":false},{"type":"category","collapsed":true,"label":"AI App Builders","items":[{"type":"link","href":"/docs/integrations/lovable","label":"Lovable","docId":"integrations/lovable","unlisted":false},{"type":"link","href":"/docs/integrations/bolt","label":"Bolt","docId":"integrations/bolt","unlisted":false},{"type":"link","href":"/docs/integrations/v0","label":"v0","docId":"integrations/v0","unlisted":false},{"type":"link","href":"/docs/integrations/replit","label":"Replit","docId":"integrations/replit","unlisted":false},{"type":"link","href":"/docs/integrations/base44","label":"base44","docId":"integrations/base44","unlisted":false},{"type":"link","href":"/docs/integrations/leap-new","label":"Leap.new","docId":"integrations/leap-new","unlisted":false},{"type":"link","href":"/docs/integrations/anything","label":"Anything","docId":"integrations/anything","unlisted":false},{"type":"link","href":"/docs/integrations/shadcn","label":"shadcn registry","docId":"integrations/shadcn","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"eCommerce","items":[{"type":"link","href":"/docs/integrations/woocommerce","label":"WooCommerce","docId":"integrations/woocommerce","unlisted":false},{"type":"link","href":"/docs/integrations/magento","label":"Magento","docId":"integrations/magento","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Form Builders","items":[{"type":"link","href":"/docs/integrations/contact-form-7","label":"Contact Form 7","docId":"integrations/contact-form-7","unlisted":false},{"type":"link","href":"/docs/integrations/formassembly","label":"FormAssembly","docId":"integrations/formassembly","unlisted":false},{"type":"link","href":"/docs/integrations/formidable","label":"Formidable Forms","docId":"integrations/formidable","unlisted":false},{"type":"link","href":"/docs/integrations/forminator","label":"Forminator","docId":"integrations/forminator","unlisted":false},{"type":"link","href":"/docs/integrations/formstack","label":"Formstack","docId":"integrations/formstack","unlisted":false},{"type":"link","href":"/docs/integrations/gravity-forms","label":"Gravity Forms","docId":"integrations/gravity-forms","unlisted":false},{"type":"link","href":"/docs/integrations/jetformbuilder","label":"JetFormbuilder","docId":"integrations/jetformbuilder","unlisted":false},{"type":"link","href":"/docs/integrations/ninja-forms","label":"Ninja Forms","docId":"integrations/ninja-forms","unlisted":false},{"type":"link","href":"/docs/integrations/unbounce","label":"Unbounce","docId":"integrations/unbounce","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Page Builders","items":[{"type":"link","href":"/docs/integrations/elementor","label":"Elementor","docId":"integrations/elementor","unlisted":false},{"type":"link","href":"/docs/integrations/gutenberg","label":"Gutenberg Forms","docId":"integrations/gutenberg","unlisted":false},{"type":"link","href":"/docs/integrations/wix","label":"Wix","docId":"integrations/wix","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Workflow Automation","items":[{"type":"link","href":"/docs/integrations/zapier","label":"Zapier","docId":"integrations/zapier","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Coding Agents","items":[{"type":"link","href":"/docs/integrations/claude-code","label":"Claude Code","docId":"integrations/claude-code","unlisted":false},{"type":"link","href":"/docs/integrations/cursor","label":"Cursor","docId":"integrations/cursor","unlisted":false},{"type":"link","href":"/docs/integrations/codex","label":"Codex","docId":"integrations/codex","unlisted":false},{"type":"link","href":"/docs/integrations/windsurf","label":"Windsurf","docId":"integrations/windsurf","unlisted":false},{"type":"link","href":"/docs/integrations/github-copilot","label":"GitHub Copilot","docId":"integrations/github-copilot","unlisted":false}],"collapsible":true}],"addressVerification":[{"type":"link","href":"/docs/address-ver
1ification/getting-started","label":"Getting Started","docId":"address-verification/getting-started","unlisted":false}],"cli":[{"type":"link","href":"/docs/cli","label":"Overview","docId":"cli/cli","unlisted":false},{"type":"link","href":"/docs/cli/auth","label":"auth","docId":"cli/auth","unlisted":false},{"type":"link","href":"/docs/cli/keys","label":"keys","docId":"cli/keys","unlisted":false},{"type":"link","href":"/docs/cli/verify","label":"verify","docId":"cli/verify","unlisted":false},{"type":"link","href":"/docs/cli/email","label":"email","docId":"cli/email","unlisted":false},{"type":"link","href":"/docs/cli/phone","label":"phone","docId":"cli/phone","unlisted":false},{"type":"link","href":"/docs/cli/find","label":"find & resolve","docId":"cli/find","unlisted":false}],"addressfinder":[{"type":"link","href":"/docs/address-lookup","label":"Getting Started","docId":"address-lookup/home","unlisted":false},{"type":"link","href":"/docs/address-lookup/how-it-works","label":"How it Works","docId":"address-lookup/how-it-works","unlisted":false},{"type":"category","collapsed":true,"label":"Install","items":[{"type":"link","href":"/docs/address-lookup/script","label":"Drop-In Script","docId":"address-lookup/script","unlisted":false},{"type":"link","href":"/docs/address-lookup/npm","label":"Package Manager","docId":"address-lookup/npm","unlisted":false}],"collapsible":true},{"type":"link","href":"/docs/address-lookup/react","label":"React","docId":"address-lookup/react","unlisted":false},{"type":"link","href":"/docs/address-lookup/configure","label":"Configure","docId":"address-lookup/configure","unlisted":false},{"type":"link","href":"/docs/address-lookup/configuration-reference","label":"Configuration Reference","docId":"address-lookup/configuration-reference","unlisted":false},{"type":"category","collapsed":true,"label":"Styling","items":[{"type":"link","href":"/docs/address-lookup/default-styling","label":"Default Styling","docId":"address-lookup/default-styling","unlisted":false},{"type":"link","href":"/docs/address-lookup/style-tweaks","label":"Style Adjustments","docId":"address-lookup/style-tweaks","unlisted":false},{"type":"link","href":"/docs/address-lookup/css-classes","label":"CSS Classes","docId":"address-lookup/css-classes","unlisted":false}],"collapsible":true},{"type":"link","href":"/docs/address-lookup/messages","label":"Messages","docId":"address-lookup/messages","unlisted":false},{"type":"link","href":"/docs/address-lookup/callbacks","label":"Callbacks","docId":"address-lookup/callbacks","unlisted":false},{"type":"link","href":"/docs/address-lookup/accessibility","label":"Accessibility","docId":"address-lookup/accessibility","unlisted":false},{"type":"category","collapsed":true,"label":"How To","items":[{"type":"link","href":"/docs/address-lookup/separate-input","label":"Separate Input from Address","docId":"address-lookup/separate-input","unlisted":false},{"type":"link","href":"/docs/address-lookup/multiple","label":"Attach Multiple Instances","docId":"address-lookup/multiple","unlisted":false},{"type":"link","href":"/docs/address-lookup/additional-data","label":"Retrieve Additional Data","docId":"address-lookup/additional-data","unlisted":false},{"type":"link","href":"/docs/address-lookup/single-field","label":"Merge Address into One Field","docId":"address-lookup/single-field","unlisted":false},{"type":"link","href":"/docs/address-lookup/hide","label":"Hide Address Fields","docId":"address-lookup/hide","unlisted":false},{"type":"link","href":"/docs/address-lookup/no-match-action","label":"No-Match Action","docId":"address-lookup/no-match-action","unlisted":false},{"type":"link","href":"/docs/address-lookup/detach","label":"Detach Address Lookup","docId":"address-lookup/detach","unlisted":false},{"type":"link","href":"/docs/address-lookup/validate-before-submitting","label":"Validate Before Submitting","docId":"address-lookup/validate-before-submitting","unlisted":false},{"type":"link","href":"/docs/address-lookup/gate-population","label":"Gate Population","docId":"address-lookup/gate-population","unlisted":false},{"type":"link","href":"/docs/address-lookup/default-country","label":"Set Default Country","docId":"address-lookup/default-country","unlisted":false},{"type":"link","href":"/docs/address-lookup/restrict-country","label":"Restrict Supported Countries","docId":"address-lookup/restrict-country","unlisted":false},{"type":"link","href":"/docs/address-lookup/populate-country-select","label":"Populate a country select","docId":"address-lookup/populate-country-select","unlisted":false},{"type":"link","href":"/docs/address-lookup/restrict-to-states","label":"Restrict To States","docId":"address-lookup/restrict-to-states","unlisted":false},{"type":"link","href":"/docs/address-lookup/restrict-to-mainland-us","label":"Restrict To Mainland US","docId":"address-lookup/restrict-to-mainland-us","unlisted":false},{"type":"link","href":"/docs/address-lookup/exclude-po-box","label":"Exclude PO Box","docId":"address-lookup/exclude-po-box","unlisted":false},{"type":"link","href":"/docs/address-lookup/exclude-military","label":"Exclude Military Addresses","docId":"address-lookup/exclude-military","unlisted":false},{"type":"link","href":"/docs/address-lookup/exclude-islands","label":"Exclude Islands","docId":"address-lookup/exclude-islands","unlisted":false},{"type":"link","href":"/docs/address-lookup/bias-by-ip","label":"Bias By IP","docId":"address-lookup/bias-by-ip","unlisted":false},{"type":"link","href":"/docs/address-lookup/filter-by-geospatial-box","label":"Filter By Geospatial Box","docId":"address-lookup/filter-by-geospatial-box","unlisted":false},{"type":"link","href":"/docs/address-lookup/key-usability","label":"Key Usability","docId":"address-lookup/key-usability","unlisted":false},{"type":"link","href":"/docs/address-lookup/nudge","label":"Vertically Shift","docId":"address-lookup/nudge","unlisted":false}],"collapsible":true},{"type":"link","href":"/docs/address-lookup/behavior","label":"Behavior","docId":"address-lookup/behavior","unlisted":false},{"type":"link","label":"npm","href":"https://www.npmjs.com/package/@addresszen/address-lookup"},{"type":"link","label":"Changelog","href":"https://cdn.jsdelivr.net/npm/@addresszen/address-lookup/CHANGELOG.md"}],"data":[{"type":"link","href":"/docs/data","label":"Data","docId":"data/home","unlisted":false},{"type":"link","href":"/docs/data/address","label":"Standard Address","docId":"data/address","unlisted":false},{"type":"link","href":"/docs/data/supported-countries","label":"Supported Countries","docId":"data/supported-countries","unlisted":false},{"type":"category","collapsed":true,"label":"US","items":[{"type":"link","href":"/docs/data/usps","label":"USPS Address","docId":"data/usps","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Australia","items":[{"type":"link","href":"/docs/data/gnaf","label":"G-NAF Address","docId":"data/gnaf","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Belgium","items":[{"type":"link","href":"/docs/data/fodbosa","label":"FODBOSA","docId":"data/fodbosa","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Canada","items":[{"type":"link","href":"/docs/data/cannar","label":"National Address Register","docId":"data/cannar","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Denmark","items":[{"type":"link","href":"/docs/data/sdfi","label":"SDFI","docId":"data/sdfi","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"France","items":[{"type":"link","href":"/docs/data/ban","label":"BAN Address","docId":"data/ban","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Ireland","items":[{"type":"link","href":"/docs/data/ecaf","label":"ECAF","docId":"data/ecaf","unlisted":false},{"type":"link","href":"/docs/data/ecad","label":"ECAD","docId":"data/ecad","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Japan","items":[{"type":"link","href":"/docs/data/upujp","label":"UPUJP","docId":"data/upujp","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Netherlands","items":[{"type":"link","href":"/docs/data/kadaster","label":"Kadaster","docId":"data/kadaster","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Norway","items":[{"type":"link","href":"/docs/data/kartverket","label":"Kartverket","docId":"data/kartverket","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"South Korea","items":[{"type":"link","href":"/docs/data/mois","label":"MoIS","docId":"data/mois","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Switzerland & Liechtenstein","items":[{"type":"link","href":"/docs/data/swt","label":"Swisstopo Address","docId":"data/swt","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"United Kingdom","items":[{"type":"link","href":"/docs/data/paf","label":"Standard Address","docId":"data/paf","unlisted":false},{"type":"link","href":"/docs/data/mr","label":"Multiple Residence","docId":"data/mr","unlisted":false},{"type":"link","href":"/docs/data/nyb","label":"Not Yet Built","docId":"data/nyb","unlisted":false},{"type":"link","href":"/docs/data/welsh-paf","label":"Welsh PAF","docId":"data/welsh-paf","unlisted":false},{"type":"link","href":"/docs/data/nip","label":"Northern Ireland Pointer","docId":"data/nip","unlisted":false},{"type":"link","href":"/docs/data/paf-aliases","label":"PAF Aliases","docId":"data/paf-aliases","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Global Addresses","items":[{"type":"link","href":"/docs/data/here","label":"HERE","docId":"data/here","unlisted":false}],"collapsible":true}],"guides":[{"type":"link","href":"/docs/guides","label":"Getting Started","docId":"guides/home","unlisted":false}
1,{"type":"category","collapsed":true,"label":"Account","items":[{"type":"link","href":"/docs/guides/api-key","label":"API Key","docId":"guides/api-key","unlisted":false},{"type":"link","href":"/docs/guides/api-key-settings","label":"API Key Settings","docId":"guides/api-key-settings","unlisted":false},{"type":"link","href":"/docs/guides/api-key-secure","label":"API Key Security","docId":"guides/api-key-secure","unlisted":false},{"type":"link","href":"/docs/guides/allowed-urls","label":"Allowed URLs","docId":"guides/allowed-urls","unlisted":false},{"type":"link","href":"/docs/guides/automated-topups","label":"Automated Top-Ups","docId":"guides/automated-topups","unlisted":false},{"type":"link","href":"/docs/guides/purchasing-lookups","label":"Purchasing Lookups","docId":"guides/purchasing-lookups","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"API","items":[{"type":"link","href":"/docs/guides/testing","label":"Testing","docId":"guides/testing","unlisted":false},{"type":"link","href":"/docs/guides/error-codes","label":"Error Codes","docId":"guides/error-codes","unlisted":false},{"type":"link","href":"/docs/changelog","label":"Changelog","docId":"changelog","unlisted":false},{"type":"link","href":"/docs/tags","label":"Tagging","docId":"guides/tag","unlisted":false},{"type":"link","href":"/docs/guides/tag-and-track","label":"Tagging and Usage Tracking","docId":"guides/tag-and-track","unlisted":false}],"collapsible":true},{"type":"category","collapsed":true,"label":"Libraries","items":[{"type":"link","href":"/docs/libraries/open-api","label":"OpenAPI","docId":"libraries/open-api","unlisted":false}],"collapsible":true},{"type":"link","label":"Migrate from Google","href":"/docs/how-to-switch"},{"type":"link","label":"CLI","href":"/docs/cli"},{"type":"link","href":"/docs/guides/data","label":"Data Processing","docId":"guides/data","unlisted":false},{"type":"link","href":"/docs/guides/llms","label":"AI Assist","docId":"guides/llms","unlisted":false}]},"docs":{"address-lookup/accessibility":{"id":"address-lookup/accessibility","title":"Accessibility","description":"Address Lookup is developed to meet WCAG 2.1 Level AA. It implements the WAI-ARIA combobox pattern, works with screen readers and is fully operable by keyboard.","sidebar":"addressfinder"},"address-lookup/additional-data":{"id":"address-lookup/additional-data","title":"Retrieve Additional Data","description":"You may insert more address attributes into your form by expanding outputFields.","sidebar":"addressfinder"},"address-lookup/behavior":{"id":"address-lookup/behavior","title":"Behavior","description":"This guide outlines technical details about how Address Lookup behaves and interacts with the DOM.","sidebar":"addressfinder"},"address-lookup/bias-by-geolocation":{"id":"address-lookup/bias-by-geolocation","title":"Bias By Geolocation","description":"Biases the search to a geospatial circle determined by an origin and radius in meters. Max radius is 50000."},"address-lookup/bias-by-ip":{"id":"address-lookup/bias-by-ip","title":"Bias By IP","description":"Biases the search based on approximate geolocation of an IP address. Set bias_ip to true within queryOptions to enable.","sidebar":"addressfinder"},"address-lookup/callbacks":{"id":"address-lookup/callbacks","title":"Callbacks","description":"Address Lookup also provides callbacks which let you hook the following events:","sidebar":"addressfinder"},"address-lookup/configuration-reference":{"id":"address-lookup/configuration-reference","title":"Configuration Reference","description":"A complete reference for every option accepted by AddressLookup.setup. Only apiKey and outputFields are required; everything else is optional and has a sensible default.","sidebar":"addressfinder"},"address-lookup/configure":{"id":"address-lookup/configure","title":"Configure","description":"Address Lookup exports a setup method to apply address verification to a form. setup requires the following configuration at minimum.","sidebar":"addressfinder"},"address-lookup/css-classes":{"id":"address-lookup/css-classes","title":"CSS Classes","description":"The Address Lookup can be styled with CSS classes.","sidebar":"addressfinder"},"address-lookup/default-country":{"id":"address-lookup/default-country","title":"Setting the default country","description":"Disable the country detection on Address Lookup and set the default country.","sidebar":"addressfinder"}
1,"address-lookup/default-styling":{"id":"address-lookup/default-styling","title":"Default Styling","description":"Address Lookup\'s default styling works by injecting a style tag into the document head.","sidebar":"addressfinder"},"address-lookup/detach":{"id":"address-lookup/detach","title":"Detach Address Lookup","description":"After instantiation, you can detach Address Lookup with detach.","sidebar":"addressfinder"},"address-lookup/exclude-islands":{"id":"address-lookup/exclude-islands","title":"Exclude Islands","description":"Removes US addresses from these islands:","sidebar":"addressfinder"},"address-lookup/exclude-military":{"id":"address-lookup/exclude-military","title":"Exclude Military Addresses","description":"Remove military addresses from the list of suggestions.","sidebar":"addressfinder"},"address-lookup/exclude-po-box":{"id":"address-lookup/exclude-po-box","title":"Exclude PO Box","description":"Remove addresses that have a PO Box from the list of suggestions.","sidebar":"addressfinder"},"address-lookup/filter-by-geospatial-box":{"id":"address-lookup/filter-by-geospatial-box","title":"Filter By Geospatial Box","description":"Restricts the search to a geospatial box determined by the \\"top-left\\" and \\"bottom-right\\" geolocations.","sidebar":"addressfinder"},"address-lookup/gate-population":{"id":"address-lookup/gate-population","title":"Gate Population by Delivery Area","description":"Overview","sidebar":"addressfinder"},"address-lookup/hide":{"id":"address-lookup/hide","title":"Hide Address Fields","description":"Hide","sidebar":"addressfinder"},"address-lookup/home":{"id":"address-lookup/home","title":"Address Lookup API Documentation","description":"Add Address Verification to your address forms in moments with our Address Lookup JavaScript package.","sidebar":"addressfinder"},"address-lookup/how-it-works":{"id":"address-lookup/how-it-works","title":"How it Works","description":"Address Lookup can be attached to any form with pre-existing address inputs.","sidebar":"addressfinder"},"address-lookup/key-usability":{"id":"address-lookup/key-usability","title":"Key Usability","description":"Your key may not be available at some times. For instance:","sidebar":"addressfinder"},"address-lookup/messages":{"id":"address-lookup/messages","title":"Messages","description":"Address Lookup uses a small default set of messages to communicate specific events to the user. All of Address Lookup\'s default messages can be overridden. They are outlined below:","sidebar":"addressfinder"},"address-lookup/multiple":{"id":"address-lookup/multiple","title":"Attach Multiple Instances","description":"Address Lookup can be invoked multiple times to attach multiple instances to your forms.","sidebar":"addressfinder"},"address-lookup/no-match-action":{"id":"address-lookup/no-match-action","title":"Offer an Out When No Matches Are Found","description":"No-Match Action","sidebar":"addressfinder"},"address-lookup/npm":{"id":"address-lookup/npm","title":"Package Manager (npm)","description":"Address Lookup is also available without transpilation or minification on npm as @addresszen/address-lookup.","sidebar":"addressfinder"},"address-lookup/nudge":{"id":"address-lookup/nudge","title":"Vertically Shift Address Lookup","description":"From time to time, you may want to tweak the default style of Address Lookup to better match your application\'s design system.","sidebar":"addressfinder"},"address-lookup/populate-country-select":{"id":"address-lookup/populate-country-select","title":"Populate a country select","description":"Your form may capture country with a ` rather than a free text - for example a checkout that stores the ISO-3 country code (\\"USA\\", \\"CAN\\", \\"GBR\\"`) against the order.","sidebar":"addressfinder"},"address-lookup/prevent-autofill":{"id":"address-lookup/prevent-autofill","title":"Prevent Autofill","description":"Sets the autocomplete= attribute of the input element. Setting this attribute aims to prevent some browsers (particularly Chrome) from providing a clashing autofill overlay."},"address-lookup/react":{"id":"address-lookup/react","title":"Add to React","description":"@addresszen/react is the official React integration for Address Lookup. It renders an `, attaches the widget, and hands selected addresses back through callbacks - no useEffect or useRef` wiring required.","sidebar":"addressfinder"},"address-lookup/restrict-country":{"id":"address-lookup/restrict-country","title":"Restrict search to chosen countries","description":"Narrow the countries you wish to
1support.","sidebar":"addressfinder"},"address-lookup/restrict-to-mainland-us":{"id":"address-lookup/restrict-to-mainland-us","title":"Restrict To Mainland US","description":"Narrow the addresses to return US Mainland addresses only.","sidebar":"addressfinder"},"address-lookup/restrict-to-states":{"id":"address-lookup/restrict-to-states","title":"Restrict To States","description":"Narrow the states you wish to support.","sidebar":"addressfinder"},"address-lookup/script":{"id":"address-lookup/script","title":"Drop-In Script","description":"Address Lookup is shipped in a polyfilled, typed and minified package called address-lookup.","sidebar":"addressfinder"},"address-lookup/separate-input":{"id":"address-lookup/separate-input","title":"Separate Input from Address","description":"Specify an inputField to apply the Address Lookup to a field other than the first line of the address.","sidebar":"addressfinder"},"address-lookup/single-field":{"id":"address-lookup/single-field","title":"Merge Address into a Single Field","description":"Instead of writing each address attribute to individual fields, you may exercise fine control about how address data is presented using the onAddressRetrieved callback.","sidebar":"addressfinder"},"address-lookup/style-tweaks":{"id":"address-lookup/style-tweaks","title":"Style Adjustments","description":"It\'s possible that the default styling may require a small tweak to allow it to better match your design and site aesthetic. Rather than adding CSS assets, we recommend applying a style attribute as a setup configuration option. The configurations below apply a style attribute directly to a specific element of the Address Lookup.","sidebar":"addressfinder"},"address-lookup/validate-before-submitting":{"id":"address-lookup/validate-before-submitting","title":"Validate Before Submitting","description":"Overview","sidebar":"addressfinder"},"address-verification/getting-started":{"id":"address-verification/getting-started","title":"Address Verification API | Getting Started","description":"Clean, standardize, and validate US addresses using USPS CASS-certified data.","sidebar":"addressVerification"},"api-home":{"id":"api-home","title":"API Reference","description":"The AddressZen API powers global address autocomplete, US address verification, and contact-data validation.","sidebar":"openApiSidebar"},"api-reference":{"id":"api-reference","title":"API Reference","description":"A REST service over HTTPS, returning JSON and authenticated with an API key.","sidebar":"openApiSidebar"},"api/address-verify":{"id":"api/address-verify","title":"Verify Address","description":"Validate, correct and standardize US addresses against USPS CASS.","sidebar":"openApiSidebar"},"api/create-config":{"id":"api/create-config","title":"Create Configuration","description":"Creates a new configuration object associated with an API Key.","sidebar":"openApiSidebar"},"api/create-licensee":{"id":"api/create-licensee","title":"Create Licensee","description":"Create a licensee for an API Key.","sidebar":"openApiSidebar"},"api/delete-config":{"id":"api/delete-config","title":"Delete Configuration","description":"Permanently deletes a configuration object.","sidebar":"openApiSidebar"},"api/delete-licensee":{"id":"api/delete-licensee","title":"Cancel Licensee","description":"Cancel a licensee key, rendering it unusable.","sidebar":"openApiSidebar"},"api/email-validation":{"id":"api/email-validation","title":"Email Validation","description":"Query for and validate email addresses.","sidebar":"openApiSidebar"},"api/find-address":{"id":"api/find-address","title":"Find Address","description":"Delivers address suggestions in order of relevance based on a provided query for search-as-you-type address autocomplete.","sidebar":"openApiSidebar"},"api/find-place":{"id":"api/find-place","title":"Find Place","description":"Query for geographical places across countries. Returns a list of place suggestions with names and IDs.","sidebar":"openApiSidebar"},"api/key-availability":{"id":"api/key-availability","title":"Key Availability","description":"Returns public information on an API Key, whether it is usable, its available contexts, and the current likely context.","sidebar":"openApiSidebar"},"api/key-details":{"id":"api/key-details","title":"Key Details","description":"Returns private data on the key including remaining lookups, available datasets and usage limits.","sidebar":"openApiSidebar"},"api/key-logs":{"id":"api/key-logs","title":"Key Logs (CSV)","description":"Returns a CSV download of lookup data and associated information for a key.","sidebar":"openApiSidebar"}
1,"api/key-usage":{"id":"api/key-usage","title":"Key Usage","description":"Reports the number of lookups consumed on a key for a range of days.","sidebar":"openApiSidebar"},"api/list-configs":{"id":"api/list-configs","title":"List Configurations","description":"Lists all configurations associated with an API Key.","sidebar":"openApiSidebar"},"api/list-licensees":{"id":"api/list-licensees","title":"List Licensees","description":"Returns a list of licensees for an API Key.","sidebar":"openApiSidebar"},"api/phone-number-validation":{"id":"api/phone-number-validation","title":"Phone Number Validation","description":"Query for and validate phone numbers.","sidebar":"openApiSidebar"},"api/resolve-place":{"id":"api/resolve-place","title":"Resolve Place","description":"Resolves a place autocompletion by its place ID to retrieve full place details including coordinates, timezone, and GeoNames metadata.","sidebar":"openApiSidebar"},"api/retrieve-address":{"id":"api/retrieve-address","title":"Retrieve Address","description":"Resolves an address suggestion by its ID into a full US-formatted address record.","sidebar":"openApiSidebar"},"api/retrieve-config":{"id":"api/retrieve-config","title":"Retrieve Configuration","description":"Retrieves a single configuration object by name.","sidebar":"openApiSidebar"},"api/retrieve-licensee":{"id":"api/retrieve-licensee","title":"Retrieve Licensee","description":"Returns licensee information for a given licensee key.","sidebar":"openApiSidebar"},"api/sign-up-claim":{"id":"api/sign-up-claim","title":"Poll CLI Signup Token","description":"Polls the status of a CLI signup token to retrieve account credentials once signup is complete.","sidebar":"openApiSidebar"},"api/sign-up-mint-token":{"id":"api/sign-up-mint-token","title":"Mint CLI Signup Token","description":"Mints a one-shot CLI signup token and returns a prefilled signup URL for account creation.","sidebar":"openApiSidebar"},"api/update-config":{"id":"api/update-config","title":"Update Configuration","description":"Updates an existing configuration object.","sidebar":"openApiSidebar"},"api/update-key-details":{"id":"api/update-key-details","title":"Update Key Details","description":"Update API Key Details","sidebar":"openApiSidebar"},"api/update-licensee":{"id":"api/update-licensee","title":"Update Licensee","description":"Update licensee details for a given licensee key.","sidebar":"openApiSidebar"},"changelog":{"id":"changelog","title":"Changelog","description":"Stay informed about the latest updates and improvements to our address validation services with our changelog. View release notes and see what\'s new.","sidebar":"guides"},"cli/auth":{"id":"cli/auth","title":"azn auth","description":"Manage stored credentials at ~/.config/addresszen/credentials.json (or %APPDATA%\\\\addresszen\\\\credentials.json on Windows, or $XDGCONFIGHOME/addresszen/... if set). The file is written with mode 0600.","sidebar":"cli"},"cli/cli":{"id":"cli/cli","title":"AddressZen CLI","description":"azn is the official command line interface for AddressZen. It manages API keys, verifies US addresses, validates emails and phone numbers, and resolves specific addresses from partial queries.","sidebar":"cli"},"cli/email":{"id":"cli/email","title":"azn email","description":"Validate email addresses: GET /emails. Requires api_key. Each input counts as a paid lookup.","sidebar":"cli"},"cli/find":{"id":"cli/find","title":"azn find & resolve","description":"Address autocomplete: two-step by design. Useful when you need to pin a
1specific address from partial info before using it downstream.","sidebar":"cli"},"cli/keys":{"id":"cli/keys","title":"azn keys","description":"Inspect and manage API keys.","sidebar":"cli"},"cli/phone":{"id":"cli/phone","title":"azn phone","description":"Validate phone numbers: GET /phonenumbers. Requires apikey. Each input counts as a paid lookup.","sidebar":"cli"},"cli/verify":{"id":"cli/verify","title":"azn verify","description":"Verify and standardize US addresses against USPS CASS-certified data: POST /verify/addresses. Requires api_key. Each input counts as a paid lookup.","sidebar":"cli"},"data/address":{"id":"data/address","title":"Standard Address","description":"{address.description}","sidebar":"data"},"data/ban":{"id":"data/ban","title":"BAN French Address File","description":"The Base Adresse Nationale (BAN) is France\'s official open national address","sidebar":"data"},"data/cannar":{"id":"data/cannar","title":"Canada National Address Register","description":"Example Record","sidebar":"data"},"data/ecad":{"id":"data/ecad","title":"IE Address (ECAD)","description":"ECAD file including additional data for each address.","sidebar":"data"},"data/ecaf":{"id":"data/ecaf","title":"IE Address (ECAF)","description":"{model.description}","sidebar":"data"},"data/fodbosa":{"id":"data/fodbosa","title":"FODBOSA","description":"Example Record","sidebar":"data"},"data/geonames":{"id":"data/geonames","title":"Geonames","description":"{model.description}"},"data/gnaf":{"id":"data/gnaf","title":"Geocoded National Address File","description":"{model.description}","sidebar":"data"},"data/here":{"id":"data/here","title":"HERE Global Address","description":"HERE provides comprehensive global address data with standardized formats across 240+ countries and territories.","sidebar":"data"},"data/home":{"id":"data/home","title":"Data","description":"Our address search and verification APIs return addressing data in different formats based on national conventions and datasets.","sidebar":"data"},"data/kadaster":{"id":"data/kadaster","title":"Kadaster","description":"{model.description}","sidebar":"data"},"data/kartverket":{"id":"data/kartverket","title":"Kartverket","description":"{model.description}","sidebar":"data"},"data/mois":{"id":"data/mois","title":"MoIS","description":"{model.description}","sidebar":"data"},"data/mr":{"id":"data/mr","title":"Multiple Residence","description":"For more information on the Multiple Residence dataset, please refer to our comprehensive guide on this topic: Read More.","sidebar":"data"},"data/nip":{"id":"data/nip","title":"Northern Ireland Pointer","description":"Northern Ireland Pointer data is sourced from OSNI (Ordnance Survey of Northern Ireland).","sidebar":"data"},"data/nyb":{"id":"data/nyb","title":"Not Yet Built","description":"The Not Yet Built address format is identical to the Postcode Address File format. Only the dataset label differs.","sidebar":"data"},"data/paf":{"id":"data/paf","title":"Standard UK Address","description":"Our APIs return all data contained in Royal Mail\'s Postcode Address File.","sidebar":"data"},"data/paf-aliases":{"id":"data/paf-aliases","title":"UK Alias Addresses","description":"The Alias address format is identical to the Postcode Address File format.","sidebar":"data"},"data/paf-supported-territories":{"id":"data/paf-supported-territories","title":"Supported Territories","description":"The PAF dataset covers the UK only. This includes:"},"data/sdfi":{"id":"data/sdfi","title":"SDFI","description":"{model.description}","sidebar":"data"},"data/supported-countries":{"id":"data/supported-countries","title":"Supported Countries","description":"The Find Address API searches addresses in {countries.length} countries and territories, served by datasets. The table at the foot of this page lists every country with how fine its coverage is and the context value that selects it.","sidebar":"data"},"data/swt":{"id":"data/swt","title":"Swisstopo Swiss Address File","description":"{model.description}","sidebar":"data"},"data/upujp":{"id":"data/upujp","title":"UPUJP","description":"Example Record","sidebar":"data"},"data/usps":{"id":"data/usps","title":"United States Postal Service Address","description":"{model.description}","sidebar":"data"},"data/welsh-paf":{"id":"data/welsh-paf","title":"Welsh Address","description":"The Welsh Postcode Address File format is identical to the Postcode Address File format except locality information such as post town, locality, and dependent locality, which are presented in Welsh.","sidebar":"data"},"glossary":{"id":"glossary","title":"Glossary","description":"---"},"guides/allowed-urls":{"id":"guides/allowed-urls","title":"Allowed URLs","description":"Allowed URLs restrict a Key to a list of web addresses. We match the Referer and Origin headers of an incoming HTTP request against your list. If no match is found, the API returns a 4011 reply. If a match is found the request proceeds as
1normal, and the Access-Control-Allow-Origin response header is set to the requester\'s Origin.","sidebar":"guides"},"guides/api-key":{"id":"guides/api-key","title":"API Key","description":"Your API Keys are listed on your dashboard after you sign in. An API Key generally begins with the characters ak_.","sidebar":"guides"},"guides/api-key-secure":{"id":"guides/api-key-secure","title":"API Key Security","description":"Usage of your API Key can be controlled three ways: by the URL a request comes from, by total lookups in a day and by total lookups per IP address in a day. Which of them you reach for depends on where your integration runs.","sidebar":"guides"},"guides/api-key-settings":{"id":"guides/api-key-settings","title":"API Key Settings","description":"Limit how much your API Key can be used, and from where, via the Security panel on your dashboard. Whether your key sits on a server or in a browser, we strongly recommend setting both a daily and an individual lookup limit.","sidebar":"guides"},"guides/automated-topups":{"id":"guides/automated-topups","title":"Automated Top-Ups","description":"Enabling Automated Top-Ups","sidebar":"guides"},"guides/data":{"id":"guides/data","title":"Data Processing","description":"Outlined in this document is a concise overview of how modern data protection law (namely, GDPR) relates specifically to us as your data processor (or subprocessor).","sidebar":"guides"},"guides/error-codes":{"id":"guides/error-codes","title":"Error Codes and Common Fixes","description":"AddressZen API error codes with causes and fixes, ordered by how often each one comes up in support.","sidebar":"guides"},"guides/home":{"id":"guides/home","title":"Guides","description":"Guides to AddressZen API Keys, billing, testing and integration, grouped by what you are trying to do.","sidebar":"guides"},"guides/llms":{"id":"guides/llms","title":"AI Assist","description":"Index of every AddressZen asset designed for AI agents and AI-powered app builders.","sidebar":"guides"},"guides/purchasing-lookups":{"id":"guides/purchasing-lookups","title":"Purchasing Lookups","description":"A lookup balance is our form of credit which permits one valid address search.","sidebar":"guides"},"guides/sublicensing":{"id":"guides/sublicensing","title":"Sublicensing","description":"Sublicensing Keys allow you to license multiple organisations or individuals under the same key. All managed, controlled and billed to you under the same account."},"guides/tag":{"id":"guides/tag","title":"Tagging","description":"Any request that affects your Key balance may be decorated with metadata called tags. This data is stored along with your lookup history and can be queried via the API. We call the ability to label your requests \\"tagging\\".","sidebar":"guides"},"guides/tag-and-track":{"id":"guides/tag-and-track","title":"Tagging and Usage Tracking","description":"Any request which affects your Key balance may be decorated with metadata called tags. This data is stored along with your lookup history and can be queried via the API. We call the ability to label your requests \\"tagging\\".","sidebar":"guides"},"guides/testing":{"id":"guides/testing","title":"API Testing","description":"We previously recommended using hardcoded test requests; we now recommend testing genuine address requests with a test balance or dedicated test key.","sidebar":"guides"},"how-to-switch/additional-configuration":{"id":"how-to-switch/additional-configuration","title":"Additional Configuration","description":"Expanding on the additional configuration options for AddressZen\'s Address Lookup service can help you fine-tune how address data is gathered and presented within your application, enhancing usability and the overall user experience. Here\'s a detailed explanation of each configuration option mentioned:","sidebar":"switch"},"how-to-switch/home":{"id":"how-to-switch/home","title":"How to Switch","description":"Switching from Google\'s Address Validation and Place Autocomplete to AddressZen offers distinct advantages, particularly for applications targeting a U.S. audience:","sidebar":"switch"}
1,"how-to-switch/search-boundaries":{"id":"how-to-switch/search-boundaries","title":"Search Boundaries","description":"AddressZen offers a suite of advanced features to tailor the address lookup functionality to your specific needs. This guide outlines how to implement Bias By IP, Filter By Country, Exclude Islands, Exclude Military Addresses, and Exclude PO Boxes, enabling a more customized and relevant user experience.","sidebar":"switch"},"how-to-switch/styling-with-css":{"id":"how-to-switch/styling-with-css","title":"Styling With CSS","description":"idpc_autocomplete","sidebar":"switch"},"how-to-switch/styling-with-javascript":{"id":"how-to-switch/styling-with-javascript","title":"Styling With JavaScript","description":"mainStyle","sidebar":"switch"},"integrations/anything":{"id":"integrations/anything","title":"Anything","description":"Add the AddressZen Address Lookup to an Anything (Create Anything) app.","sidebar":"integrations"},"integrations/anything-prompt":{"id":"integrations/anything-prompt","title":"Anything integration rules","description":"Reference rules for an AI builder integrating the AddressZen Address Lookup React component into an Anything (React) app."},"integrations/base44":{"id":"integrations/base44","title":"base44","description":"Add the AddressZen Address Lookup to a base44 app.","sidebar":"integrations"},"integrations/base44-prompt":{"id":"integrations/base44-prompt","title":"base44 integration rules","description":"Reference rules for an AI builder integrating the AddressZen Address Lookup React component into a base44 (React) app."},"integrations/bigcommerce":{"id":"integrations/bigcommerce","title":"BigCommerce Address Verification Documentation","description":"Features"},"integrations/bolt":{"id":"integrations/bolt","title":"Bolt","description":"Add the AddressZen Address Lookup to a Bolt.new app.","sidebar":"integrations"},"integrations/build-with-ai":{"id":"integrations/build-with-ai","title":"Build with AI","description":"Per-platform guides for adding AddressZen to AI coding agents and browser-based app builders.","sidebar":"integrations"},"integrations/claude-code":{"id":"integrations/claude-code","title":"Claude Code","description":"Install the AddressZen agent skills into Claude Code for guided Address Lookup and API integration.","sidebar":"integrations"},"integrations/codex":{"id":"integrations/codex","title":"Codex","description":"Install the AddressZen agent skills into OpenAI Codex for guided Address Lookup and API integration.","sidebar":"integrations"},"integrations/contact-form-7":{"id":"integrations/contact-form-7","title":"Contact Form 7 Address Verification | Documentation","description":"Integrate Address Validation into Your WordPress Contact Form 7 Pages.","sidebar":"integrations"},"integrations/cursor":{"id":"integrations/cursor","title":"Cursor","description":"Install the AddressZen agent skills into Cursor for guided Address Lookup and API integration.","sidebar":"integrations"},"integrations/divi":{"id":"integrations/divi","title":"Divi Address Verification | Documentation","description":"Integrate Address Validation with the WordPress Divi Page Builder."},"integrations/elementor":{"id":"integrations/elementor","title":"Elementor Address Validation | Documentation","description":"Add address validation to your WordPress Elementor pages. Follow the address lookup guide to get started.","sidebar":"integrations"},"integrations/formassembly":{"id":"integrations/formassembly","title":"FormAssembly Address Verification | Documentation","description":"Demo","sidebar":"integrations"},"integrations/formidable":{"id":"integrations/formidable","title":"Formidable Forms Address Verification Integration | Documentation","description":"Demo","sidebar":"integrations"},"integrations/forminator":{"id":"integrations/forminator","title":"Forminator Address Verification | Documentation","description":"Add address lookup to your WordPress Forminator pages. Follow the address lookup guide to get started. Live developer support.","sidebar":"integrations"},"integrations/formstack":{"id":"integrations/formstack","title":"Formstack Address Verification | Documentation","description":"Add address verification to your Formstack Form builder with AddressZen Address Lookup integration. Simply insert JavaScript into the form builder.","sidebar":"integrations"}
1,"integrations/github-copilot":{"id":"integrations/github-copilot","title":"GitHub Copilot","description":"Wire AddressZen documentation into GitHub Copilot via custom instructions.","sidebar":"integrations"},"integrations/gravity-forms":{"id":"integrations/gravity-forms","title":"Gravity Forms Address Verification Integration | Documentation","description":"Demo","sidebar":"integrations"},"integrations/gutenberg":{"id":"integrations/gutenberg","title":"Gutenberg Forms Address Verification Integration | Documentation","description":"Integrate Address Validation into Your WordPress Gutenberg Forms Pages.","sidebar":"integrations"},"integrations/home":{"id":"integrations/home","title":"Integrations","description":"Add address verification to eCommerce platforms, CRMs and form builders with a native extension or integration guide.","sidebar":"integrations"},"integrations/jetformbuilder":{"id":"integrations/jetformbuilder","title":"JetFormbuilder Address Verification | Documentation","description":"Demo","sidebar":"integrations"},"integrations/leap-new":{"id":"integrations/leap-new","title":"Leap.new","description":"Add the AddressZen Address Lookup to a
1Leap.new app.","sidebar":"integrations"},"integrations/lovable":{"id":"integrations/lovable","title":"Lovable","description":"Add the AddressZen Address Lookup to a Lovable app.","sidebar":"integrations"},"integrations/magento":{"id":"integrations/magento","title":"Magento Address Verification Integration | Documentation","description":"Magento extension for US address search and verification. Follow our setup guide to get started. Quick and easy implementation. Live developer support available.","sidebar":"integrations"},"integrations/ninja-forms":{"id":"integrations/ninja-forms","title":"Ninja Forms Address Verification | Documentation","description":"Demo","sidebar":"integrations"},"integrations/opencart":{"id":"integrations/opencart","title":"OpenCart Address Verification Integration | Documentation","description":"OpenCart Module for UK Address Search and Validation"},"integrations/replit":{"id":"integrations/replit","title":"Replit","description":"Add the AddressZen Address Lookup to a Replit app.","sidebar":"integrations"},"integrations/shadcn":{"id":"integrations/shadcn","title":"shadcn registry","description":"Drop-in shadcn components for AddressZen Address Lookup.","sidebar":"integrations"},"integrations/shopwired":{"id":"integrations/shopwired","title":"ShopWired Address Verification | Documentation","description":"ShopWired Integration for UK Address Search and Validation"},"integrations/unbounce":{"id":"integrations/unbounce","title":"Unbounce Address Verification | Documentation","description":"Integrate Address Validation into Your Unbounce Form","sidebar":"integrations"},"integrations/v0":{"id":"integrations/v0","title":"v0","description":"Add the AddressZen Address Lookup to a v0 app.","sidebar":"integrations"},"integrations/windsurf":{"id":"integrations/windsurf","title":"Windsurf","description":"Use AddressZen inside Windsurf by pointing Cascade at our llms.txt context file.","sidebar":"integrations"},"integrations/wix":{"id":"integrations/wix","title":"Wix Address Validation | Documentation","description":"Integrate Address Verification with the Wix Editor.","sidebar":"integrations"},"integrations/woocommerce":{"id":"integrations/woocommerce","title":"WooCommerce Address Validation | Documentation","description":"Integrate Address Lookup into your WordPress WooCommerce address forms. Follow our simple guide to get started.","sidebar":"integrations"},"integrations/zapier":{"id":"integrations/zapier","title":"Zapier Address Verification | Documentation","description":"Zap Creation","sidebar":"integrations"},"libraries/open-api":{"id":"libraries/open-api","title":"OpenAPI Specification","description":"OpenAPI Specification is an API description format for REST APIs. Our OpenAPI files describe the entire API including available endpoints, operation parameters and request outputs.","sidebar":"guides"},"sdks/sdks":{"id":"sdks/sdks","title":"SDKs","description":"The TypeScript SDK calls the AddressZen API from browsers and Node.js with typed functions over native fetch. It covers address autocomplete in the US and other countries, US address verification and account management, with optional autocomplete and TanStack Query helpers.","sidebar":"sdks"}
1,"sdks/typescript/address-verify":{"id":"sdks/typescript/address-verify","title":"Address Verification","description":"addressVerify checks a US address against the USPS Coding Accuracy Support System (CASS) and returns it corrected and standardized, with its ZIP+4 code and USPS delivery data. Verification covers US addresses only. For other countries, use autocomplete with context set to the country\'s code.","sidebar":"sdks"},"sdks/typescript/autocomplete":{"id":"sdks/typescript/autocomplete","title":"Autocomplete","description":"The autocomplete helper turns a partial address into suggestions, then a chosen suggestion into a full address. It debounces keystrokes, drops stale requests and caches recent suggestions. Each search runs in one country, set with context.","sidebar":"sdks"},"sdks/typescript/common":{"id":"sdks/typescript/common","title":"Common","description":"Every operation resolves to { data, request, response }. A successful JSON response is in data, except keyLogs, which returns CSV text. See error handling for failures.","sidebar":"sdks"},"sdks/typescript/endpoints/address-verify":{"id":"sdks/typescript/endpoints/address-verify","title":"addressVerify","description":"Verify Address","sidebar":"sdks"},"sdks/typescript/endpoints/create-config":{"id":"sdks/typescript/endpoints/create-config","title":"createConfig","description":"Create","sidebar":"sdks"},"sdks/typescript/endpoints/create-licensee":{"id":"sdks/typescript/endpoints/create-licensee","title":"createLicensee","description":"Create","sidebar":"sdks"},"sdks/typescript/endpoints/delete-config":{"id":"sdks/typescript/endpoints/delete-config","title":"deleteConfig","description":"Delete","sidebar":"sdks"},"sdks/typescript/endpoints/delete-licensee":{"id":"sdks/typescript/endpoints/delete-licensee","title":"deleteLicensee","description":"Cancel","sidebar":"sdks"},"sdks/typescript/endpoints/email-validation":{"id":"sdks/typescript/endpoints/email-validation","title":"emailValidation","description":"Email Validation","sidebar":"sdks"},"sdks/typescript/endpoints/find-address":{"id":"sdks/typescript/endpoints/find-address","title":"findAddress","description":"Find Address","sidebar":"sdks"},"sdks/typescript/endpoints/find-place":{"id":"sdks/typescript/endpoints/find-place","title":"findPlace","description":"Find Place","sidebar":"sdks"},"sdks/typescript/endpoints/index":{"id":"sdks/typescript/endpoints/index","title":"Endpoints","description":"Each API operation is one function. Operations are grouped by resource. Examples use the ak_test key and placeholder identifiers; replace them with your own before running.","sidebar":"sdks"},"sdks/typescript/endpoints/key-availability":{"id":"sdks/typescript/endpoints/key-availability","title":"keyAvailability","description":"Availability","sidebar":"sdks"},"sdks/typescript/endpoints/key-details":{"id":"sdks/typescript/endpoints/key-details","title":"keyDetails","description":"Details","sidebar":"sdks"},"sdks/typescript/endpoints/key-logs":{"id":"sdks/typescript/endpoints/key-logs","title":"keyLogs","description":"Logs (CSV)","sidebar":"sdks"},"sdks/typescript/endpoints/key-usage":{"id":"sdks/typescript/endpoints/key-usage","title":"keyUsage","description":"Usage Stats","sidebar":"sdks"},"sdks/typescript/endpoints/list-configs":{"id":"sdks/typescript/endpoints/list-configs","title":"listConfigs","description":"List","sidebar":"sdks"},"sdks/typescript/endpoints/list-licensees":{"id":"sdks/typescript/endpoints/list-licensees","title":"listLicensees","description":"List","sidebar":"sdks"},"sdks/typescript/endpoints/phone-number-validation":{"id":"sdks/typescript/endpoints/phone-number-validation","title":"phoneNumberValidation","description":"Phone Number Validation","sidebar":"sdks"},"sdks/typescript/endpoints/regenerate-licensee-key":{"id":"sdks/typescript/endpoints/regenerate-licensee-key","title":"regenerateLicenseeKey","description":"Regenerate Key","sidebar":"sdks"},"sdks/typescript/endpoints/resolve-place":{"id":"sdks/typescript/endpoints/resolve-place","title":"resolvePlace","description":"Resolve Place","sidebar":"sdks"},"sdks/typescript/endpoints/retrieve-address":{"id":"sdks/typescript/endpoints/retrieve-address","title":"retrieveAddress","description":"Retrieve Address","sidebar":"sdks"},"sdks/typescript/endpoints/retrieve-config":{"id":"sdks/typescript/endpoints/retrieve-config","title":"retrieveConfig","description":"Retrieve","sidebar":"sdks"},"sdks/typescript/endpoints/retrieve-licensee":{"id":"sdks/typescript/endpoints/retrieve-licensee","title":"retrieveLicensee","description":"Retrieve","sidebar":"sdks"},"sdks/typescript/endpoints/update-config":{"id":"sdks/typescript/endpoints/update-config","title":"updateConfig","description":"Update","sidebar":"sdks"},"sdks/typescript/endpoints/update-key-details":{"id":"sdks/typescript/endpoints/update-key-details","title":"updateKeyDetails","description":"Update Details","sidebar":"sdks"},"sdks/typescript/endpoints/update-licensee":{"id":"sdks/typescript/endpoints/update-licensee","title":"updateLicensee","description":"Update","sidebar":"sdks"},"sdks/typescript/errors":{"id":"sdks/typescript/errors","title":"Error Handling","description":"Every operation rejects with ApiError, a subclass of Error, when the API returns an HTTP error.","sidebar":"sdks"},"sdks/typescript/filter-and-bias":{"id":"sdks/typescript/filter-and-bias","title":"Filter and Bias","description":"findAddress and autocomplete.find accept filters, which remove addresses that do not match, and bias terms, which rank matching addresses higher without remov
1ing the rest. Both apply within one country, chosen with context.","sidebar":"sdks"},"sdks/typescript/index":{"id":"sdks/typescript/index","title":"TypeScript SDK","description":"The AddressZen TypeScript SDK calls the AddressZen address API with typed functions over native fetch. It is @addresszen/sdk on npm and runs in browsers and Node.js 22 or later.","sidebar":"sdks"},"sdks/typescript/react":{"id":"sdks/typescript/react","title":"React and Preact","description":"To add address search to a form, use Address Lookup for React. It provides the interface and fills in your address fields.","sidebar":"sdks"},"sdks/typescript/setup":{"id":"sdks/typescript/setup","title":"Setup","description":"Install @addresszen/sdk and create a client with your API key. The SDK runs in browsers and Node.js 22 or later and uses the runtime\'s native fetch.","sidebar":"sdks"},"terms/term":{"id":"terms/term","title":"Term","description":"Term explanation"}}}}')}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.