{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"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.  \nIt also offers batch verification which allows you to do the same for thousands of addresses per second.\n\nYou can access the platform [here](https://app.postgrid.com) where you can also bulk verify lists without having to use the API.\n\n**Note that you can supply JSON data instead of urlencoded data for all endpoints**\n\n# Authorization\n\nYou can authorize your HTTP requests by setting the `x-api-key` HTTP header to your API key.\n\n# API Keys\n\nYou can create an API key by accessing the [Developers](https://app.postgrid.com/addver/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.\n\n# Integration\n\nIf you're looking to install autocomplete and verification on a website, you can access the [Developers](https://app.postgrid.com/addver/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.\n\nOtherwise, you can use the endpoints documented below to create a completely custom integration.\n\n# Integrating Autocomplete\n\nWe 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:\n\n1. Use the `GET /completions` endpoint and supply `partialStreet` via the query params\n    \n    - This endpoint does not use any lookups\n        \n2. Allow the user to select one of the autocompleted international address previews\n    \n3. 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    \n4. 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    \n\n# Response\n\nThe top-level JSON response has the following structure:\n\n| Name | Type | Description |\n| --- | --- | --- |\n| status | string | Either `success` or `error` |\n| message | string | Describes the result of the request |\n| data | object or array | The response data. |\n\n# Address Details\n\nYou can request additional address details when using the verification endpoints (both batch and single address) by supplying a query parameter `includeDetails=true`.\n\nThe details have the following schema:\n\n| Name | Type | Description |\n| --- | --- | --- |\n| organization | string or null | Name of the company or organization where the address is located |\n| building | string or null | Name of the building where the address is located |\n| subBuilding | string or null | Name of the sub building where the address is located |\n| premise | string or null | Premise number where the address is located |\n| postBox | string or null | Postal box number where the address is located |\n| telephone | string or null | Telephone number registered where the address is located |\n\n**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.**\n\n# Proper Case\n\nYou 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`.\n\n# Geographical Data\n\nYou can request additional geographical details when using the verification endpoints (both batch and single address) by supplying a query parameter `geoData=true`.\n\n| Name | Type | Description |\n| --- | --- | --- |\n| latitude | string or null | The latitude of the resulting address |\n| longitude | string or null | The longitude of the resulting address |\n| geoAccuracy | string or null | The accuracy of the geographical information of the resulting address |\n\n# Summary of Verification\n\n| Name | Type | Description |\n| --- | --- | --- |\n| verificationStatus | string or null | The status of the verification. See [Verification Status](#verification-status) |\n| 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](#) |\n| 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](#) |\n| parsingStatus | string or null | Either 'identified_and_parsed' or 'unable_to_parse' |\n| 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](#) |\n| 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](#) |\n| postCodeStatus | string or null | The status about postal code.See [PostalCode Status](#) |\n| 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 |\n\n### Verification Status\n\n- `verified`  \n    A complete match was made between the input data and a single record from the available reference data\n    \n- `partially_verified`  \n    A partial match was made between the input data and a single record from the available reference data\n    \n- `unverified`  \n    Unable to verify. The output fields will contain the input data|\n    \n- `ambiguous`  \n    More than one close reference data match\n    \n- `conflict`  \n    More than one close reference data match with conflicting values\n    \n- `reverted`  \n    Record could not be verified to the specified minimum acceptable level. The output fields will contain the input data\n    \n\n### Verification Match Level\n\n- Delivery Point (PostBox or SubBuilding)\n    \n- Premise (Premise or Building)\n    \n- Thoroughfare (Street or Road)\n    \n- Locality (City)\n    \n- AdministrativeArea (Province or State)\n    \n- None\n    \n\n### Postcode Status\n\n- postal_code_primary_and_postal_code_secondary_verified\n    \n- postal_code_primary_verified, postal_code_secondary_added_or_changed\n    \n- postal_code_primary_verified\n    \n- postal_code_primary_verified_with_small_change\n    \n- postal_code_primary_verified_with_large_change\n    \n- postal_code_primary_added\n    \n- postal_code_primary_identified_by_lexicon\n    \n- postal_code_primary_identified_by_context\n    \n- postal_code_primary_empty\n    \n\n# Verification\n\nThis 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](#verification-status). In addition, the `summary` field provides other information regarding the quality of each verification. See [Summary of Verification](#verification-summary)\n\n| Name | Type | Description |\n| --- | --- | --- |\n| formattedAddress | string | The complete address including all details |\n| line1 | string | The first line of the resulting address |\n| line2 | string or null | The second line of the resulting address |\n| line3 | string or null | The third line of the resulting address |\n| line4 | string or null | The fourth line of the resulting address |\n| city | string or null | The city of the resulting address |\n| provinceOrState | string or null | The province or state of the resulting address |\n| postalOrZip | string or null | The Postal/ZIP code of the resulting address |\n| country | string or null | The country of the resulting address |\n| summary | [Summary of Verification](#verification-summary) or null | Contains accuracy information of the verification (see below for details) |\n| geoData | [Geographical Data](#geographical-data) or null | Contains geographic information (see below for details) |\n| details | [Address Details](#address-details) or null | Detailed information about the address (see below for details) |\n| errors | string or null | The address errors that were fixed or caused verification failure |\n\n# Completion Preview\n\nThis 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| Name | Type | Description |\n| --- | --- | --- |\n| id | string | The ID of the autocompleted address |\n| type | string | Either 'Address', 'Container' or 'BuildingNumber' |\n| text | string | The name of the autocompleted address |\n| highlight | string | A list of number ranges identifying the matched characters in the Text and Description |\n| description | string or undefined | Descriptive information about the result |\n\n# Autocompleted Address\n\nThis is the data returned from the `POST` completions endpoint.\n\n| Name | Type | Description |\n| --- | --- | --- |\n| formattedAddress | string | The complete address including all details |\n| line1 | string | The first line of the resulting address |\n| line2 | string or null | The second line of the resulting address |\n| line3 | string or null | The third line of the resulting address |\n| line4 | string or null | The fourth line of the resulting address |\n| city | string or null | The city of the resulting address |\n| provinceOrState | string or null | The province or state of the resulting address |\n| postalOrZip | string or null | The Postal/ZIP code of the resulting address |\n| country | string or null | The country of the resulting address |\n| building | string or null | Name of the building where the address is located |\n| department | string or null | Name of the department where the address is located |\n| company | string or null | Name of the company where the address is located |\n| 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","isPublicCollection":false,"owner":"17207010","collectionId":"292b885f-33cb-46fb-8c82-0d30427d8dc1","publishedId":"UVXona2n","public":true,"publicUrl":"https://intdocs.postgrid.com","privateUrl":"https://go.postman.co/documentation/17207010-292b885f-33cb-46fb-8c82-0d30427d8dc1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2d69ff"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"PostGrid International Address Verification API for Validation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2d69ff"}}]}},"version":"8.10.0","publishDate":"2025-07-11T20:05:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"PostGrid International Address Verification API for Validation","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"PG Production","id":"37d8090d-2ec8-498a-8e28-f2aa59498658","owner":"17206988","values":[{"key":"pg-base","value":"https://api.postgrid.com/v1/","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/34bd04019e69deb8dbe2753382c09c0e8683157cabf78a2860fcea37da95f5af","favicon":"https://postgrid.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"PG Production","value":"17206988-37d8090d-2ec8-498a-8e28-f2aa59498658"}],"canonicalUrl":"https://intdocs.postgrid.com/view/metadata/UVXona2n"}