{"info":{"_postman_id":"292b885f-33cb-46fb-8c82-0d30427d8dc1","name":"PostGrid Verify: International Address Verification & Validation API","description":"

Allows you to autocomplete, verify, and standardize international addresses in real-time.
It also offers batch verification which allows you to do the same for thousands of addresses per second.

You can access the platform here where you can also bulk verify lists without having to use the API.

Note that you can supply JSON data instead of urlencoded data for all endpoints

Authorization

You can authorize your HTTP requests by setting the x-api-key HTTP header to your API key.

API Keys

You can create an API key by accessing the Developers section of the platform. There, you can click \"Create new access key\" and select the type of key you want. For batch verification, you must use a secret key.

Integration

If you're looking to install autocomplete and verification on a website, you can access the Developers section of the dashboard, create a public key, and then click on the API key name. This will show you a guide for installing our pre-built integration on your website without having to access the API directly.

Otherwise, you can use the endpoints documented below to create a completely custom integration.

Integrating Autocomplete

We provide a pre-built web-based autocomplete integration in the Developers section of the dashboard. However, if you want to integrate autocomplete manually, here are our recommended steps:

Use the GET /completions endpoint and supply partialStreet via the query params
\n
- This endpoint does not use any lookups
\n
Allow the user to select one of the autocompleted international address previews
\n
If the selected type is 'Address'. Make a POST /completions request with request body 'id' which its value comes from the 'id' field of the selected preview.
\n
If the selected type is not 'Address'. Use the GET /completions endpoint again but this time supplies 'container' which its value comes from the 'id' of the selected preview as query param. In addition, supply query param advanced=true. Then proceed to step 2 again.
\n

Response

The top-level JSON response has the following structure:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
status	string	Either `success` or `error`
message	string	Describes the result of the request
data	object or array	The response data.

Address Details

You can request additional address details when using the verification endpoints (both batch and single address) by supplying a query parameter includeDetails=true.

The details have the following schema:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
organization	string or null	Name of the company or organization where the address is located
building	string or null	Name of the building where the address is located
subBuilding	string or null	Name of the sub building where the address is located
premise	string or null	Premise number where the address is located
postBox	string or null	Postal box number where the address is located
telephone	string or null	Telephone number registered where the address is located

Note that the details will be returned in a 'details' subobject and only the relevant fields for a given address will be returned. The fields that are empty will not.

Proper Case

You can have the verification and suggestion endpoints return addresses in Proper Case (e.g. 22-20 Bay St) by supplying a query parameter properCase=true.

Geographical Data

You can request additional geographical details when using the verification endpoints (both batch and single address) by supplying a query parameter geoData=true.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
latitude	string or null	The latitude of the resulting address
longitude	string or null	The longitude of the resulting address
geoAccuracy	string or null	The accuracy of the geographical information of the resulting address

Summary of Verification

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
verificationStatus	string or null	The status of the verification. See Verification Status
postProcessedVerificationMatchLevel	string or null	The level to which the input data matches the available reference data once all changes and additions performed during the verification process have been taken into account.See Verification Match Level
preProcessedVerificationMatchLevel	string or null	The level to which the input data matches the available reference data prior to any changes or additions performed during the verification process.See Verification Match Level
parsingStatus	string or null	Either 'identified_and_parsed' or 'unable_to_parse'
lexiconIdentificationMatchLevel	string or null	The level to which the output data has some recognized form, through the use of pattern matching and lexicon matching.See Verification Match Level
contextIdentificationMatchLevel	string or null	The level to which the output data can be recognized based on the context in which it appears.See Verification Match Level
postCodeStatus	string or null	The status about postal code.See PostalCode Status
matchScore	number	Indicates how much the input data has been changed during the verification process in order to achieve the post-processed verification match level

Verification Status

verified
A complete match was made between the input data and a single record from the available reference data
\n
partially_verified
A partial match was made between the input data and a single record from the available reference data
\n
unverified
Unable to verify. The output fields will contain the input data|
\n
ambiguous
More than one close reference data match
\n
conflict
More than one close reference data match with conflicting values
\n
reverted
Record could not be verified to the specified minimum acceptable level. The output fields will contain the input data
\n

Verification Match Level

Delivery Point (PostBox or SubBuilding)
\n
Premise (Premise or Building)
\n
Thoroughfare (Street or Road)
\n
Locality (City)
\n
AdministrativeArea (Province or State)
\n
None
\n

Postcode Status

postal_code_primary_and_postal_code_secondary_verified
\n
postal_code_primary_verified, postal_code_secondary_added_or_changed
\n
postal_code_primary_verified
\n
postal_code_primary_verified_with_small_change
\n
postal_code_primary_verified_with_large_change
\n
postal_code_primary_added
\n
postal_code_primary_identified_by_lexicon
\n
postal_code_primary_identified_by_context
\n
postal_code_primary_empty
\n

Verification

This is the data returned from the international verification endpoints. The batch verification endpoint returns an array of these. The final status of each result is stored inside the verificationStatus property of the summary field. See Verification Status. In addition, the summary field provides other information regarding the quality of each verification. See Summary of Verification

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
formattedAddress	string	The complete address including all details
line1	string	The first line of the resulting address
line2	string or null	The second line of the resulting address
line3	string or null	The third line of the resulting address
line4	string or null	The fourth line of the resulting address
city	string or null	The city of the resulting address
provinceOrState	string or null	The province or state of the resulting address
postalOrZip	string or null	The Postal/ZIP code of the resulting address
country	string or null	The country of the resulting address
summary	Summary of Verification or null	Contains accuracy information of the verification (see below for details)
geoData	Geographical Data or null	Contains geographic information (see below for details)
details	Address Details or null	Detailed information about the address (see below for details)
errors	string or null	The address errors that were fixed or caused verification failure

Completion Preview

This is the data returned from the GET completion endpoint (i.e. the preview endpoint). Each element of the returned array follows this schema.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	string	The ID of the autocompleted address
type	string	Either 'Address', 'Container' or 'BuildingNumber'
text	string	The name of the autocompleted address
highlight	string	A list of number ranges identifying the matched characters in the Text and Description
description	string or undefined	Descriptive information about the result

Autocompleted Address

This is the data returned from the POST completions endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
formattedAddress	string	The complete address including all details
line1	string	The first line of the resulting address
line2	string or null	The second line of the resulting address
line3	string or null	The third line of the resulting address
line4	string or null	The fourth line of the resulting address
city	string or null	The city of the resulting address
provinceOrState	string or null	The province or state of the resulting address
postalOrZip	string or null	The Postal/ZIP code of the resulting address
country	string or null	The country of the resulting address
building	string or null	Name of the building where the address is located
department	string or null	Name of the department where the address is located
company	string or null	Name of the company where the address is located
errors	string or null	The address errors that were fixed or caused verification failure

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authorization","slug":"authorization"},{"content":"API Keys","slug":"api-keys"},{"content":"Integration","slug":"integration"},{"content":"Integrating Autocomplete","slug":"integrating-autocomplete"},{"content":"Response","slug":"response"},{"content":"Address Details","slug":"address-details"},{"content":"Proper Case","slug":"proper-case"},{"content":"Geographical Data","slug":"geographical-data"},{"content":"Summary of Verification","slug":"summary-of-verification"},{"content":"Verification","slug":"verification"},{"content":"Completion Preview","slug":"completion-preview"},{"content":"Autocompleted Address","slug":"autocompleted-address"}],"owner":"17207010","collectionId":"292b885f-33cb-46fb-8c82-0d30427d8dc1","publishedId":"UVXona2n","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2d69ff"},"publishDate":"2025-07-11T20:05:14.000Z"},"item":[{"name":"Intl Address Verification","item":[{"name":"Verify a Freeform Address","id":"7b43b14c-2d33-4650-bfa2-e33e142ec26f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"address","value":"PostGrid, 90 canal st boston, us","description":"

The address you want to verify, written on a single line.

\n","type":"text"}]},"url":"https://api.postgrid.com/v1/intl_addver/verifications?includeDetails=true","description":"

Verify, standardize, and correct an international address written on a single line.

\n","urlObject":{"protocol":"https","path":["v1","intl_addver","verifications"],"host":["api","postgrid","com"],"query":[{"disabled":true,"description":{"content":"

If this is 'true', we include geolocation information (latitude, longitude) and acurracy.

\n","type":"text/plain"},"key":"geoData","value":"true"},{"description":{"content":"

If this is 'true', we provide additional details about the verified address. See details.

\n","type":"text/plain"},"key":"includeDetails","value":"true"}],"variable":[]}},"response":[{"id":"98953e7e-65c7-4ca2-8e66-403c71d011ab","name":"Verify a Freeform Address","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"address","value":"31 Fl Scarborough CA","description":"The address you want to verify, written on a single line.","type":"text"}]},"url":{"raw":"https://api.postgrid.com/v1/intl_addver/verifications?geoData=true&includeDetails=true&properCase=true","protocol":"https","host":["api","postgrid","com"],"path":["v1","intl_addver","verifications"],"query":[{"key":"geoData","value":"true","description":"If this is 'true', we include geolocation information (latitude, longitude) and acurracy."},{"key":"includeDetails","value":"true","description":"If this is 'true', we provide additional details about the verified address. See details."},{"key":"properCase","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Mon, 29 Mar 2021 22:33:09 GMT"},{"key":"X-RateLimit-Reset","value":"1617057250"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"670"},{"key":"ETag","value":"W/\"29e-xMRm8tIKwT4nEPNP4JlIROM/YbQ\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"International address verified successfully.\",\n \"data\": {\n \"city\": \"Scarborough\",\n \"country\": \"CA\",\n \"details\": {\n \"premise\": \"31\"\n },\n \"formattedAddress\": \"31 Fl,scarborough On\",\n \"geoData\": {\n \"latitude\": \"43.761961\",\n \"longitude\": \"-79.245693\",\n \"geoAccuracy\": \"A2\"\n },\n \"line1\": \"31 Fl\",\n \"line2\": \"Scarborough On\",\n \"provinceOrState\": \"ON\",\n \"summary\": {\n \"verificationStatus\": \"partially_verified\",\n \"postProcessedVerificationMatchLevel\": \"city\",\n \"preProcessedVerificationMatchLevel\": \"city\",\n \"parsingStatus\": \"unable_to_parse\",\n \"lexiconIdentificationMatchLevel\": \"city\",\n \"contextIdentificationMatchLevel\": \"premise_or_building\",\n \"postCodeStatus\": \"postal_code_primary_empty\",\n \"matchScore\": 100\n }\n }\n}"}],"_postman_id":"7b43b14c-2d33-4650-bfa2-e33e142ec26f"},{"name":"Verify a Structured Address","id":"b329cf55-0766-4e0c-8615-cdec4117c098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"address[line1]","value":"THE CROWN, 304 LIVERPOOL ROAD,Birkdale\n","type":"text","description":"

The first line of your address.

\n"},{"key":"address[city]","value":"London","type":"text","description":"

The city of the address.

\n"},{"key":"address[postalOrZip]","value":"SW11 7US","type":"text","description":"

The postal code of your address.

\n"},{"key":"address[country]","value":"United Kingdom","type":"text","description":"

The country of your address.

\n"}]},"url":"https://api.postgrid.com/v1/intl_addver/verifications?geoData=false&includeDetails=true","description":"

Verify and standardize a single international address which is already structured into Line 1, Line 2, City, etc. All parameters except line1 are optional.

If you supply geoData=true as a query parameter, we will also populate an additional geoData field that follows the Geographical Data schema.

If you supply includeDetails=true as a query parameter, we will also populate an additional details field that follows the Address Details schema.

\n","urlObject":{"protocol":"https","path":["v1","intl_addver","verifications"],"host":["api","postgrid","com"],"query":[{"description":{"content":"

If this is 'true', we include geolocation information (latitude, longitude) and acurracy.

\n","type":"text/plain"},"key":"geoData","value":"false"},{"description":{"content":"

If this is 'true', we provide additional details about the verified address. See details.

\n","type":"text/plain"},"key":"includeDetails","value":"true"}],"variable":[]}},"response":[{"id":"6dfb5ef3-c286-4a98-b46c-258880c54165","name":"Verify a Structured Address","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"address[line1]","value":"Hockenheimerstr 43","description":"The first line of your address.","type":"text"},{"key":"address[line2]","value":"Reilingen","description":"The second line of your address.","type":"text"},{"key":"address[line3]","value":"Baden Wurtemberg","description":"The third line of your address.","type":"text"},{"key":"address[line4]","value":"","description":"The fourth line of your address.","type":"text"},{"key":"address[city]","value":"","description":"The city of your address.","type":"text"},{"key":"address[provinceOrState]","value":"Baden-Württemberg","description":"The province or state of your address.","type":"text"},{"key":"address[postalOrZip]","value":"68799","description":"The postal code of your address","type":"text"},{"key":"address[country]","value":"DEU","description":"The country of your address. Supply an ISO country code.","type":"text"}]},"url":{"raw":"https://api.postgrid.com/v1/intl_addver/verifications?geoData=true&includeDetails=true&properCase=true","protocol":"https","host":["api","postgrid","com"],"path":["v1","intl_addver","verifications"],"query":[{"key":"geoData","value":"true","description":"If this is 'true', we include geolocation information (latitude, longitude) and acurracy."},{"key":"includeDetails","value":"true","description":"If this is 'true', we provide additional details about the verified address. See details."},{"key":"properCase","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"Date","value":"Mon, 29 Mar 2021 22:33:35 GMT"},{"key":"X-RateLimit-Reset","value":"1617057250"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"875"},{"key":"ETag","value":"W/\"36b-eRhsmdkdWzatMN3gV+gglt219NQ\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"International address verified successfully.\",\n \"data\": {\n \"city\": \"Reilingen\",\n \"country\": \"DE\",\n \"details\": {\n \"building\": \"Reilingen Baden Wurtemberg\",\n \"premise\": \"43\"\n },\n \"formattedAddress\": \"Reilingen Baden Wurtemberg,hockenheimer Str. 43,68799 Reilingen\",\n \"geoData\": {\n \"latitude\": \"49.297010\",\n \"longitude\": \"8.571100\",\n \"geoAccuracy\": \"P4\"\n },\n \"line1\": \"Reilingen Baden Wurtemberg\",\n \"line2\": \"Hockenheimer Str. 43\",\n \"line3\": \"68799 Reilingen\",\n \"postalOrZip\": \"68799\",\n \"provinceOrState\": \"Baden-Württemberg\",\n \"summary\": {\n \"verificationStatus\": \"verified\",\n \"postProcessedVerificationMatchLevel\": \"premise_or_building\",\n \"preProcessedVerificationMatchLevel\": \"premise_or_building\",\n \"parsingStatus\": \"unable_to_parse\",\n \"lexiconIdentificationMatchLevel\": \"premise_or_building\",\n \"contextIdentificationMatchLevel\": \"premise_or_building\",\n \"postCodeStatus\": \"postal_code_primary_empty\",\n \"matchScore\": 100\n }\n }\n}"}],"_postman_id":"b329cf55-0766-4e0c-8615-cdec4117c098"},{"name":"Batch Verify Addresses","id":"e72923ac-5054-4b3b-a277-6f5c9be15e61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"addresses\": [\n \"1946 E 113th St, Los Angeles, CA 90059, USA\",\n {\n \"line1\": \"31\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"city\": \"\",\n \"provinceOrState\": \"\",\n \"postalOrZip\": \"M1K 3B3\",\n \"country\": \"CA\"\n },\n {\n \"line1\": \"Sageweg 27\",\n \"line2\": \"Neuenburg\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"city\": \"Baden-Württemberg\",\n \"provinceOrState\": \"\",\n \"postalOrZip\": \"79395\",\n \"country\": \"DEU\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.postgrid.com/v1/intl_addver/verifications/batch?geoData=true&includeDetails=true","description":"

Verify up to 2000 international addresses (both free-form and structured) with a single API call.

Note that valid addresses are either strings or objects containing the structured address fields (line1, line2, etc).

If your batch is larger than your free limit and you are not yet subscribed, the entire batch will fail to verify. You can send in a batch no larger than the remaining number of lookups in that case.

Uses 1 lookup per address provided.

\n","urlObject":{"protocol":"https","path":["v1","intl_addver","verifications","batch"],"host":["api","postgrid","com"],"query":[{"description":{"content":"

If this is 'true', we include geolocation information (latitude, longitude) and acurracy.

\n","type":"text/plain"},"key":"geoData","value":"true"},{"description":{"content":"

If this is 'true', we provide additional details about the verified address. See details.

\n","type":"text/plain"},"key":"includeDetails","value":"true"}],"variable":[]}},"response":[{"id":"75f9deef-a7d1-4d2b-b005-4e36e761ad71","name":"Batch Verify Addresses","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"addresses\": [\n \"1946 E 113th St, Los Angeles, CA 90059, USA\",\n {\n \"line1\": \"31\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"city\": \"\",\n \"provinceOrState\": \"\",\n \"postalOrZip\": \"M1K 3B3\",\n \"country\": \"CA\"\n },\n {\n \"line1\": \"Sageweg 27\",\n \"line2\": \"Neuenburg\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"city\": \"Baden-Württemberg\",\n \"provinceOrState\": \"\",\n \"postalOrZip\": \"79395\",\n \"country\": \"DEU\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.postgrid.com/v1/intl_addver/verifications/batch?geoData=true&includeDetails=true&properCase=true","protocol":"https","host":["api","postgrid","com"],"path":["v1","intl_addver","verifications","batch"],"query":[{"key":"geoData","value":"true"},{"key":"includeDetails","value":"true"},{"key":"properCase","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Mon, 29 Mar 2021 22:35:37 GMT"},{"key":"X-RateLimit-Reset","value":"1617057398"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2086"},{"key":"ETag","value":"W/\"826-ilEt751vjVItccNFo02C2XmIhgQ\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Verified international addresses batch successfully.\",\n \"data\": [\n {\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"details\": {\n \"premise\": \"1946\"\n },\n \"formattedAddress\": \"1946 E 113th St,los Angeles Ca 90059-2006\",\n \"geoData\": {\n \"latitude\": \"33.932350\",\n \"longitude\": \"-118.237410\",\n \"geoAccuracy\": \"P4\"\n },\n \"line1\": \"1946 E 113th St\",\n \"line2\": \"Los Angeles Ca 90059-2006\",\n \"postalOrZip\": \"90059-2006\",\n \"provinceOrState\": \"CA\",\n \"summary\": {\n \"verificationStatus\": \"verified\",\n \"postProcessedVerificationMatchLevel\": \"premise_or_building\",\n \"preProcessedVerificationMatchLevel\": \"premise_or_building\",\n \"parsingStatus\": \"unable_to_parse\",\n \"lexiconIdentificationMatchLevel\": \"premise_or_building\",\n \"contextIdentificationMatchLevel\": \"premise_or_building\",\n \"postCodeStatus\": \"postal_code_primary_empty\",\n \"matchScore\": 100\n }\n },\n {\n \"city\": \"Scarborough\",\n \"country\": \"CA\",\n \"details\": {},\n \"formattedAddress\": \"31,scarborough On M1k 3b3\",\n \"geoData\": {\n \"latitude\": \"43.761961\",\n \"longitude\": \"-79.245693\",\n \"geoAccuracy\": \"A2\"\n },\n \"line1\": \"31\",\n \"line2\": \"Scarborough On M1k 3b3\",\n \"postalOrZip\": \"M1K 3B3\",\n \"provinceOrState\": \"ON\",\n \"summary\": {\n \"verificationStatus\": \"partially_verified\",\n \"postProcessedVerificationMatchLevel\": \"city\",\n \"preProcessedVerificationMatchLevel\": \"city\",\n \"parsingStatus\": \"unable_to_parse\",\n \"lexiconIdentificationMatchLevel\": \"city\",\n \"contextIdentificationMatchLevel\": \"street_or_road\",\n \"postCodeStatus\": \"postal_code_primary_empty\",\n \"matchScore\": 100\n }\n },\n {\n \"city\": \"Neuenburg Am Rhein\",\n \"country\": \"DE\",\n \"details\": {\n \"premise\": \"27\"\n },\n \"formattedAddress\": \"Sägeweg 27,79395 Neuenburg Am Rhein\",\n \"geoData\": {\n \"latitude\": \"47.807820\",\n \"longitude\": \"7.569160\",\n \"geoAccuracy\": \"P4\"\n },\n \"line1\": \"Sägeweg 27\",\n \"line2\": \"79395 Neuenburg Am Rhein\",\n \"postalOrZip\": \"79395\",\n \"provinceOrState\": \"Baden-Württemberg\",\n \"summary\": {\n \"verificationStatus\": \"verified\",\n \"postProcessedVerificationMatchLevel\": \"premise_or_building\",\n \"preProcessedVerificationMatchLevel\": \"premise_or_building\",\n \"parsingStatus\": \"unable_to_parse\",\n \"lexiconIdentificationMatchLevel\": \"premise_or_building\",\n \"contextIdentificationMatchLevel\": \"premise_or_building\",\n \"postCodeStatus\": \"postal_code_primary_empty\",\n \"matchScore\": 100\n }\n }\n ]\n}"},{"id":"240dddc8-b1a7-4f49-a97a-ae48c4510bfa","name":"Batch Verify Addresses","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"addresses\": [\n \"22-20 bay st, toronto, ON\",\n {\n \"line1\": \"145 mulberry st ph d\",\n \"city\": \"new york\",\n \"provinceOrState\": \"new york\",\n \"postalOrZip\": \"10013\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/v1/addver/verifications/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 14 Oct 2020 17:33:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"472"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1d8-9uMPbYMtVsLBzHQ1s0ILGikJoZI\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Verified address batch successfully.\",\n \"data\": {\n \"results\": [\n {\n \"verifiedAddress\": {\n \"line1\": \"22-20 BAY ST\",\n \"city\": \"TORONTO\",\n \"postalOrZip\": \"M5J 2N8\",\n \"provinceOrState\": \"ON\",\n \"country\": \"ca\",\n \"status\": \"corrected\",\n \"errors\": {\n \"postalOrZip\": [\n \"Missing Value: Postal Code\"\n ]\n }\n }\n },\n {\n \"verifiedAddress\": {\n \"line1\": \"145 MULBERRY ST PH D\",\n \"city\": \"NEW YORK\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"NY\",\n \"country\": \"us\",\n \"zipPlus4\": \"5230\",\n \"status\": \"verified\",\n \"errors\": {}\n }\n }\n ]\n }\n}"}],"_postman_id":"e72923ac-5054-4b3b-a277-6f5c9be15e61"}],"id":"31f1120a-b3e1-4961-984a-1f21192cc1f0","description":"

