International API

Changed on

Resolves an address preview id (from GET /completions) into a full address.

Optionally verifies the resolved address through the standard US/CA verifier when verify=true is supplied and the address is in the US or Canada.

  • Uses 1 lookup per call.
  • When verify=true resolves a US or CA address, the response will be a VerifiedAddress instead of an IntlAddressCompletion.
post/v1/intl_addver/completions

Request

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

Query parameters

verifyboolean
includeDetailsboolean
properCaseboolean
useEnhancedChinaDatasetboolean

Request body

idstring required

Response

The request has succeeded.

status'success' | 'error' required
messagestring required

Changes