--- title: "POST /v1/addver/verifications/batch" method: POST path: "/v1/addver/verifications/batch" tags: ["Standard API"] --- # POST /v1/addver/verifications/batch `POST /v1/addver/verifications/batch` Verify a batch of US or Canadian addresses in a single request. Each address can be freeform or structured, matching the same input formats accepted by the single verification endpoint. - Accepts up to 2,000 addresses per request. - Uses 1 lookup per address (plus 1 more per address if geocoding). - Requires a secret API key. - Returns results in the same order as the input addresses. - If an individual address fails, its result will contain an `error` field rather than a `verifiedAddress`. - If you are not subscribed and the batch would exceed your remaining free lookups, the entire batch fails (nothing is verified). Size your batch to the number of lookups you have left. ## Query parameters - `includeDetails` boolean - `properCase` boolean - `geocode` boolean ## Request body - StandardBatchInput - `addresses` StandardAddressInput[], required — Array of addresses to verify. Each item can be a freeform string or structured address object. - union - StandardFreeformAddressInput - `address` string, required — The address you want to verify, written on a single line. - StandardStructuredAddressInput - `address` object, required - `recipient` string — The optional firm/recipient name. - `line1` string, required — The first line of the address. - `line2` string — The second line of the address. - `city` string, required — The city of the address. - `provinceOrState` string, required — The province or state of the address. - `postalOrZip` string, required — The postal code or ZIP code of the address. - `country` 'ca' | 'us', required — The country of your address, one of `ca` or `us`. ## Response `200` The request has succeeded. - object - `status` 'success' | 'error', required - `message` string, required - `data` object, required - `results` StandardBatchVerificationResult[], required - `verifiedAddress` StandardVerifiedAddress - `city` string, required — The city name of the address. - `country` string, required — The country code of the address. - `countryName` string — The country name of the address. - `details` StandardDetails - `streetName` string — Name of the street where the address is located - `streetType` string — Type of the street (DR, ST, BLVD, etc) - `streetDirection` string — The direction of the street (N, S, E, W, etc) - `streetNumber` string — Street number (e.g. the 20 in 20 Bay St) - `preDirection` string — The pre-direction of the street (before the street name, US addresses only) - `postDirection` string — The post-direction of the street (after the street name, US addresses only) - `suiteKey` string — The suite key - `suiteID` string — The unit number/name - `boxID` string — PO Box ID - `deliveryInstallationAreaName` string — Delivery installation area name - `deliveryInstallationType` string — Delivery installation type - `deliveryInstallationQualifier` string — Delivery installation qualifier - `ruralRouteNumber` string — Rural route number - `ruralRouteType` string — Rural route type - `extraInfo` string — Any extra information relevant to the address - `county` string — County in the United States (US address only) - `countyNum` string — FIPS code for county (US address only) - `usCensusFIPS` string — US Census FIPS code (US address only) - `usCensusCMSA` string — US Census consolidated metropolitan statistical area - `usCensusBlockNumber` string — US Census block number - `usCensusTractNumber` string — US Census tract number - `usCensusMA` string — US Census metropolitan area - `usCensusMSA` string — US Census metropolitan statistical area - `usCensusPMSA` string — US Census primary metropolitan statistical area - `usHasDaylightSavings` boolean — True if address location recognizes DST - `usTimeZone` string — Time zone for the US address area - `usCongressionalDistrictNumber` string — US congressional district number - `usStateLegislativeUpper` string — Upper legislative district for the US address - `usStateLegislativeLower` string — Lower legislative district for the US address - `usMailingsCarrierRoute` string — 4-character code assigned to mail delivery route within a 5 digit zip code - `usMailingCheckDigit` string — PostNet barcode digit - `usMailingsDefaultFlag` boolean — True if US address matches a high-rise default or rural route default in the USPS data - `usMailingsDeliveryPoint` string — Unique USPS identifier for the delivery point - `usMailingsDpvConfirmationIndicator` string — See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv) - `usMailingsDpvCrmaIndicator` string — Y if this is a commercial mail receiving agency, N otherwise - `usMailingsDpvFootnote1` string — See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv) - `usMailingsDpvFootnote2` string — See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv) - `usMailingsDpvFootnote3` string — See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv) - `usMailingsElotAscDesc` string — A for ascending, D for descending - `usMailingsElotSequenceNumber` string — eLOT sequence number - `usMailingsEWSFlag` string — Y if address is in early warning system database - `usMailingsLACSFlag` string — Y if address converted by LACS - `usMailingsLACSReturnCode` string — Corresponds to USPS LACSLink return code - `usMailingsRecordTypeCode` string — See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv) - `usMailingsSuiteLinkReturnCode` string — See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv) - `usPostnetBarcode` string — PostNet barcode for the address (US address only) - `residential` boolean — Indicates that the address is residential (US address only) - `vacant` boolean — Indicates that the address is vacant according to the USPS (US address only) - `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 name of the address. - `geocodeResult` GeocodeResult - `location` object, required — Object that contains `lat`, `lng` properties with number values - `lat` number, required - `lng` number, required - `accuracy` number, required — A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score) - `accuracyType` 'rooftop' | 'point' | 'range_interpolation' | 'nearest_rooftop_match' | 'intersection' | 'street_center' | 'place' | 'state', required — A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `line1` string, required — The first line of the address. - `line2` string — The second line of the address. - `postalOrZip` string, required — The postal code or ZIP code of the address. - `provinceOrState` string, required — The province or state of the address. - `provinceOrStateName` string — The full name of the province or state. - `status` 'verified' | 'corrected' | 'failed' — The verification status of an address. - `zipPlus4` string — The zip plus 4 code of the address. - `error` string — An error message for this address. Present when verification failed. ## 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)