These endpoints are for international address verifications. The endpoints support both single address verification and batch verifications. All endpoints support both free-form and structured input.

\n","_postman_id":"31f1120a-b3e1-4961-984a-1f21192cc1f0"},{"name":"Intl Address Autocomplete","item":[{"name":"Get Autocomplete Previews","id":"5794fe11-e507-4608-ad4f-e09108b72991","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"url":"https://api.postgrid.com/v1/intl_addver/completions?partialStreet=15&countriesFilter=United Kingdom&limit=4&language=EN","description":"

Get previews of autocompleted international addresses. The results are biased based on your current IP address. The results have both of type 'Address' and 'BuildingNumber'.\nIf the type is 'Address', its id can be used in autocomplete POST endpoint to retrieve the complete address. Otherwise, the id can be used as a 'container' to retrieve further information using the 'advanced' option described below.

\n","urlObject":{"protocol":"https","path":["v1","intl_addver","completions"],"host":["api","postgrid","com"],"query":[{"description":{"content":"

The partially written street address

\n","type":"text/plain"},"key":"partialStreet","value":"15"},{"description":{"content":"

The countries you want to filter the results by. Supply ISO country code or the country's name. Separate multiple codes by comma.

\n","type":"text/plain"},"key":"countriesFilter","value":"United Kingdom"},{"description":{"content":"

