VAT validation

Read a bulk job’s status and progress

Progress counters are kept on the job itself, so this stays a single cheap read however large the batch is. Poll it until status is terminal – finished, cancelled or failed – then page through the results. Every job reaches one of the three: there is a bound on how many times a job may step aside from a degraded member state, and on the last attempt the affected positions are answered rather than postponed again.

get/v1/vat/bulk/{jobId}

Request

  • Base URL: https://api.vatnode.dev
  • URL: https://api.vatnode.dev/v1/vat/bulk/{jobId}
  • Auth: HTTP bearer

Path parameters

jobIdstring uuid required

Bulk job identifier, as returned by POST /v1/vat/bulk.

Response

The job.

jobIdstring uuid required
status'queued' | 'processing' | 'finished' | 'cancelled' | 'failed' required

finished means every position has an answer – including positions that answered with an error. It is not a claim that every VAT ID was successfully validated; read summary.

cancelled means the job stopped early: positions it had already answered keep their results, the rest stay pending and unbilled.

failed also means the job stopped early, for a reason of its own rather than a stop it was asked for; errorCode says which. Positions are treated exactly as under cancelled.

All three are terminal. Branch on the terminal set, not on finished alone, so a job that ends any other way does not leave a poller running until the job expires.

totalItemsinteger required
processedItemsinteger required
createdAtstring date-time required
startedAtstring date-time nullable
finishedAtstring date-time nullable
cancelRequestedAtstring date-time nullable

When a cancel was first requested; the job may still be stopping. A cancelled job can have this null – it was stopped by something other than a cancel request, and errorCode says what.

expiresAtstring date-time required

When the job and its positions are deleted (30 days after submission). The underlying checks remain in your check history.

errorCodestring nullable

Why the job ended the way it did, when that needs saying. null for an ordinary run and for a cancel you requested. API_KEY_REVOKED means the API key the job was submitted with was revoked while it was running, so it stopped where it stood.

Changes

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