NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
PostGrid Verify connects to a Nagent workspace with an API key. Once it is connected, agents can call 12 PostGrid Verify actions, such as "Get Autocomplete Previews", "Get International Autocomplete Previews" and "Get Lookup Info". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against PostGrid Verify, with input parameters and output schema.
POSTGRID_VERIFY_AUTOCOMPLETE_ADDRESSTool to autocomplete a partially specified US or Canada address. Retrieves complete verified address including full postal code. Uses 1 lookup per request.
Input parameters
Optional parameter to retrieve the completion result at a particular index.
Only return addresses within this postal/zip code.
Only return addresses from this city.
Only return addresses within this province/state.
Only return addresses within this country.
The partially written address to autocomplete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
POSTGRID_VERIFY_AUTOCOMPLETE_INTL_ADDRESSTool to retrieve complete verified international address data using an ID from the preview endpoint. Use when you have an address ID from the preview step and need the full address details.
Input parameters
The ID previously returned from the preview endpoint where the type is 'Address'. Used to retrieve the complete verified address data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
POSTGRID_VERIFY_GET_AUTOCOMPLETE_PREVIEWSTool to get previews of autocompleted US and Canadian addresses. Returns partial address data (line1, city, first 3 digits of postal code) without using any lookups. Use when you need quick autocomplete suggestions for address input.
Input parameters
The country you want to filter the results by. Use ISO 2-letter country code (e.g., 'US' or 'CA')
The partially written street address to get autocomplete suggestions for
If true, returns the prov (province/state) field instead of the pc (postal code) field in preview objects
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Maximum number of results to return
The language preference of the results (e.g., EN, FR, ES)
The city you want to filter the results by
The street you want to filter the results by
The partially written street address to autocomplete
The countries you want to filter the results by. Supply ISO country code or the country's name. Separate multiple codes by comma.
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.
The postal code or zip code you want to filter the results by
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The postal or ZIP code for which to retrieve city and state/province information
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The address you want to parse on a single line.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The address object containing details to find similar addresses for.
Include detailed address parsing in the response (streetName, streetType, streetDirection, streetNumber).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
POSTGRID_VERIFY_VERIFY_ADDRESSTool to verify and standardize a US or Canadian address. Supports both freeform addresses (single-line) and structured addresses (with separate line1, city, etc.). Use includeDetails=true for additional metadata or geocode=true for latitude/longitude.
Input parameters
City name. Used with structured addresses.
First line of the address. Use for structured addresses. Either 'address' or 'line1' must be provided.
Second line of the address (optional). Only used with structured addresses.
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.
ISO 2-letter country code (US or CA). Used with structured addresses.
If true, include geocoding data (latitude/longitude) in the response. Uses an additional lookup credit.
ZIP or postal code. Used with structured addresses.
If true, include additional address details in the response. Default is false.
State or province code (e.g., 'CA', 'ON'). Used with structured addresses.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
POSTGRID_VERIFY_VERIFY_BATCH_ADDRESSESTool to verify up to 2000 US and Canada addresses in a single API call. Accepts both freeform address strings and structured address objects. Each address uses 1 lookup credit.
Input parameters
If true and your account has geocoding enabled, provides geolocation info (latitude/longitude).
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.
If true, returns the address in proper mixed case instead of uppercase.
If true, provides additional details about the address (street name, type, county, etc).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
POSTGRID_VERIFY_VERIFY_INTERNATIONAL_ADDRESSTool to verify and standardize international addresses from 245+ countries. Supports both structured and freeform address inputs. Use includeDetails=true for match levels and geoData=true for coordinates.
Input parameters
The freeform international address to verify, written on a single line. Can include country, city, street, and postal code.
If true, includes geolocation information (latitude, longitude) and accuracy data for the verified address.
If true, provides additional details about the verified address including parsing and verification match levels.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
POSTGRID_VERIFY_VERIFY_INTL_ADDRESSES_BATCHTool to verify up to 2000 international addresses in a single API call. Accepts both freeform address strings and structured address objects. Uses 1 lookup per address.
Input parameters
If true, include geolocation information (latitude, longitude, accuracy) in the response.
List of up to 2000 addresses to verify. Each address can be either a freeform string or a structured address object with individual components.
If true, provide additional details about each verified address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 PostGrid Verify actions on Nagent, including "Get Autocomplete Previews", "Get International Autocomplete Previews" and "Get Lookup Info". Get Autocomplete Previews: Get previews of autocompleted US and Canadian addresses. Each action is listed on this page with its input parameters and its output.
PostGrid Verify connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It also takes 3 optional inputs: countryFilter, partialStreet and provInsteadOfPC. It returns data, error and successful.