Maximum number of results

\n","type":"text/plain"},"key":"limit","value":"4"},{"description":{"content":"

The language preference of the results

\n","type":"text/plain"},"key":"language","value":"EN"},{"disabled":true,"description":{"content":"

The city you want to filter the results by

\n","type":"text/plain"},"key":"cityFilter","value":"London"},{"disabled":true,"description":{"content":"

The street you want to filter the results by

\n","type":"text/plain"},"key":"streetFilter","value":"Bridge Avenue"},{"disabled":true,"description":{"content":"

The postal code or zip code you want to filter the results by

\n","type":"text/plain"},"key":"postalOrZipFilter","value":"W7 3AR"}],"variable":[]}},"response":[{"id":"358d8ca1-24e0-4c46-962f-d5c7feb706c9","name":"Get Autocomplete Previews","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"url":{"raw":"https://api.postgrid.com/v1/intl_addver/completions?partialStreet=15&countriesFilter=United Kingdom&limit=4&language=EN&cityFilter=London&streetFilter=Bridge Avenue&postalOrZipFilter=W7 3AR","protocol":"https","host":["api","postgrid","com"],"path":["v1","intl_addver","completions"],"query":[{"key":"partialStreet","value":"15","description":"The partially written street address"},{"key":"countriesFilter","value":"United Kingdom","description":"The countries you want to filter the results by. Supply ISO country codes or the country's name. Separate multiple codes by comma."},{"key":"limit","value":"4","description":"Maximum number of results"},{"key":"language","value":"EN","description":"The language preference of the results"},{"key":"cityFilter","value":"London","description":"The city you want to filter the results by"},{"key":"streetFilter","value":"Bridge Avenue","description":"The street you want to filter the results by"},{"key":"postalOrZipFilter","value":"W7 3AR","description":"The postal code or zip code you want to filter the results by"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jan 2022 20:49:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"20f-myrZcGejHszuau30wLbK/Jegf8U\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=7HkyjT6Vcp8cVr51rWEyjKKKyn0BMp%2Fgw3SHMtnSfYjSMJ2sWqQzj3cym79a5LxpSLDevo3KWH%2BnL%2BLpYfrIohC8YKvTyYkxW4PuV9lY7W7Sll5FWHMrgDufzydvGQknxa9I\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6d1368467ef6c504-ORD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found international address completion previews successfully.\",\n \"data\": [\n {\n \"highlight\": \"0-2\",\n \"id\": \"GB|RM|A|25866657|ENG\",\n \"text\": \"152 Bridge Avenue London W7 3AR\",\n \"type\": \"Address\"\n },\n {\n \"highlight\": \"0-2\",\n \"id\": \"GB|RM|A|25866658|ENG\",\n \"text\": \"154 Bridge Avenue London W7 3AR\",\n \"type\": \"Address\"\n },\n {\n \"highlight\": \"0-2\",\n \"id\": \"GB|RM|A|25866659|ENG\",\n \"text\": \"156 Bridge Avenue London W7 3AR\",\n \"type\": \"Address\"\n },\n {\n \"highlight\": \"0-2\",\n \"id\": \"GB|RM|A|25866660|ENG\",\n \"text\": \"158 Bridge Avenue London W7 3AR\",\n \"type\": \"Address\"\n }\n ]\n}"}],"_postman_id":"5794fe11-e507-4608-ad4f-e09108b72991"},{"name":"Get Autocomplete Advanced Previews","id":"77398363-5803-4e24-bab2-c2d2aaa8f643","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"url":"https://api.postgrid.com/v1/intl_addver/completions?container=US|US|ENG|13021-NY-AUBURN--ST-GENESEE-E-15&language=EN&advanced=true","description":"

Search for further information given a \"container\" which is the \"id\" field received from the preview endpoint in which the preview's type is not \"Address\" (eg. 'BuildingNumber'). The advanced=true query param must be supplied

\n","urlObject":{"protocol":"https","path":["v1","intl_addver","completions"],"host":["api","postgrid","com"],"query":[{"description":{"content":"

A container for the search. This should only be another Id previously returned from this endpoint when the \"type\" of the result was not 'Address'.

\n","type":"text/plain"},"key":"container","value":"US|US|ENG|13021-NY-AUBURN--ST-GENESEE-E-15"},{"description":{"content":"

The language preference of the results

\n","type":"text/plain"},"key":"language","value":"EN"},{"description":{"content":"

Indicates whether it is a container search or not

\n","type":"text/plain"},"key":"advanced","value":"true"}],"variable":[]}},"response":[{"id":"a65bfee8-136a-4dc2-82df-db3c68cf0a44","name":"Get Autocomplete Advanced Previews","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"url":{"raw":"https://api.postgrid.com/v1/intl_addver/completions?container=US|US|ENG|13021-NY-AUBURN--ST-GENESEE-E-15&language=EN&advanced=true","protocol":"https","host":["api","postgrid","com"],"path":["v1","intl_addver","completions"],"query":[{"key":"container","value":"US|US|ENG|13021-NY-AUBURN--ST-GENESEE-E-15","description":"A container for the search. This should only be another Id previously returned from this endpoint when the \"type\" of the result was not 'Address'."},{"key":"language","value":"EN","description":"The language preference of the results"},{"key":"advanced","value":"true","description":"Indicates whether it is a container search or not"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"Date","value":"Mon, 29 Mar 2021 23:21:16 GMT"},{"key":"X-RateLimit-Reset","value":"1617060120"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"763"},{"key":"ETag","value":"W/\"2fb-iD6E4Vq8yjj9XPY7YBtfPniwp20\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found international address completion previews successfully.\",\n \"data\": [\n {\n \"description\": \"Auburn NY 13021\",\n \"id\": \"US|US|A|V118108473|1\",\n \"text\": \"15 E Genesee St Apt 1\",\n \"type\": \"Address\"\n },\n {\n \"description\": \"Auburn NY 13021\",\n \"id\": \"US|US|A|V118108473|2\",\n \"text\": \"15 E Genesee St Apt 2\",\n \"type\": \"Address\"\n },\n {\n \"description\": \"Auburn NY 13021\",\n \"id\": \"US|US|A|V118108473|3\",\n \"text\": \"15 E Genesee St Apt 3\",\n \"type\": \"Address\"\n },\n {\n \"description\": \"Auburn NY 13021\",\n \"id\": \"US|US|A|V118108473|4\",\n \"text\": \"15 E Genesee St Apt 4\",\n \"type\": \"Address\"\n },\n {\n \"description\": \"Auburn NY 13021\",\n \"id\": \"US|US|A|V118108474|A\",\n \"text\": \"15 E Genesee St Ste A\",\n \"type\": \"Address\"\n },\n {\n \"description\": \"Auburn NY 13021\",\n \"id\": \"US|US|A|V118108474|B\",\n \"text\": \"15 E Genesee St Ste B\",\n \"type\": \"Address\"\n }\n ]\n}"}],"_postman_id":"77398363-5803-4e24-bab2-c2d2aaa8f643"},{"name":"Autocomplete an Address","id":"74c5c921-ce81-45b8-8b83-0d7085f53321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"US|US|A|V119179091|15","description":"

The id that is previously returned from the preview endpoint

\n","type":"text"}]},"url":"https://api.postgrid.com/v1/intl_addver/completions","description":"

Provide completions for a partially specified address. The id is from the preview endpoint in which the type is \"Address\".

\n","urlObject":{"protocol":"https","path":["v1","intl_addver","completions"],"host":["api","postgrid","com"],"query":[],"variable":[]}},"response":[{"id":"426930f9-bdca-4e2b-a568-273120a71e1d","name":"Autocomplete an Address","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"US|US|A|V119179091|15","description":"The id that is previously returned from the preview endpoint","type":"text"}]},"url":"https://api.postgrid.com/v1/intl_addver/completions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Mon, 29 Mar 2021 23:14:22 GMT"},{"key":"X-RateLimit-Reset","value":"1617059723"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"336"},{"key":"ETag","value":"W/\"150-AnhhcS5Vii+3qZuz6kJFD8ihlNQ\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found international address completion previews successfully.\",\n \"data\": {\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"countryCode\": \"US\",\n \"formattedAddress\": \"15 Park Ave\\nNEW YORK NY 10016-4348\\nUNITED STATES\",\n \"line1\": \"15 Park Ave\",\n \"postalOrZip\": \"10016-4348\",\n \"provinceCode\": \"NY\",\n \"provinceOrState\": \"New York\"\n }\n}"}],"_postman_id":"74c5c921-ce81-45b8-8b83-0d7085f53321"}],"id":"e1860917-7c89-4de3-894a-5f686762e833","_postman_id":"e1860917-7c89-4de3-894a-5f686762e833","description":""}],"event":[{"listen":"prerequest","script":{"id":"40f6559f-193f-4006-9ee2-288fa306609c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a9fb2352-b73e-45d0-ad78-48045717524f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"API Key","value":"live_sk_u7gPCABhqmfY5Aw6WytUDd"},{"key":"pg-base","value":"http://localhost:3000/v1/"}]}