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
Property | Type | Description |
---|---|---|
max | Integer | The maximum number of results to return. A number between 1 and 15. The default is 10 results. |
Metadata params
Property | Type | Description | Default value |
---|---|---|---|
gps | String | Request GPS coordinates for latitude and longitude be returned when available. | 0 |
Yes | GPS coordinates wil be included in the response | 1 | |
No | 0 |
Metadata
Name | Type | Description | Example |
---|---|---|---|
id | String | The unique address identifier. | 2fjZ2wvSHufT0ruefqNH13rYtBKS6ZZukGxPowcuqmUB/s_nIJl_--trguceJRa_eztyLG--jl1iVIoZZZaQYvF/erphow== |
address | Object | Address information as supplied by our data sources. | - |
address_line_1 | String | First address line in the country specific format. | 123 Edward St |
address_line_2 | String | Second address line in the country specific format. | Silver Berry |
address_line_combined | String | Combined address lines 1 and 2. | 123 Edward St, Silver Berry |
city | String | The city, town or locality name. | Toronto |
city_line | String | The city in a format suitable for postal services. | Toronto ON M5G |
state | String | Country specific state, region or district. | ON |
postcode | String | Country specific postcode or zipcode. | M5G |
country_name | String | Name of the country the address belongs to. | Canada |
country_code | String | The ISO 3166 alpha-2 code of the country. | CA |
metadata | Object | Other metadata as supplied by our data sources. | - |
street | String | The full name of the street. | Edward St |
street_number | String | The street number. | 123 |
state_code | String | Holds the two letter code of the province. | ON |
state_name | String | Holds the full name of the province. | Ontario |
position | Object | The GPS coordinates if requested in the query. | - |
latitude | Double | - | 48.5827 |
longitude | Double | - | 2.96747 |
success | Boolean | Returns true if the service ran successfully. | true |