Get Supplier Confidence Status
Poll the task started by POST /discovery/validate (see Validate
Supplier). Poll until status is completed (then fetch
GET /discovery/validate/{taskId}/results) or failed.
result carries the geocoded point, with confidence_level: null, as soon
as the worker has resolved it, so a caller can show the point while the tier
is still computing. It is null before that, and on a task that failed to
geocode.
โถRequest
โถMethod & Path
GET /discovery/validate/{taskId}/status
โถPath parameters
taskId(UUID, required) โ the task id returned on the202(data.id). A non-UUID value is rejected with400.
โถHeaders
x-api-keyโ required.Accept: application/json
โถResponse
- 200 โ a
geocode_confidence_taskresource (schema below). - 400 โ
taskIdis not a valid UUID. - 401 / 403 โ missing or invalid key, or the key lacks
geocode:read. - 404 โ the task is unknown, or it belongs to a different organization
(
404, never403, so a guessed id cannot be probed). - 502 โ a transient upstream failure reading the confidence check. Safe to retry.
โถResponse schema
| Field | Type | Description |
|---|---|---|
type | string | Always geocode_confidence_task. |
id | string | The task id. |
attributes.status | "pending" | "processing" | "completed" | "failed" | Lifecycle status. Fetch results once completed. |
attributes.error | string | null | Failure message; null unless status is failed. |
attributes.error_code | "GEOCODE_NO_RESULT" | "GEOCODE_UPSTREAM_ERROR" | null | Why the task failed: no usable location for the supplier (do not retry), or an upstream failure (retry the POST). null when the task did not fail, or when only the confidence check failed. |
attributes.result | object | null | The geocode_result attributes so far (see Validate Supplier): the point once geocoded, the full result once completed. Carries the request's company_identifier, if one was sent. |
links.results | string | URL to fetch the finished result. |
Required scope:
geocode:read