https://docs.addresszen.com/assets/js/1df93b7f.266d3753.js

1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[4583],{7569(s,e,a){a.r(e),a.d(e,{default:()=>ls});a(2155);var i=a(6067),d=a(851),r=a(9700);const n="main_iUjq",c="container_bfhl",l="eyebrow_kY3W",t="sectionHead_ZZjR",o="ital_tJWg",h="hero_aEcG",p="heroWash_T2nk",x="heroRing_vqAg",j="heroGrid_ibpR",m="heroTitle_qg2I",u="accent_TDbE",N="heroSub_yj39",f="heroCtas_rCrO",v="heroSearch_pBtb",g="kbd_GZzv",y="codeCard_rrxw",b="codeBar_zzIi",A="dot_K917",_="dotLive_OV2U",k="codeVerified__62y",w="tok_VKoJ",S="str_J25O",I="com_O8hx",P="sections_UOHN",G="sectionGrid_xUPf",z="sectionCard_xzNF",L="sectionIcon_X1mX",C="band_MwOW",R="bandAlt_PKpz",T="cardGrid_nYON",E="card_M5pr",O="cardLink_zKDM",U="badges_jbXY",V="badge__JoJ",D="howGrid_pxN1",B="steps_ROtT",J="step_BHwS",K="stepNum_dTvv",q="topicLabel_tKSY",M="topicGrid_hQBd",W="topicCard_tS98",F="cta__fRr",Y="ctaInner_ioGY";var H=a(5723);const Z=()=>(0,H.jsx)("svg",{className:x,viewBox:"0 0 600 600","aria-hidden":"true",children:(0,H.jsx)("circle",{cx:"300",cy:"300",r:"240",fill:"none",stroke:"var(--az-paper)",strokeWidth:"1.5",strokeDasharray:"1300 220",transform:"rotate(-244 300 300)"})}),X=()=>document.querySelector(".DocSearch-Button")?.click(),Q=()=>(0,H.jsxs)("header",{className:h,children:[(0,H.jsx)(Z,{}),(0,H.jsx)("div",{className:p}),(0,H.jsxs)("div",{className:(0,d.A)(j,c),children:[(0,H.jsxs)("div",{children:[(0,H.jsxs)("h1",{className:m,children:["Add address verification in"," ",(0,H.jsx)("span",{className:u,children:"a few lines"})]}),(0,H.jsx)("p",{className:N,children:"Integration guides, client libraries, and a complete REST API reference for US and international address lookup, autocomplete, and verification."}),(0,H.jsxs)("button",{type:"button",className:v,onClick:X,children:[(0,H.jsxs)("svg",{viewBox:"0 0 24 24",fill:"none",stroke:"currentColor",strokeWidth:"2",strokeLinecap:"round",strokeLinejoin:"round","aria-hidden":"true",style:{width:16,height:16,flex:"none"},children:[(0,H.jsx)("circle",{cx:"11",cy:"11",r:"7"}),(0,H.jsx)("line",{x1:"21",y1:"21",x2:"16.5",y2:"16.5"})]}),(0,H.jsx)("span",{children:"Search the docs"}),(0,H.jsx)("span",{className:g,children:"\u2318K"})]}),(0,H.jsxs)("div",{className:f,children:[(0,H.jsx)(i.A,{className:"button button--primary button--lg",to:"/docs/address-lookup",children:"Address Lookup Guide"}),(0,H.jsx)(i.A,{className:"button button--outline button--lg",to:"/docs/api",children:"Browse the API"})]})]}),(0,H.jsxs)("div",{className:y,children:[(0,H.jsxs)("div",{className:b,children:[(0,H.jsx)("span",{className:(0,d.A)(A,_)}),(0,H.jsx)("span",{className:A}),(0,H.jsx)("span",{className:A}),(0,H.jsx)("span",{style:{marginLeft:8},children:"index.js"}),(0,H.jsx)("span",{style:{marginLeft:"auto"},children:"JAVASCRIPT"})]}),(0,H.jsxs)("pre",{children:[(0,H.jsx)("div",{children:(0,H.jsx)("span",{className:I,children:"// Add autocomplete to any form"})}),(0,H.jsxs)("div",{children:[(0,H.jsx)("span",{className:w,children:"import"})," ","{ AddressLookup } ",(0,H.jsx)("span",{className:w,children:"from"})," ",(0,H.jsx)("span",{className:S,children:'"@addresszen/address-lookup"'}),";"]}),(0,H.jsx)("div",{children:"\xa0"}),(0,H.jsxs)("div",{children:["AddressLookup.",(0,H.jsx)("span",{className:w,children:"setup"}),"(","({"]}),(0,H.jsxs)("div",{children:["  apiKey: ",(0,H.jsx)("span",{className:S,children:'"ak_test"'}),","]}),(0,H.jsx)("div",{children:"  outputFields: {"}),(0,H.jsxs)("div",{children:["    line_1: ",(0,H.jsx)("span",{className:S,children:'"#line_1"'}),","]}),(0,H.jsxs)("div",{children:["    city:   ",(0,H.jsx)("span",{className:S,children:'"#city"'}),","]}),(0,H.jsxs)("div",{children:["    state:  ",(0,H.jsx)("span",{className:S,children:'"#state"'}),","]}),(0,H.jsxs)("div",{children:["    zip_plus_4_code: ",(0,H.jsx)("span",{className:S,children:'"#zip"'}),","]}),(0,H.jsx)("div",{children:"  },"}),(0,H.jsx)("div",{children:"});"})]}),(0,H.jsxs)("div",{className:k,children:[(0,H.jsx)("span",{children:"\u25c9"})," VERIFIED \xb7 DELIVERABLE \xb7 38MS"]})]})]})]}),$=[{title:"Guides",body:"Keys, billing, testing and account setup.",href:"/docs/guides",icon:"guides"},{title:"Address Lookup",body:"Autocomplete for any form, in a few lines.",href:"/docs/address-lookup",icon:"address-lookup"},{title:"Address Verification",body:"Validate and standardize US addresses.",href:"/docs/address-ver

1ification/getting-started",icon:"address-verification"},{title:"Data",body:"Every dataset and the fields it returns.",href:"/docs/data",icon:"data"},{title:"API",body:"Endpoints, parameters and responses.",href:"/docs/api",icon:"api"}],ss=()=>(0,H.jsx)("section",{className:P,children:(0,H.jsx)("div",{className:(0,d.A)(c,G),children:$.map(s=>(0,H.jsxs)(i.A,{className:z,to:s.href,children:[(0,H.jsx)("img",{className:L,src:`/img/icons/${s.icon}.svg`,alt:"",width:52,height:52}),(0,H.jsx)("h3",{children:s.title}),(0,H.jsx)("p",{children:s.body})]},s.href))})}),es=({title:s,body:e,href:a,cta:d,badges:r})=>(0,H.jsxs)("div",{className:E,children:[r&&(0,H.jsx)("div",{className:U,children:r.map(s=>(0,H.jsx)("span",{className:V,children:s},s))}),(0,H.jsx)("h3",{children:s}),(0,H.jsx)("p",{children:e}),(0,H.jsx)(i.A,{className:O,to:a,children:d})]}),as=()=>(0,H.jsx)("section",{className:C,children:(0,H.jsxs)("div",{className:c,children:[(0,H.jsxs)("div",{className:t,children:[(0,H.jsx)("span",{className:l,children:"Migration"}),(0,H.jsxs)("h2",{children:["Switching from ",(0,H.jsx)("span",{className:o,children:"Google?"})]}),(0,H.jsx)("p",{children:"You can do better than best-guess data. Pick the path that fits how you collect addresses."})]}),(0,H.jsxs)("div",{className:T,children:[(0,H.jsx)(es,{title:"Use Address Lookup",href:"/docs/address-lookup",cta:"Address Lookup Guide",body:"Add address autocomplete to your forms. Users type, see suggestions, and select \u2014 just like Google Places."}),(0,H.jsx)(es,{title:"Use Verification",href:"/docs/address-verification/getting-started",cta:"Verification Guide",body:"Verify and standardize complete addresses you already have. Perfect for cleaning databases or validating input."}),(0,H.jsx)(es,{title:"Migration Guide",href:"/docs/how-to-switch",cta:"Switch from Google",body:"Step-by-step instructions to replace Google Places Autocomplete. Minimal code changes required."})]})]})}),is=()=>(0,H.jsx)("section",{className:R,children:(0,H.jsxs)("div",{className:c,children:[(0,H.jsxs)("div",{className:t,children:[(0,H.jsx)("span",{className:l,children:"Type \u2192 Select \u2192 Result"}),(0,H.jsxs)("h2",{children:["How it ",(0,H.jsx)("span",{className:o,children:"works"})]})]}),(0,H.jsxs)("div",{className:D,children:[(0,H.jsxs)("div",{className:y,children:[(0,H.jsxs)("div",{className:b,children:[(0,H.jsx)("span",{className:(0,d.A)(A,_)}),(0,H.jsx)("span",{className:A}),(0,H.jsx)("span",{className:A}),(0,H.jsx)("span",{style:{marginLeft:8},children:"form.html"})]}),(0,H.jsxs)("pre",{children:[(0,H.jsx)("div",{children:(0,H.jsx)("span",{className:w,children:"<form>"})}),(0,H.jsxs)("div",{children:["  ",(0,H.jsx)("span",{className:w,children:"<label"})," for=",(0,H.jsx)("span",{className:S,children:'"line_1"'}),(0,H.jsx)("span",{className:w,children:">"}),"Address",(0,H.jsx)("span",{className:w,children:"</label>"})]}),(0,H.jsxs)("div",{children:["  ",(0,H.jsx)("span",{className:w,children:"<input"})," id=",(0,H.jsx)("span",{className:S,children:'"line_1"'})," ",(0,H.jsx)("span",{className:w,children:"/>"})]}),(0,H.jsxs)("div",{children:["  ",(0,H.jsx)("span",{className:w,children:"<input"})," id=",(0,H.jsx)("span",{className:S,children:'"city"'})," ",(0,H.jsx)("span",{className:w,children:"/>"})]}),(0,H.jsxs)("div",{children:["  ",(0,H.jsx)("span",{className:w,children:"<input"})," id=",(0,H.jsx)("span",{className:S,children:'"state"'})," ",(0,H.jsx)("span",{className:w,children:"/>"})]}),(0,H.jsxs)("div",{children:["  ",(0,H.jsx)("span",{className:w,children:"<input"})," id=",(0,H.jsx)("span",{className:S,children:'"zip"'})," ",(0,H.jsx)("span",{className:w,children:"/>"})]}),(0,H.jsx)("div",{children:(0,H.jsx)("span",{className:w,children:"</form>"})})]})]}),(0,H.jsxs)("div",{className:B,children:[(0,H.jsxs)("div",{className:J,children:[(0,H.jsx)("span",{className:K,children:"01"}),(0,H.jsxs)("div",{children:[(0,H.jsx)("h3",{children:"Build your form"}),(0,H.jsxs)("p",{children:["Give each address field a unique ",(0,H.jsx)("code",{children:"id"})," so lookup can map results into it."]})]})]}),(0,H.jsxs)("div",{className:J,children:[(0,H.jsx)("span",{className:K,children:"02"}),(0,H.jsxs)("div",{children:[(0,H.jsx)("h3",{children:"Initialize & map fields"}),(0,H.jsxs)("p",{children:["Call ",(0,H.jsx)("code",{children:"setup()"})," with your API key and map each output field to a form input by id."]})]})]}),(0,H.jsxs)("div",{className:J,children:[(0,H.jsx)("span",{className:K,children:"03"}),(0,H.jsxs)("div",{children:[(0,H.jsx)("h3",{children:"Users select an address"}),(0,H.jsx)("p",{children:"Suggestions appear as they type. On selection, every mapped field is populated automatically."})]})]})]})]})]})}),ds=()=>(0,H.jsx)("section",{className:C,children:(0,H.jsxs)("div",{className:c,children:[(0,H.jsx)("div",{className:t,children:(0,H.jsxs)("h2",{children:["Add address lookup to ",(0,H.jsx)("span",{className:o,children:"any form or system"})]})}),(0,H.jsxs)("div",{className:T,children:[(0,H.jsx)(es,{title:"Platform Integration",href:"/docs/integrations",cta:"All Integrations",badges:["

1Simple","Fast"],body:"Add address verification to an eCommerce site, CRM, or any other platform with little or no code."}),(0,H.jsx)(es,{title:"Drop-in JavaScript",href:"/docs/address-lookup",cta:"Address Lookup",badges:["Customizable","JS"],body:"Add our JavaScript libraries to bring address lookup to your forms in moments."}),(0,H.jsx)(es,{title:"API Access",href:"/docs/api",cta:"API Reference",badges:["Powerful","JSON API"],body:"Use our address APIs and client libraries to verify, search, and cleanse addresses across many use cases."})]})]})}),rs=[{label:"Popular Integrations",items:[{title:"Wix",body:"Get address validation working on Wix in minutes with our step-by-step guide.",href:"/docs/integrations/wix"},{title:"Gravity Forms",body:"Drop in our script and add address lookup to Gravity Forms fast.",href:"/docs/integrations/gravity-forms"},{title:"Ninja Forms",body:"Add address lookup to Ninja Forms with a single drop-in script.",href:"/docs/integrations/ninja-forms"}]},{label:"API Reference",items:[{title:"API Updates",body:"Changelogs highlighting new API features and expanded capabilities.",href:"/docs/changelog"},{title:"REST API Docs",body:"Authentication, versioning, error handling, and testing \u2014 all covered.",href:"/docs/api"},{title:"Testing",body:"Obtain test balances and keys for safe, efficient testing.",href:"/docs/guides/testing"}]},{label:"Account Settings",items:[{title:"API Keys",body:"Acquire, use, and manage your keys effectively for secure integration.",href:"/docs/guides/api-key"},{title:"Automated Top-up",body:"Enable auto top-ups to keep services running without interruption.",href:"/docs/guides/automated-topups"},{title:"Key Security",body:"Set request limits and daily caps to keep your usage safe.",href:"/docs/guides/api-key-secure"}]}],ns=()=>(0,H.jsx)("section",{className:R,children:(0,H.jsxs)("div",{className:c,children:[(0,H.jsx)("div",{className:t,children:(0,H.jsxs)("h2",{children:[(0,H.jsx)("span",{className:o,children:"Most popular"})," topics"]})}),rs.map(s=>(0,H.jsxs)("div",{children:[(0,H.jsx)("div",{className:q,children:s.label}),(0,H.jsx)("div",{className:M,children:s.items.map(s=>(0,H.jsxs)(i.A,{className:W,to:s.href,children:[(0,H.jsx)("h4",{children:s.title}),(0,H.jsx)("p",{children:s.body})]},s.title))})]},s.label))]})}),cs=()=>(0,H.jsxs)("section",{className:F,children:[(0,H.jsx)(Z,{}),(0,H.jsxs)("div",{className:Y,children:[(0,H.jsxs)("h2",{children:["Stuck? ",(0,H.jsx)("span",{className:u,children:"We're here."})]}),(0,H.jsx)("p",{children:"Reach out any time. Our team helps you go from first request to verified addresses fast."}),(0,H.jsx)(i.A,{className:"button button--primary button--lg",to:"https://addresszen.com/support",children:"Contact Support"})]})]});function ls(){return(0,H.jsx)(r.A,{title:"Address Verification API - Address Autocomplete API | Documentation | AddressZen",description:"Set up Address Lookup with our simple integration guides, references and API libraries",children:(0,H.jsxs)("main",{className:n,children:[(0,H.jsx)(Q,{}),(0,H.jsx)(ss,{}),(0,H.jsx)(as,{}),(0,H.jsx)(is,{}),(0,H.jsx)(ds,{}),(0,H.jsx)(ns,{}),(0,H.jsx)(cs,{})]})})}}}]);