Authentication

The findAddress 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/find

Parameters

Example Request

{
  "address": "Jansbuitensingel 6",
  "country": "NL",
  "note": "Testing the Find API",
  "container": ""  // Optional: can be null or empty for initial search; use a container ID to drill down in follow-up searches
}

Output

The AddressFindOutput_v1 object contains a list of suggested addresses, each represented as an AddressFindOutputItem. Users can select one of these results and use its container value for a subsequent /address/retrieve request.# Example Response

{
    "suggestions": [
        {
            "type": "Address",
            "highlight": "0-16,17-18,19-20;0-1,8-14",
            "description": "6811 AA Arnhem",
            "container": "NL|LP|B|1002943|6-8_DUT", // Use this container ID in the retrieve call
            "address": "Jansbuitensingel 6-8"
        }
    ],
    "status": {
        "message": "Correct suggestion.",
        "credit": true,
        "code": "400"
    },
    "advice": null
}

Find & Retrieve logic

the Find and Retrieve APIs collaborate to refine and validate address data. When a user inputs partial address information, the Find API returns a list of suggestions, each with a type and a container ID. If a suggestion’s type is "Address", the associated container ID can be used in the Retrieve API to obtain the full, validated address details. For suggestions where the type is not "Address" (e.g., "Street" or "Building"), the container ID should be used in a subsequent Find API call to drill down further and retrieve more specific address suggestions within that broader location. This iterative process continues until a complete address is identified, at which point the Retrieve API can be used to validate and enrich the address data.