The retrieveAddress method retrieves full address details based on a container ID obtained from the Find API. This allows users to refine their address selection after retrieving potential matches from the /address/find endpoint.

Authentication

The retrieveAddress endpoint requires authentication via Salesforce OAuth 2.0. Requests must include a valid OAuth access token in the Authorization header.

For detailed authentication steps, refer to: Salesforce Authentication Guide.

Method Signature

POST /services/apexrest/recordval/v1/address/retrieve

Parameters

The AddressRetrieveInput_v1 object is used to retrieve a fully structured address using a container ID obtained from the findAddress method.

Type	Variable	Description
AddressRetrieveInput_v1	`addressInput`	The input object containing the container identifier to retrieve details.

Example Request

{
  "container": "NL|LP|B|1002943|6-8_DUT",
  "note": "Retrieving full address details",
  "addressOptions": {
    "housenumberAddition": false,
    "houseNumber": false, 
    "geocode": true
  }
}

Output

The AddressRetrieveOutput_v1 object contains a fully structured address with details such as street, city, postal code, and geolocation information.

Type	Variable	Description
AddressRetrieveOutput_v1	`output`	The result object containing the full address details.

Example Response

{
    "status": null,
    "advice": null,
    "address": {
        "street": "Jansbuitensingel 6-8",
        "status": {
            "message": "Current address is verified up to Housenumber level.",
            "credit": true,
            "code": "594"
        },
        "stateCode": "GE",
        "state": "Gelderland",
        "postalCode": "6811 AA",
        "longitude": "5.9068287",
        "latitude": "51.9847394",
        "housenumberAddition": "",
        "housenumber": "",
        "geoStatus": {
            "message": "High confidence match between the location and the geocode. The location has only one geopoint match or all returned matches are considered strong.",
            "credit": true,
            "code": "700"
        },
        "fullAddress": "Jansbuitensingel 6-8\n6811 AA  ARNHEM\nNETHERLANDS",
        "countryCode": "NL",
        "country": "Nederland",
        "city": "ARNHEM",
        "advice": "GREEN"
    }
}