Jump to

• Request
• Response

Address Search: Retrieve a Complete Address Record

get

/api/v2/address/retrieve

Retrieve Address

Note: We recommend you use the equivalent function in the latest version, v3/.

This endpoint retrieves all information we have for a given address record using the v2 style address fields. Address records must be defined by Id. An Id is something which has been returned by find operations (see for example /v2/address/find endpoint).

Cost: If this function succeeds, then the user is charged; that is, usage is 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 /v2/addressclean endpoint.

Example Response [ { "AQI ": "A ", "AVC": "V44-I44-P3-100 ", } ]

Request

Query Parameters

• Id(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=UTF-8

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object OutputRecord

{
    "items":{
        "$ref":"#/components/schemas/OutputRecord"
    },
    "type":"array"
}

Nested Schema : OutputRecord

Type: object

Show Source

• address1: string
• address2: string
• address3: string
• address4: string
• addressid: string
• adminarea: string
• city: string
• country: string
• countrycode: string
• dependentlocality: string
• doubledependentlocality: string
• fulladdress: string
• geoaccuracycode: string
• geoaccuracycodedescription: string
• geodistance: number
• latitude: number
• longitude: number
• postalcode: string
• postalcodeprimary: string
• postalcodesecondary: string
• subadminarea: string
• verificationcode: string
• verificationcodedescription: string
• verified: string

{
    "properties":{
        "address1":{
            "type":"string"
        },
        "address2":{
            "type":"string"
        },
        "address3":{
            "type":"string"
        },
        "address4":{
            "type":"string"
        },
        "addressid":{
            "type":"string"
        },
        "adminarea":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "countrycode":{
            "type":"string"
        },
        "dependentlocality":{
            "type":"string"
        },
        "doubledependentlocality":{
            "type":"string"
        },
        "fulladdress":{
            "type":"string"
        },
        "geoaccuracycode":{
            "type":"string"
        },
        "geoaccuracycodedescription":{
            "type":"string"
        },
        "geodistance":{
            "type":"number"
        },
        "latitude":{
            "type":"number"
        },
        "longitude":{
            "type":"number"
        },
        "postalcode":{
            "type":"string"
        },
        "postalcodeprimary":{
            "type":"string"
        },
        "postalcodesecondary":{
            "type":"string"
        },
        "subadminarea":{
            "type":"string"
        },
        "verificationcode":{
            "type":"string"
        },
        "verificationcodedescription":{
            "type":"string"
        },
        "verified":{
            "type":"string"
        }
    },
    "type":"object"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

An unexpected error occurred during the request.

Back to Top