Skip to main content
PostGrid Verify logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: POSTGRID_VERIFY
  • Version: 20261101_00

Tools

Slug: POSTGRID_VERIFY_AUTOCOMPLETE_ADDRESSAutocomplete a partial US or Canadian address, optionally selecting a candidate by index. Returns completed address candidates and uses one lookup per request.

Input Parameters

string
Optional parameter to retrieve the completion result at a particular index.
string
Only return addresses within this postal/zip code.
string
Only return addresses from this city.
string
Only return addresses within this province/state.
string
Only return addresses within this country.
string
required
The partially written address to autocomplete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_AUTOCOMPLETE_INTL_ADDRESSResolve an international address preview ID into address details.

Input Parameters

string
required
The ID previously returned from the preview endpoint where the type is ‘Address’. Used to retrieve the complete verified address data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_GET_AUTOCOMPLETE_PREVIEWSGet autocomplete previews for US and Canadian addresses without using lookups. Previews may include street and city, a postal code, or a province/state instead of the postal code.

Input Parameters

string
The country you want to filter the results by. Use ISO 2-letter country code (e.g., ‘US’ or ‘CA’)
string
The partially written street address to get autocomplete suggestions for
boolean
If true, returns the prov (province/state) field instead of the pc (postal code) field in preview objects

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_GET_INTL_AUTOCOMPLETE_PREVIEWSTool to get previews of autocompleted international addresses. Results are biased based on your current IP address unless disabled. Returns both ‘Address’ and ‘BuildingNumber’ types - if type is ‘Address’, its id can be used in POST /completions; if ‘BuildingNumber’, use the container id with advanced previews.

Input Parameters

integer
Maximum number of results to return
string
The language preference of the results (e.g., EN, FR, ES)
string
The city you want to filter the results by
string
The street you want to filter the results by
string
The partially written street address to autocomplete
string
The countries you want to filter the results by. Supply ISO country code or the country’s name. Separate multiple codes by comma.
boolean
Disables the IP of the request from being used as a starting point for the search. By default, results are biased based on your current IP address.
string
The postal code or zip code you want to filter the results by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_GET_LOOKUP_INFOTool to retrieve lookup usage information for your PostGrid account. Use when you need to check how many lookups you have used and your free lookup limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_LOOKUP_CITY_STATE_FROM_POSTALTool to lookup city and state for a given postal or ZIP code. Use when you need valid city/state combinations for a postal code.

Input Parameters

string
required
The postal or ZIP code for which to retrieve city and state/province information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_PARSE_ADDRESSTool to break an address apart into its components. Use when you need to extract individual address parts like street number, road, city, state, and postal code from a single-line address string.

Input Parameters

string
required
The address you want to parse on a single line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_SUGGEST_ADDRESSESTool to find addresses similar to the given address. If the address can be verified or corrected, the first element will contain the verified address. Returns unit number ranges in line1 of suggested addresses. Use when you need address suggestions or corrections for US or Canadian addresses.

Input Parameters

object
required
The address object containing details to find similar addresses for.
string
Include detailed address parsing in the response (streetName, streetType, streetDirection, streetNumber).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_VERIFY_ADDRESSVerify and standardize a US or Canadian address supplied as a single-line freeform address. You can request additional address details or geocoding; geocoding requires enablement and generally uses an additional lookup.

Input Parameters

string
City name. Used with structured addresses.
string
First line of the address. Use for structured addresses. Either ‘address’ or ‘line1’ must be provided.
string
Second line of the address (optional). Only used with structured addresses.
string
Freeform address written on a single line (e.g., ‘22-20 bay st, floor 11, toronto, on’). Use this for unstructured addresses. Either ‘address’ or ‘line1’ must be provided.
string
ISO 2-letter country code (US or CA). Used with structured addresses.
boolean
If true, include geocoding data (latitude/longitude) in the response. Uses an additional lookup credit.
string
ZIP or postal code. Used with structured addresses.
boolean
If true, include additional address details in the response. Default is false.
string
State or province code (e.g., ‘CA’, ‘ON’). Used with structured addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_VERIFY_BATCH_ADDRESSESVerify up to 2,000 US or Canadian addresses in one request, using freeform strings or structured objects. Requires a secret key and uses one lookup per address plus another if geocoding; individual error messages are not exposed.

Input Parameters

boolean
If true and your account has geocoding enabled, provides geolocation info (latitude/longitude).
array
required
List of addresses to verify. Each address can be either a freeform string or a structured object with fields (line1, city, etc). Maximum 2000 addresses per batch.
boolean
If true, returns the address in proper mixed case instead of uppercase.
boolean
If true, provides additional details about the address (street name, type, county, etc).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_VERIFY_INTERNATIONAL_ADDRESSVerify and standardize a freeform international address. Optional details and geographic data can be requested, and the response includes a verification summary when available.

Input Parameters

string
required
The freeform international address to verify, written on a single line. Can include country, city, street, and postal code.
boolean
If true, includes geolocation information (latitude, longitude) and accuracy data for the verified address.
boolean
If true, provides additional details about the verified address including parsing and verification match levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTGRID_VERIFY_VERIFY_INTL_ADDRESSES_BATCHVerify up to 2,000 international addresses in a single batch, using freeform strings or structured address objects. Requires a secret API key and uses one lookup per address; results may include verified addresses or individual errors.

Input Parameters

boolean
If true, include geolocation information (latitude, longitude, accuracy) in the response.
array
required
List of up to 2000 addresses to verify. Each address can be either a freeform string or a structured address object with individual components.
boolean
If true, provide additional details about each verified address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not