standardapi_complete

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).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
boolean
boolean
boolean
boolean
boolean
boolean
integer
Body Params
string
required

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

string

Filter results to a specific city.

string

Filter results to a specific state or province abbreviation.

string

Filter results to a specific postal code prefix.

string

Filter results to a specific country code.

boolean

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json