1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[516],{1216(e,a,s){s.r(a),s.d(a,{assets:()=>l,contentTitle:()=>n,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api-home","title":"API Reference","description":"The AddressZen API powers global address autocomplete, US address verification, and contact-data validation.","source":"@site/docs/api-home.mdx","sourceDirName":".","slug":"/api","permalink":"/docs/api","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"id":"api-home","slug":"/api","title":"API Reference","sidebar_label":"Overview"},"sidebar":"openApiSidebar","next":{"title":"Introduction","permalink":"/docs/api/api-reference"}}');var d=s(5723),r=s(4056);const t={id:"api-home",slug:"/api",title:"API Reference",sidebar_label:"Overview"},n="API Reference",l={},c=[{value:"Address Lookup",id:"address-lookup",level:2},{value:"Suggest an Address",id:"suggest-an-address",level:3},{value:"Retrieve an Address",id:"retrieve-an-address",level:3},{value:"Address Verification",id:"address-verification",level:2},{value:"Verify Address",id:"verify-address",level:3},{value:"Key Management",id:"key-management",level:2},{value:"Availability",id:"availability",level:3},{value:"Details",id:"details",level:3},{value:"Update Details",id:"update-details",level:3},{value:"Usage Stats",id:"usage-stats",level:3},{value:"Logs (CSV)",id:"logs-csv",level:3},{value:"Data Services",id:"data-services",level:2},{value:"Phone Number Validation",id:"phone-number-validation",level:3},{value:"Email Validation",id:"email-validation",level:3}];function o(e){const a={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",...(0,r.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)("img",{className:"page-icon",src:"/img/icons/api.svg",alt:"",width:"64",height:"64"}),"\n",(0,d.jsx)(a.header,{children:(0,d.jsx)(a.h1,{id:"api-reference",children:"API Reference"})}),"\n",(0,d.jsxs)("div",{className:"api-hub",children:[(0,d.jsx)(a.p,{children:"The AddressZen API powers global address autocomplete, US address verification, and contact-data validation."}),(0,d.jsx)(a.p,{children:(0,d.jsx)(a.a,{href:"/docs/api/api-reference",children:"Authentication, rate limits, error handling, and versioning"})}),(0,d.jsx)(a.h2,{id:"address-lookup",children:"Address Lookup"}),(0,d.jsx)(a.p,{children:"Type-ahead address search runs in two steps. Suggest returns ranked candidates from a partial query as the user types. Retrieve fetches the full, structured address record once a candidate is selected."}),(0,d.jsxs)("div",{className:"api-hub-grid",children:[(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/find-address",children:[(0,d.jsx)(a.h3,{id:"suggest-an-address",children:"Suggest an Address"}),(0,d.jsx)(a.p,{children:"Autocomplete that returns ranked partial-address matches for a search query."})]}),(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/retrieve-address",children:[(0,d.jsx)(a.h3,{id:"retrieve-an-address",children:"Retrieve an Address"}),(0,d.jsx)(a.p,{children:"Fetch the structured, fully populated address record for a selected suggestion."})]})]}),(0,d.jsxs)(a.p,{children:["To skip the integration work, drop in the ",(0,d.jsx)(a.a,{href:"/docs/address-lookup",children:"Address Lookup library"}),": a hosted widget that handles input debouncing, suggestion rendering, keyboard navigation, and field population."]}),(0,d.jsx)(a.h2,{id:"address-verification",children:"Address Verification"}),(0,d.jsx)(a.p,{children:"Confirm that a given US address actually exists, has been formatted correctly, and is deliverable."}),(0,d.jsx)("div",{className:"api-hub-grid",children:(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/address-verify",children:[(0,d.jsx)(a.h3,{id:"verify-address",children:"Verify Address"}),(0,d.jsx)(a.p,{children:"Submit a candidate US address and receive a normalized, USPS-verified result with deliverability indicators."})]})}),(0,d.jsx)(a.h2,{id:"key-management",children:"Key Management"}),(0,d.jsx)(a.p,{children:"Inspect and manage API keys programmatically. Useful for client-side integrations that need to check key health or surface usage to end users."}),(0,d.jsxs)("div",{className:"api-hub-grid",children:[(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/key-availability",children:[(0,d.jsx)(a.h3,{id:"availability",children:"Availability"}),(0,d.jsx)(a.p,{children:"Check whether a key is active and has the balance and quota to issue lookups right now."})]}),(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/key-details",children:[(0,d.jsx)(a.h3,{id:"details",children:"Details"}),(0,d.jsx)(a.p,{children:"Retrieve a key's configuration: allowed URLs, daily caps, per-user limits."})]}),(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/update-key-details",children:[(0,d.jsx)(a.h3,{id:"update-details",children:"Update Details"}),(0,d.jsx)(a.p,{children:"Adjust a key's allowed URLs, caps, and other settings without rotating it."})]}),(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/key-usage",children:[(0,d.jsx)(a.h3,{id:"usage-stats",children:"Usage Stats"}),(0,d.jsx)(a.p,{children:"Query historical lookup volume for a key, broken down by day or licensee."})]}),(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/key-logs",children:[(0,d.jsx)(a.h3,{id:"logs-csv",children:"Logs (CSV)"}),(0,d.jsx)(a.p,{children:"Download a per-lookup audit trail for billing reconciliation or analytics."})]})]}),(0,d.jsx)(a.h2,{id:"data-services",children:"Data Services"}),(0,d.jsx)(a.p,{children:"Validate contact data alongside addresses to keep records clean at point of capture."}),(0,d.jsxs)("div",{className:"api-hub-grid",children:[(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/phone-number-validation",children:[(0,d.jsx)(a.h3,{id:"phone-number-validation",children:"Phone Number Validation"}),(0,d.jsx)(a.p,{children:"Verify that a phone number is well-formed and active, with line-type and country metadata."})]}),(0,d.jsxs)("a",{className:"api-hub-card",href:"/docs/api/email-validation",children:[(0,d.jsx)(a.h3,{id:"email-validation",children:"Email Validation"}),(0,d.jsx)(a.p,{children:"Check syntax, MX records, and deliverability for an email address."})]})]})]})]})}function h(e={}){const{wrapper:a}={...(0,r.R)(),...e.components};return a?(0,d.jsx)(a,{...e,children:(0,d.jsx)(o,{...e})}):o(e)}},4056(e,a,s){s.d(a,{R:()=>t,x:()=>n});var i=s(2155);const d={},r=i.createContext(d);function t(e){const a=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(a):{...a,...e}},[a,e])}function n(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:t(e.components),i.createElement(r.Provider,{value:a},e.children)}}}]);
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.