v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Standard API

Returns address completion previews for a partial street address, suitable for populating an autocomplete dropdown without consuming a lookup per keystroke.

Each result contains a partial address preview (street, city, and — for non-US addresses — only the first 3 digits of the postal code, to avoid revealing the full code before a lookup is charged).

  • Does not consume a lookup.
  • Use POST /completions to resolve a full address once the user selects a result.
get/v1/addver/completions

Query parameters

partialStreetstring required
cityFilterstring
stateFilterstring
pcFilterstring
countryFilterstring
properCaseboolean
verifiedOnlyboolean
filterExactboolean
limitinteger
provInsteadOfPCboolean

Response

The request has succeeded.

status'success' | 'error' required
messagestring required