Validation

Poll an async address-validation job

Returns the job's status and, once status is done, the per-address results (each byte-identical to a POST /validate response). The API key must own the job.

get/validate/jobs/{job_id}

Request

  • Base URL: https://api.acuris-geo.com
  • URL: https://api.acuris-geo.com/validate/jobs/{job_id}
  • 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

Path parameters

job_idstring required

Response

Job status (with results when done).

job_idstring
statusstring

queued | running | done | failed

countrystring
addresses_countinteger
created_atstring
started_atstring nullable
completed_atstring nullable
error_messagestring

Present when status is failed.

Example response

{
  "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.