> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PostGrid Verify

> PostGrid Verify is an API that allows you to autocomplete, verify, and standardize addresses in real-time, supporting both individual and batch address verification.

![PostGrid Verify logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/postgrid_verify.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=d5abb6b36f6b5065b546b1391a8b502e)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `POSTGRID_VERIFY`
* **Version:** 20261101\_00

## Tools

> [accordion] Autocomplete Address
>
> **Slug:** `POSTGRID_VERIFY_AUTOCOMPLETE_ADDRESS`
>
> Autocomplete a partial US or Canadian address, optionally selecting a candidate by index. Returns completed address candidates and uses one lookup per request.
>
> #### Input Parameters
>
> **index** `string`
>
> Optional parameter to retrieve the completion result at a particular index.
>
> **pcFilter** `string`
>
> Only return addresses within this postal/zip code.
>
> **cityFilter** `string`
>
> Only return addresses from this city.
>
> **stateFilter** `string`
>
> Only return addresses within this province/state.
>
> **countryFilter** `string`
>
> Only return addresses within this country.
>
> **partialStreet** `string` *required*
>
> The partially written address to autocomplete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Autocomplete International Address
>
> **Slug:** `POSTGRID_VERIFY_AUTOCOMPLETE_INTL_ADDRESS`
>
> Resolve an international address preview ID into address details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID previously returned from the preview endpoint where the type is 'Address'. Used to retrieve the complete verified address data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Autocomplete Previews
>
> **Slug:** `POSTGRID_VERIFY_GET_AUTOCOMPLETE_PREVIEWS`
>
> Get 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
>
> **countryFilter** `string`
>
> The country you want to filter the results by. Use ISO 2-letter country code (e.g., 'US' or 'CA')
>
> **partialStreet** `string`
>
> The partially written street address to get autocomplete suggestions for
>
> **provInsteadOfPC** `boolean`
>
> If true, returns the prov (province/state) field instead of the pc (postal code) field in preview objects
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get International Autocomplete Previews
>
> **Slug:** `POSTGRID_VERIFY_GET_INTL_AUTOCOMPLETE_PREVIEWS`
>
> Tool 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
>
> **limit** `integer`
>
> Maximum number of results to return
>
> **language** `string`
>
> The language preference of the results (e.g., EN, FR, ES)
>
> **cityFilter** `string`
>
> The city you want to filter the results by
>
> **streetFilter** `string`
>
> The street you want to filter the results by
>
> **partialStreet** `string`
>
> The partially written street address to autocomplete
>
> **countriesFilter** `string`
>
> The countries you want to filter the results by. Supply ISO country code or the country's name. Separate multiple codes by comma.
>
> **disableIPBiasing** `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.
>
> **postalOrZipFilter** `string`
>
> The postal code or zip code you want to filter the results by
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lookup Info
>
> **Slug:** `POSTGRID_VERIFY_GET_LOOKUP_INFO`
>
> Tool 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup City and State from Postal Code
>
> **Slug:** `POSTGRID_VERIFY_LOOKUP_CITY_STATE_FROM_POSTAL`
>
> Tool 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
>
> **postalOrZip** `string` *required*
>
> The postal or ZIP code for which to retrieve city and state/province information
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Parse Address
>
> **Slug:** `POSTGRID_VERIFY_PARSE_ADDRESS`
>
> Tool 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
>
> **address** `string` *required*
>
> The address you want to parse on a single line.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Suggest Addresses
>
> **Slug:** `POSTGRID_VERIFY_SUGGEST_ADDRESSES`
>
> Tool 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
>
> **address** `object` *required*
>
> The address object containing details to find similar addresses for.
>
> **includeDetails** `string`
>
> Include detailed address parsing in the response (streetName, streetType, streetDirection, streetNumber).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Address
>
> **Slug:** `POSTGRID_VERIFY_VERIFY_ADDRESS`
>
> Verify 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
>
> **city** `string`
>
> City name. Used with structured addresses.
>
> **line1** `string`
>
> First line of the address. Use for structured addresses. Either 'address' or 'line1' must be provided.
>
> **line2** `string`
>
> Second line of the address (optional). Only used with structured addresses.
>
> **address** `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.
>
> **country** `string`
>
> ISO 2-letter country code (US or CA). Used with structured addresses.
>
> **geocode** `boolean`
>
> If true, include geocoding data (latitude/longitude) in the response. Uses an additional lookup credit.
>
> **postalOrZip** `string`
>
> ZIP or postal code. Used with structured addresses.
>
> **includeDetails** `boolean`
>
> If true, include additional address details in the response. Default is false.
>
> **provinceOrState** `string`
>
> State or province code (e.g., 'CA', 'ON'). Used with structured addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Verify Addresses with Mixed Format
>
> **Slug:** `POSTGRID_VERIFY_VERIFY_BATCH_ADDRESSES`
>
> Verify 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
>
> **geocode** `boolean`
>
> If true and your account has geocoding enabled, provides geolocation info (latitude/longitude).
>
> **addresses** `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.
>
> **properCase** `boolean`
>
> If true, returns the address in proper mixed case instead of uppercase.
>
> **includeDetails** `boolean`
>
> If true, provides additional details about the address (street name, type, county, etc).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify International Address
>
> **Slug:** `POSTGRID_VERIFY_VERIFY_INTERNATIONAL_ADDRESS`
>
> Verify 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
>
> **address** `string` *required*
>
> The freeform international address to verify, written on a single line. Can include country, city, street, and postal code.
>
> **geoData** `boolean`
>
> If true, includes geolocation information (latitude, longitude) and accuracy data for the verified address.
>
> **includeDetails** `boolean`
>
> If true, provides additional details about the verified address including parsing and verification match levels.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Verify International Addresses
>
> **Slug:** `POSTGRID_VERIFY_VERIFY_INTL_ADDRESSES_BATCH`
>
> Verify 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
>
> **geoData** `boolean`
>
> If true, include geolocation information (latitude, longitude, accuracy) in the response.
>
> **addresses** `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.
>
> **includeDetails** `boolean`
>
> If true, provide additional details about each verified address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
