Versioned aliases (v1)

Validate up to 200 addresses in one request (versioned alias)

Synchronous bulk validation. Each row is billed and matched exactly as a standalone POST /validate call would be (validate=1 transaction each). An API key is required — the free-tier per-IP allowance is for single POST /validate only.

Every row shares the top-level country unless the row is an object of the form {"input": <input>, "country": "usa"}, which overrides the country for that row (letting you mix countries in one batch). For volumes above 200, submit an async job via POST /validate/jobs (up to 50,000 addresses).

post/v1/validate/batch

Request

  • Base URL: https://api.acuris-geo.com
  • URL: https://api.acuris-geo.com/v1/validate/batch
  • Auth: one of:
    • API key in header X-Acuris-Key
    • HTTP bearer
    • API key in header X-API-Key
    • API key in query parameter key
    • none

Request body

countrystring

Default ISO-3 country for every row that does not carry its own country override.

Response

Per-row results, in request order. Each element is the same body a standalone POST /validate would return (including per-row error objects for rows that failed).

countinteger

Number of rows processed (after empty rows are dropped).

Example response

{
  "count": 2,
  "results": [
    {
      "nearby_house_numbers": {
        "requested": "46",
        "before": {
          "hno": "44"
        },
        "after": {
          "hno": "44"
        },
        "pin_between": [
          "44",
          "50"
        ]
      },
      "street_postcodes": [
        {
          "postcode": "9573 PA",
          "house_number_from": 3,
          "house_number_to": 22
        }
      ],
      "postcode_range": {
        "from": "9573 PA",
        "to": "9573 PH",
        "text": "from 9573 PA to 9573 PH"
      },
      "landmark_used": {
        "name": "Patiala House",
        "matched_from": "Patiala House",
        "source": "Overture Maps Foundation (CDLA-Permissive-2.0)"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.