Sign in
Standard API

Resolves a partial street address into a list of full address candidates, optionally selecting a specific candidate by index and verifying it.

Basic usage — omit index: returns an array of CompletedAddressItem results for the given partialStreet.

With index — specify index to resolve a single candidate. Returns a single CompletedAddressItem.

With index + verify=true — additionally runs the selected address through the USPS/Canada Post verifier and returns a StandardVerifiedAddress.

  • Uses 1 lookup per call (plus 1 more if geocoding a result).
post/v1/addver/completions

Query parameters

indexinteger
verifyboolean
properCaseboolean
geocodeboolean
includeDetailsboolean
verifiedOnlyboolean
filterExactboolean
limitinteger

Request body

partialStreetstring required

The partial street address to complete (e.g. "22 Bay").

cityFilterstring

Filter results to a specific city.

stateFilterstring

Filter results to a specific state or province abbreviation.

pcFilterstring

Filter results to a specific postal code prefix.

countryFilterstring

Filter results to a specific country code.

verifiedOnlyboolean

If true, only return addresses that passed USPS/Canada Post verification.

Response

The request has succeeded.

status'success' | 'error' required
messagestring required

Changes

Changed in 1 of the 7 revisions of this API.1