Address Search: Retrieve a Complete Address Record
/api/v3/address/retrieve
Retrieve Address This endpoint retrieves all available information
we have for a given address record(s). Address records must be defined by
Id. An Id is something which has been returned by find operations (see
for example /v3/address/find endpoint).
Cost: If this function succeeds, then the user is charged; that is, usage is counted for each address record returned.
Input: Define a query parameter called Id with the value of a previously retrieved Id. Batch processing is possible: concatenate a list of Id's with a comma.
Output: A JSON array, which contains JSON object(s). Each of these objects represents an address record that has been successfully retrieved.
This record will contain the same attributes
as defined already in the /v3/address/verify endpoint.
Example Response
[
{
"AQI": "A",
"AVC": "V44-I44-P3-100",
"Address": "K??niginstr. 5|80539 M??nchen",
"Address1": "K??niginstr. 5",
"Address2": "80539 M??nchen",
"AdministrativeArea": "Bayern",
"CountryName": "Germany",
"DeliveryAddress": "K??niginstr. 5",
"DeliveryAddress1": "K??niginstr. 5",
"DependentLocality": "Maxvorstadt",
"ISO3166-2": "DE",
"ISO3166-3": "DEU",
"ISO3166-N": "276",
"Locality": "M??nchen",
"PostalCode": "80539",
"PostalCodePrimary": "80539",
"Premise": "5",
"PremiseNumber": "5",
"SubAdministrativeArea": "Oberbayern",
"Thoroughfare": "K??niginstr."
}
]
Request
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object