Bulk Verification

Changed on

Upload a CSV file of addresses to be verified in bulk. Supply a mappings object describing which CSV columns correspond to which address fields.

post/v1/addver_lists

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/v1/addver_lists
  • Auth
    API key in header X-API-Key

Request body multipart/form-data

namestring required

A name for the uploaded list. This only affects what is displayed in the dashboard.

useIntlVerificationboolean

Whether to perform international (outside US & Canada) verification.

useGeocodeboolean

Whether to append geographical location information (latitude, longitude) to your output. Bulk geocoding must be enabled by contacting support.

useProperCaseboolean

Whether to return addresses in Proper Case.

runNCOAboolean

Whether to run NCOA (US National Change of Address) on the list.

runCCOAboolean

Whether to run CCOA (Canada Post change of address) on the list. Note that a list cannot run both NCOA and CCOA — split mixed US/Canadian files into separate lists.

defaultCountrystring

An ISO 2-letter country code used as the fallback when a row is missing a value in the country column.

filestring binary required

Response

The request has succeeded.

status'success' | 'error' required
messagestring required

Changes