Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Enrichment
  3. Form shortening

Address autocomplete

Fetch enriched address suggestions. Requires a partial address.

To access this endpoint using an access token you’ll need to specify the /profile-enrichment.read scope.

GET
/enrichment/address
cURL 
1
2

curl -X GET "https://api.moov.io/enrichment/address" \
  -H "Authorization: Bearer {token}" \
200 401 403 404 429 500 504
The request completed successfully.
{
  "suggestions": [
    {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "entries": 0,
      "postalCode": "string",
      "stateOrProvince": "string"
    }
  ]
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Query parameters

search

string required
Partial or complete address to search.

maxResults

integer
Maximum number of results to return.

includeCities

string
Limits results to a list of given cities.

includeStates

string
Limits results to a list of given states.

includeZipcodes

string
Limits results to a list of given zipcodes.

excludeStates

string
Exclude list of states from results. No include pararmeters may be used with this parameter.

preferCities

string
Display results with the listed cities at the top.

preferStates

string
Display results with the listed states at the top.

preferZipcodes

string
Display results with the listed zipcodes at the top.

preferRatio

integer
Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.

preferGeolocation

string
If omitted or set to city, it uses the sender’s IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none, you may see addresses from areas you do not wish to see.

selected

string
Useful for narrowing results with addressLine2 suggestions such as Apt (denotes an apartment building with multiple residences).

source

string
Include results from alternate data sources. Allowed values are all (non-postal addresses), or postal (postal addresses only).

Response

application/json

suggestions

array required
Show child attributes

addressLine1

string

addressLine2

string

city

string

entries

integer
The number of units at an address. For example the number of apartments or businesses in a building.

postalCode

string

stateOrProvince

string