Skip to main content

Address metadata (International)

The address verification service returns useful information about each address.

For Australia, see the AU metadata list.

For New Zealand, see the NZ metadata list.

Params

PropertyTypeDescription
maxIntegerThe maximum number of results to return. A number between 1 and 15. The default is 10 results.

Metadata params

PropertyTypeDescriptionDefault value
gpsStringRequest GPS coordinates for latitude and longitude be returned when available.0
    YesGPS coordinates wil be included in the response1
    No0

Metadata

NameTypeDescriptionExample
idStringThe unique address identifier.2fjZ2wvSHufT0ruefqNH13rYtBKS6ZZukGxPowcuqmUB/s_nIJl_--trguceJRa_eztyLG--jl1iVIoZZZaQYvF/erphow==
addressObjectAddress information as supplied by our data sources.-
    address_line_1StringFirst address line in the country specific format.123 Edward St
    address_line_2StringSecond address line in the country specific format.Silver Berry
    address_line_combinedStringCombined address lines 1 and 2.123 Edward St, Silver Berry
    cityStringThe city, town or locality name.Toronto
    city_lineStringThe city in a format suitable for postal services.Toronto ON M5G
    stateStringCountry specific state, region or district.ON
    postcodeStringCountry specific postcode or zipcode.M5G
    country_nameStringName of the country the address belongs to.Canada
    country_codeStringThe ISO 3166 alpha-2 code of the country.CA
metadataObjectOther metadata as supplied by our data sources.-
    streetStringThe full name of the street.Edward St
    street_numberStringThe street number.123
    state_codeStringHolds the two letter code of the province.ON
    state_nameStringHolds the full name of the province.Ontario
positionObjectThe GPS coordinates if requested in the query.-
    latitudeDouble-48.5827
    longitudeDouble-2.96747
successBooleanReturns true if the service ran successfully.true