# Address Verification ## Verify `client.addressVerification.verify(AddressVerificationVerifyParamsparams, RequestOptionsoptions?): AddressVerificationVerifyResponse` **post** `/v1/addver/verifications` 1. **Structured Address** — Verify and standardize a structured address (e.g., with `line1`, `city`, etc.). 1. **Freeform Address** — Verify and standardize a freeform address written on one line. For best results, append the ISO 2-letter country code (e.g., `US`, `CA`) to the end of the line. - Specifying `includeDetails=true` will provide additional output as documented in the `Details` schema. - Uses 1 lookup for verification, and 1 more if geocoding (unless your contract says otherwise). ### Parameters - `AddressVerificationVerifyParams = StandardFreeformAddressInput | StandardStructuredAddressInput` - `AddressVerificationVerifyParamsBase` - `address: string` Body param: The address you want to verify, written on a single line. - `geocode?: boolean` Query param - `includeDetails?: boolean` Query param - `properCase?: boolean` Query param - `StandardFreeformAddressInput extends AddressVerificationVerifyParamsBase` - `StandardStructuredAddressInput extends AddressVerificationVerifyParamsBase` ### Returns - `AddressVerificationVerifyResponse` - `data: Data` - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.verify({ address: '1234 Elm St, Los Angeles, CA 90001, US', }); console.log(response.data); ``` #### Response ```json { "status": "success", "message": "Address verified successfully", "data": { "city": "Los Angeles", "country": "US", "line1": "1234 Elm St", "postalOrZip": "90001", "provinceOrState": "CA", "status": "verified", "errors": {} } } ``` ## Get Lookup Info `client.addressVerification.getLookupInfo(RequestOptionsoptions?): AddressVerificationGetLookupInfoResponse` **get** `/v1/addver/` Returns your organization's current lookup usage and plan information. Useful for checking how many lookups you have consumed and whether you are on a paid plan. ### Returns - `AddressVerificationGetLookupInfoResponse` - `data: Data` - `freeLimit: number | null` The maximum number of lookups allowed in the current billing period. `null` indicates an unlimited plan. - `used: number` The number of lookups consumed in the current billing period. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.getLookupInfo(); console.log(response.data); ``` #### Response ```json { "data": { "freeLimit": 0, "used": 0 }, "message": "message", "status": "success" } ``` ## Get Autocomplete Previews `client.addressVerification.getAutocompletePreviews(AddressVerificationGetAutocompletePreviewsParamsquery, RequestOptionsoptions?): AddressVerificationGetAutocompletePreviewsResponse` **get** `/v1/addver/completions` Returns address completion previews for a partial street address, suitable for populating an autocomplete dropdown without consuming a lookup per keystroke. Each result contains a partial address preview (street, city, and — for non-US addresses — only the first 3 digits of the postal code, to avoid revealing the full code before a lookup is charged). - Does not consume a lookup. - Use `POST /completions` to resolve a full address once the user selects a result. ### Parameters - `query: AddressVerificationGetAutocompletePreviewsParams` - `partialStreet: string` - `cityFilter?: string` - `countryFilter?: string` - `filterExact?: boolean` - `limit?: number` - `pcFilter?: string` - `properCase?: boolean` - `provInsteadOfPC?: boolean` - `stateFilter?: string` - `verifiedOnly?: boolean` ### Returns - `AddressVerificationGetAutocompletePreviewsResponse` - `data: Array` - `preview: Preview` A partial view of the address, suitable for display in an autocomplete dropdown. - `address: string` The street address line. - `city?: string` The city. - `pc?: string` For US addresses, the full postal code. For non-US addresses, only the first 3 digits are returned to avoid consuming a lookup. - `prov?: string` The province or state abbreviation. Returned instead of `pc` when `provInsteadOfPC=true`. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.getAutocompletePreviews({ partialStreet: 'partialStreet', }); console.log(response.data); ``` #### Response ```json { "data": [ { "preview": { "address": "address", "city": "city", "pc": "pc", "prov": "prov" } } ], "message": "message", "status": "success" } ``` ## Autocomplete `client.addressVerification.autocomplete(AddressVerificationAutocompleteParamsparams, RequestOptionsoptions?): AddressVerificationAutocompleteResponse` **post** `/v1/addver/completions` Resolves a partial street address into a list of full address candidates, optionally selecting a specific candidate by index and verifying it. **Basic usage** — omit `index`: returns an array of `CompletedAddressItem` results for the given `partialStreet`. **With `index`** — specify `index` to resolve a single candidate. Returns a single `CompletedAddressItem`. **With `index` + `verify=true`** — additionally runs the selected address through the USPS/Canada Post verifier and returns a `StandardVerifiedAddress`. - Uses 1 lookup per call (plus 1 more if geocoding a result). ### Parameters - `params: AddressVerificationAutocompleteParams` - `partialStreet: string` Body param: The partial street address to complete (e.g. `"22 Bay"`). - `filterExact?: boolean` Query param - `geocode?: boolean` Query param - `includeDetails?: boolean` Query param - `index?: number` Query param - `limit?: number` Query param - `properCase?: boolean` Query param - `body_verifiedOnly?: boolean` Body param: If true, only return addresses that passed USPS/Canada Post verification. - `verify?: boolean` Query param - `cityFilter?: string` Body param: Filter results to a specific city. - `countryFilter?: string` Body param: Filter results to a specific country code. - `pcFilter?: string` Body param: Filter results to a specific postal code prefix. - `stateFilter?: string` Body param: Filter results to a specific state or province abbreviation. ### Returns - `AddressVerificationAutocompleteResponse` - `data: CompletedAddressItem | Array | StandardVerifiedAddress` - `CompletedAddressItem` - `address: Address` The resolved address components. - `address: string` The first line of the address. - `address2?: string` The second line of the address. - `city?: string` The city. - `country?: string` The ISO 2-letter country code. - `pc?: string` The postal code. - `prov?: string` The province or state abbreviation. - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `geocodeResult?: GeocodeResult` Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `Array` - `address: Address` The resolved address components. - `address: string` The first line of the address. - `address2?: string` The second line of the address. - `city?: string` The city. - `country?: string` The ISO 2-letter country code. - `pc?: string` The postal code. - `prov?: string` The province or state abbreviation. - `errors?: Errors` Errors encountered during address verification. - `geocodeResult?: GeocodeResult` Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `StandardVerifiedAddress` - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.autocomplete({ partialStreet: 'partialStreet' }); console.log(response.data); ``` #### Response ```json { "data": { "address": { "address": "address", "address2": "address2", "city": "city", "country": "country", "pc": "pc", "prov": "prov" }, "errors": { "city": [ "string" ], "generic": [ "string" ], "line1": [ "string" ], "line2": [ "string" ], "postalOrZip": [ "string" ], "provinceOrState": [ "string" ] }, "geocodeResult": { "accuracy": 0, "accuracyType": "rooftop", "location": { "lat": 0, "lng": 0 } } }, "message": "message", "status": "success" } ``` ## Batch Verification `client.addressVerification.batchVerification(AddressVerificationBatchVerificationParamsparams, RequestOptionsoptions?): AddressVerificationBatchVerificationResponse` **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. - 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`. ### Parameters - `params: AddressVerificationBatchVerificationParams` - `addresses: Array` Body param: Array of addresses to verify. Each item can be a freeform string or structured address object. - `StandardFreeformAddressInput` - `address: string` The address you want to verify, written on a single line. - `StandardStructuredAddressInput` - `address: Address` - `city: string` The city of the address. - `country: "ca" | "us"` The country of your address, one of `ca` or `us`. - `"ca"` - `"us"` - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `line2?: string` The second line of the address. - `recipient?: string` The optional firm/recipient name. - `geocode?: boolean` Query param - `includeDetails?: boolean` Query param - `properCase?: boolean` Query param ### Returns - `AddressVerificationBatchVerificationResponse` - `data: Data` - `results: Array` - `error?: string` An error message for this address. Present when verification failed. - `verifiedAddress?: VerifiedAddress` The verified address result. Present when verification succeeded. - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.batchVerification({ addresses: [{ address: 'address' }], }); console.log(response.data); ``` #### Response ```json { "data": { "results": [ { "error": "error", "verifiedAddress": { "city": "city", "country": "country", "line1": "line1", "postalOrZip": "postalOrZip", "provinceOrState": "provinceOrState", "countryName": "countryName", "details": { "boxID": "boxID", "county": "county", "countyNum": "countyNum", "deliveryInstallationAreaName": "deliveryInstallationAreaName", "deliveryInstallationQualifier": "deliveryInstallationQualifier", "deliveryInstallationType": "deliveryInstallationType", "extraInfo": "extraInfo", "postDirection": "postDirection", "preDirection": "preDirection", "residential": true, "ruralRouteNumber": "ruralRouteNumber", "ruralRouteType": "ruralRouteType", "streetDirection": "streetDirection", "streetName": "streetName", "streetNumber": "streetNumber", "streetType": "streetType", "suiteID": "suiteID", "suiteKey": "suiteKey", "usCensusBlockNumber": "usCensusBlockNumber", "usCensusCMSA": "usCensusCMSA", "usCensusFIPS": "usCensusFIPS", "usCensusMA": "usCensusMA", "usCensusMSA": "usCensusMSA", "usCensusPMSA": "usCensusPMSA", "usCensusTractNumber": "usCensusTractNumber", "usCongressionalDistrictNumber": "usCongressionalDistrictNumber", "usHasDaylightSavings": true, "usMailingCheckDigit": "usMailingCheckDigit", "usMailingsCarrierRoute": "usMailingsCarrierRoute", "usMailingsDefaultFlag": true, "usMailingsDeliveryPoint": "usMailingsDeliveryPoint", "usMailingsDpvConfirmationIndicator": "usMailingsDpvConfirmationIndicator", "usMailingsDpvCrmaIndicator": "usMailingsDpvCrmaIndicator", "usMailingsDpvFootnote1": "usMailingsDpvFootnote1", "usMailingsDpvFootnote2": "usMailingsDpvFootnote2", "usMailingsDpvFootnote3": "usMailingsDpvFootnote3", "usMailingsElotAscDesc": "usMailingsElotAscDesc", "usMailingsElotSequenceNumber": "usMailingsElotSequenceNumber", "usMailingsEWSFlag": "usMailingsEWSFlag", "usMailingsLACSFlag": "usMailingsLACSFlag", "usMailingsLACSReturnCode": "usMailingsLACSReturnCode", "usMailingsRecordTypeCode": "usMailingsRecordTypeCode", "usMailingsSuiteLinkReturnCode": "usMailingsSuiteLinkReturnCode", "usPostnetBarcode": "usPostnetBarcode", "usStateLegislativeLower": "usStateLegislativeLower", "usStateLegislativeUpper": "usStateLegislativeUpper", "usTimeZone": "usTimeZone", "vacant": true }, "errors": { "city": [ "string" ], "generic": [ "string" ], "line1": [ "string" ], "line2": [ "string" ], "postalOrZip": [ "string" ], "provinceOrState": [ "string" ] }, "firmName": "firmName", "geocodeResult": { "accuracy": 0, "accuracyType": "rooftop", "location": { "lat": 0, "lng": 0 } }, "line2": "line2", "provinceOrStateName": "provinceOrStateName", "status": "verified", "zipPlus4": "zipPlus4" } } ] }, "message": "message", "status": "success" } ``` ## Suggest Addresses `client.addressVerification.suggestAddresses(AddressVerificationSuggestAddressesParamsparams, RequestOptionsoptions?): AddressVerificationSuggestAddressesResponse` **post** `/v1/addver/suggestions` Returns up to 3 verified address suggestions for a given input address. Useful as a fallback when `POST /verifications` returns a `failed` status — suggestions represent the closest matches found and may help the user identify the correct address. Accepts the same freeform or structured input formats as `POST /verifications`. - Uses 1 lookup per call (plus 1 more if geocoding). ### Parameters - `AddressVerificationSuggestAddressesParams = StandardFreeformAddressInput | StandardStructuredAddressInput` - `AddressVerificationSuggestAddressesParamsBase` - `address: string` Body param: The address you want to verify, written on a single line. - `geocode?: boolean` Query param - `includeDetails?: boolean` Query param - `properCase?: boolean` Query param - `StandardFreeformAddressInput extends AddressVerificationSuggestAddressesParamsBase` - `StandardStructuredAddressInput extends AddressVerificationSuggestAddressesParamsBase` ### Returns - `AddressVerificationSuggestAddressesResponse` - `data: Array` - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.suggestAddresses({ address: '1234 Elm St, Los Angeles, CA 90001, US', }); console.log(response.data); ``` #### Response ```json { "status": "success", "message": "Addresses suggested successfully", "data": [ { "city": "Los Angeles", "country": "US", "line1": "1234 Elm St", "postalOrZip": "90001", "provinceOrState": "CA", "status": "verified", "errors": {} } ] } ``` ## Parse An Address `client.addressVerification.parseAnAddress(AddressVerificationParseAnAddressParamsbody, RequestOptionsoptions?): AddressVerificationParseAnAddressResponse` **post** `/v1/addver/parses` Parses a freeform address string into its individual components (house number, street name, city, state, postal code, etc.). Useful for extracting structured data from a single-line address without running a full verification. - Uses 1 lookup. ### Parameters - `body: AddressVerificationParseAnAddressParams` - `address: string` The address you want to verify, written on a single line. ### Returns - `AddressVerificationParseAnAddressResponse` - `data: Data` - `category?: string` The category of the location (e.g. restaurant). - `city?: string` The city name. - `cityDistrict?: string` The borough within a city. - `country?: string` The country. - `house?: string` The name of the location. - `houseNumber?: string` The house or street number. - `island?: string` The name of the island. - `level?: string` The floor. - `near?: string` Populated if the input query contains a near/in qualifier. - `poBox?: string` The postal office box. - `postcode?: string` The postal or ZIP code. - `road?: string` The street name. - `state?: string` The state or province. - `stateDistrict?: string` The county. - `suburb?: string` The unofficial neighborhood name. - `unit?: string` The apartment, unit, office, lot, or other secondary unit designator. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.parseAnAddress({ address: 'address' }); console.log(response.data); ``` #### Response ```json { "data": { "category": "category", "city": "city", "cityDistrict": "cityDistrict", "country": "country", "house": "house", "houseNumber": "houseNumber", "island": "island", "level": "level", "near": "near", "poBox": "poBox", "postcode": "postcode", "road": "road", "state": "state", "stateDistrict": "stateDistrict", "suburb": "suburb", "unit": "unit" }, "message": "message", "status": "success" } ``` ## Lookup City Or State From Postal Or Zip Code `client.addressVerification.lookupCityOrStateFromPostalOrZipCode(AddressVerificationLookupCityOrStateFromPostalOrZipCodeParamsbody, RequestOptionsoptions?): AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse` **post** `/v1/addver/city_states` Looks up city, county, and other location metadata for a given US or Canadian postal code or ZIP code. A single postal code may map to multiple cities (e.g. a ZIP that spans several towns), so the response is an array. - Uses 1 lookup. ### Parameters - `body: AddressVerificationLookupCityOrStateFromPostalOrZipCodeParams` - `postalOrZip: string` ### Returns - `AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse` - `data: Array` - `city: string` The city name. - `country: string` The ISO 2-letter country code. - `provinceOrState: string` The province or state abbreviation. - `county?: string` The county name (US addresses only). - `countyFIPS?: string` The FIPS code for the county (US addresses only). - `mailable?: boolean` Whether the location is mailable. - `preferredCity?: string` The USPS preferred city name for this postal code. - `zipClass?: string` The USPS ZIP code class (e.g. `S` for standard, `P` for PO Box only). - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.lookupCityOrStateFromPostalOrZipCode({ postalOrZip: 'postalOrZip', }); console.log(response.data); ``` #### Response ```json { "data": [ { "city": "city", "country": "country", "provinceOrState": "provinceOrState", "county": "county", "countyFIPS": "countyFIPS", "mailable": true, "preferredCity": "preferredCity", "zipClass": "zipClass" } ], "message": "message", "status": "success" } ``` ## Lookup Zip Code From City Or State `client.addressVerification.lookupZipCodeFromCityOrState(AddressVerificationLookupZipCodeFromCityOrStateParamsbody, RequestOptionsoptions?): AddressVerificationLookupZipCodeFromCityOrStateResponse` **post** `/v1/addver/zip_codes` Looks up all ZIP codes that correspond to a given US city and state. - Currently only supported for US addresses (`countryCode: "US"`). - Uses 1 lookup. ### Parameters - `body: AddressVerificationLookupZipCodeFromCityOrStateParams` - `city: string` The city name. - `countryCode: string` The country code. Currently only `US` is supported. - `state: string` The state abbreviation (e.g. `NY`). ### Returns - `AddressVerificationLookupZipCodeFromCityOrStateResponse` - `data: Data` - `zipCodes: Array` - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Example ```typescript import PostGrid from 'postgrid-node'; const client = new PostGrid({ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted }); const response = await client.addressVerification.lookupZipCodeFromCityOrState({ city: 'city', countryCode: 'countryCode', state: 'state', }); console.log(response.data); ``` #### Response ```json { "data": { "zipCodes": [ "string" ] }, "message": "message", "status": "success" } ``` ## Domain Types ### Errors - `Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. ### Status - `Status = "verified" | "corrected" | "failed"` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` ### Address Verification Verify Response - `AddressVerificationVerifyResponse` - `data: Data` - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Get Lookup Info Response - `AddressVerificationGetLookupInfoResponse` - `data: Data` - `freeLimit: number | null` The maximum number of lookups allowed in the current billing period. `null` indicates an unlimited plan. - `used: number` The number of lookups consumed in the current billing period. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Get Autocomplete Previews Response - `AddressVerificationGetAutocompletePreviewsResponse` - `data: Array` - `preview: Preview` A partial view of the address, suitable for display in an autocomplete dropdown. - `address: string` The street address line. - `city?: string` The city. - `pc?: string` For US addresses, the full postal code. For non-US addresses, only the first 3 digits are returned to avoid consuming a lookup. - `prov?: string` The province or state abbreviation. Returned instead of `pc` when `provInsteadOfPC=true`. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Autocomplete Response - `AddressVerificationAutocompleteResponse` - `data: CompletedAddressItem | Array | StandardVerifiedAddress` - `CompletedAddressItem` - `address: Address` The resolved address components. - `address: string` The first line of the address. - `address2?: string` The second line of the address. - `city?: string` The city. - `country?: string` The ISO 2-letter country code. - `pc?: string` The postal code. - `prov?: string` The province or state abbreviation. - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `geocodeResult?: GeocodeResult` Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `Array` - `address: Address` The resolved address components. - `address: string` The first line of the address. - `address2?: string` The second line of the address. - `city?: string` The city. - `country?: string` The ISO 2-letter country code. - `pc?: string` The postal code. - `prov?: string` The province or state abbreviation. - `errors?: Errors` Errors encountered during address verification. - `geocodeResult?: GeocodeResult` Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `StandardVerifiedAddress` - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Batch Verification Response - `AddressVerificationBatchVerificationResponse` - `data: Data` - `results: Array` - `error?: string` An error message for this address. Present when verification failed. - `verifiedAddress?: VerifiedAddress` The verified address result. Present when verification succeeded. - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Suggest Addresses Response - `AddressVerificationSuggestAddressesResponse` - `data: Array` - `city: string` The city name of the address. - `country: string` The country code of the address. - `line1: string` The first line of the address. - `postalOrZip: string` The postal code or ZIP code of the address. - `provinceOrState: string` The province or state of the address. - `countryName?: string` The country name of the address. - `details?: Details` If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema. - `boxID?: string` PO Box ID - `county?: string` County in the United States (US address only) - `countyNum?: string` FIPS code for county (US address only) - `deliveryInstallationAreaName?: string` Delivery installation area name - `deliveryInstallationQualifier?: string` Delivery installation qualifier - `deliveryInstallationType?: string` Delivery installation type - `extraInfo?: string` Any extra information relevant to the address - `postDirection?: string` The post-direction of the street (after the street name, US addresses only) - `preDirection?: string` The pre-direction of the street (before the street name, US addresses only) - `residential?: boolean` Indicates that the address is residential (US address only) - `ruralRouteNumber?: string` Rural route number - `ruralRouteType?: string` Rural route type - `streetDirection?: string` The direction of the street (N, S, E, W, etc) - `streetName?: string` Name of the street where the address is located - `streetNumber?: string` Street number (e.g. the 20 in 20 Bay St) - `streetType?: string` Type of the street (DR, ST, BLVD, etc) - `suiteID?: string` The unit number/name - `suiteKey?: string` The suite key - `usCensusBlockNumber?: string` US Census block number - `usCensusCMSA?: string` US Census consolidated metropolitan statistical area - `usCensusFIPS?: string` US Census FIPS code (US address only) - `usCensusMA?: string` US Census metropolitan area - `usCensusMSA?: string` US Census metropolitan statistical area - `usCensusPMSA?: string` US Census primary metropolitan statistical area - `usCensusTractNumber?: string` US Census tract number - `usCongressionalDistrictNumber?: string` US congressional district number - `usHasDaylightSavings?: boolean` True if address location recognizes DST - `usMailingCheckDigit?: string` PostNet barcode digit - `usMailingsCarrierRoute?: string` 4-character code assigned to mail delivery route within a 5 digit zip code - `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) - `usStateLegislativeLower?: string` Lower legislative district for the US address - `usStateLegislativeUpper?: string` Upper legislative district for the US address - `usTimeZone?: string` Time zone for the US address area - `vacant?: boolean` Indicates that the address is vacant according to the USPS (US address only) - `errors?: Errors` Errors encountered during address verification. - `city?: Array` Errors related to the city. - `generic?: Array` Generic errors not tied to a specific field. - `line1?: Array` Errors related to the first address line. - `line2?: Array` Errors related to the second address line. - `postalOrZip?: Array` Errors related to the postal or ZIP code. - `provinceOrState?: Array` Errors related to the province or state. - `firmName?: string` The firm name of the address. - `geocodeResult?: GeocodeResult` If the `geocode=true` query parameter is supplied, the response will include a geocodeResult which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch verification, suggestions, and POST /completions endpoint. Note that you must supply country when geocoding to get the result successfully. - `accuracy: number` 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" | 5 more` A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type) - `"rooftop"` - `"point"` - `"range_interpolation"` - `"nearest_rooftop_match"` - `"intersection"` - `"street_center"` - `"place"` - `"state"` - `location: Location` Object that contains `lat`, `lng` properties with number values - `lat: number` - `lng: number` - `line2?: string` The second line of the address. - `provinceOrStateName?: string` The full name of the province or state. - `status?: Status` The verification status of an address. - `"verified"` - `"corrected"` - `"failed"` - `zipPlus4?: string` The zip plus 4 code of the address. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Parse An Address Response - `AddressVerificationParseAnAddressResponse` - `data: Data` - `category?: string` The category of the location (e.g. restaurant). - `city?: string` The city name. - `cityDistrict?: string` The borough within a city. - `country?: string` The country. - `house?: string` The name of the location. - `houseNumber?: string` The house or street number. - `island?: string` The name of the island. - `level?: string` The floor. - `near?: string` Populated if the input query contains a near/in qualifier. - `poBox?: string` The postal office box. - `postcode?: string` The postal or ZIP code. - `road?: string` The street name. - `state?: string` The state or province. - `stateDistrict?: string` The county. - `suburb?: string` The unofficial neighborhood name. - `unit?: string` The apartment, unit, office, lot, or other secondary unit designator. - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Lookup City Or State From Postal Or Zip Code Response - `AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse` - `data: Array` - `city: string` The city name. - `country: string` The ISO 2-letter country code. - `provinceOrState: string` The province or state abbreviation. - `county?: string` The county name (US addresses only). - `countyFIPS?: string` The FIPS code for the county (US addresses only). - `mailable?: boolean` Whether the location is mailable. - `preferredCity?: string` The USPS preferred city name for this postal code. - `zipClass?: string` The USPS ZIP code class (e.g. `S` for standard, `P` for PO Box only). - `message: string` - `status: "success" | "error"` - `"success"` - `"error"` ### Address Verification Lookup Zip Code From City Or State Response - `AddressVerificationLookupZipCodeFromCityOrStateResponse` - `data: Data` - `zipCodes: Array` - `message: string` - `status: "success" | "error"` - `"success"` - `"error"`