--- title: "POST /v1/intl_addver/verifications" method: POST path: "/v1/intl_addver/verifications" tags: ["International API"] --- # POST /v1/intl_addver/verifications `POST /v1/intl_addver/verifications` Verify and standardize an international address. - Supports both structured and freeform address inputs. - Specify `includeDetails=true` to get additional details as per the `IntlDetails` schema. - Uses 1 lookup. ## Query parameters - `includeDetails` boolean - `properCase` boolean - `geoData` boolean ## Request body - union - StructuredAddressInput — Input model for structured international address verification. - `address` object, required - `line1` string, required — The first line of the address (e.g., street address, building, etc.). - `line2` string — The second line of the address (e.g., apartment, suite, etc.). - `line3` string — The third line of the address (e.g., additional locality or delivery info). - `line4` string — The fourth line of the address (e.g., further address details). - `city` string — The city, town, or locality of the address. - `provinceOrState` string, required — The administrative area (e.g., state, province, region). - `country` string, required — The country code (ISO 3166-1 alpha-2 or alpha-3). - `postalOrZip` string, required — The postal or ZIP code. - FreeformAddressInput — Input model for freeform international address verification. - `address` string, required — The full address as a single string. ## Response `200` The request has succeeded. - object - `status` 'success' | 'error', required - `message` string, required - `data` VerifiedAddress, required — The result of a verified international address. - `city` string, required — The city or locality. - `country` string, required — The country code (ISO 3166-1 alpha-2). - `countryName` string — The full country name. - `details` IntlDetails — Additional details about the verified address, such as premise, thoroughfare, and locality. - `organization` string — The organization or company name. - `building` string — The building name or number. - `buildingType` string — The type of building (e.g., apartment, office). - `subBuilding` string — The sub-building name or number (e.g., unit, suite). - `subBuildingType` string — The type of sub-building (e.g., floor, wing). - `subBuildingNumber` string — The sub-building number. - `SubBuildingFloor` string — The floor of the sub-building. - `premise` string — The premise name or number. - `premiseType` string — The type of premise (e.g., house, flat). - `premiseNumber` string — The premise number. - `premiseSecondary` string — Secondary premise information. - `postBox` string — The post box number. - `telephone` string — The telephone number associated with the address. - `street` string — The street name. - `streetType` string — The type of street (e.g., St, Ave, Blvd). - `streetPreDirection` string — The directional prefix for the street (e.g., N, S, E, W). - `streetPostDirection` string — The directional suffix for the street (e.g., N, S, E, W). - `subStreet` string — The sub-street name. - `subStreetType` string — The type of sub-street. - `subStreetPreDirection` string — The directional prefix for the sub-street. - `subStreetPostDirection` string — The directional suffix for the sub-street. - `provinceOrStateName` string — The full name of the province or state. - `provinceOrStateType` string — The type of province or state (e.g., province, state, region). - `cityName` string — The full city name. - `cityType` string — The type of city (e.g., city, town, village). - `citySecondary` string — Secondary city information. - `doubleDependentLocality` string — The double dependent locality (UK addresses). - `dependentLocality` string — The dependent locality (UK addresses). - `subAdministrativeArea` string — The sub-administrative area. - `superAdministrativeArea` string — The super-administrative area. - `postalOrZipPrimary` string — The primary part of the postal or ZIP code. - `postalOrZipSecondary` string — The secondary part of the postal or ZIP code. - `deliveryAddress` string — The full delivery address. - `errors` Errors — Errors encountered during address verification. - `line1` string[] — Errors related to the first address line. - `line2` string[] — Errors related to the second address line. - `city` string[] — Errors related to the city. - `provinceOrState` string[] — Errors related to the province or state. - `postalOrZip` string[] — Errors related to the postal or ZIP code. - `generic` string[] — Generic errors not tied to a specific field. - `firmName` string — The firm or company name, if available. - `geoData` GeoData — Geocoding result for the verified address. - `latitude` string — The latitude of the address. - `longitude` string — The longitude of the address. - `geoAccuracy` string — The geocode accuracy. - `line1` string, required — The first address line. - `line2` string — The second address line. - `postalOrZip` string, required — The postal or ZIP code. - `provinceOrState` string, required — The province or state. - `status` 'verified' | 'corrected' | 'failed' — The verification status of an address. - `zipPlus4` string — The ZIP+4 code (for US addresses). - `formattedAddress` string — The formatted address string. - `line3` string — The third address line, if available. - `summary` object — A summary of the verification process and match levels. - `verificationStatus` string — The overall verification status. - `postProcessedVerificationMatchLevel` string — The match level after post-processing. - `preProcessedVerificationMatchLevel` string — The match level before post-processing. - `parsingStatus` string — The parsing status of the address. - `lexiconIdentificationMatchLevel` string — Lexicon identification match level. - `contextIdentificationMatchLevel` string — Context identification match level. - `postCodeStatus` string — The status of the postal code. - `matchScore` number — The match score (0-100). - `message` string — Additional message about the verification. ## Other responses - `400` — The server could not understand the request due to invalid syntax. - `403` — Access is forbidden. --- [API](https://skmtc.net/postgrid/apis/postgrid-address-verification-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-address-verification-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-address-verification-api/revisions/537d2bbc624a/schema)