batches

Run Batch

Run a draft: every matched row gets its verdict, one verification per license (once a day, as ever).

Rows that are ambiguous, not found or invalid are never charged. It usually finishes within a minute; poll GET /batches/{id} for status and processed.

Args: batch_id: The draft. body: One role per column, as confirmed. background: Starts verifying once the response is sent. key: Injected: the caller's paid key. batches: Injected BatchRepository. licenses: Injected LicenseRepository, for matching. keys: Injected ApiKeyRepository. runner: Injected: verifies the batch in the background.

Returns: The queued batch.

Raises: HTTPException: 429 at the daily limit.

post/batches/{batch_id}/run

Request

  • Base URL: https://api.licenscheck.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.licenscheck.com/batches/{batch_id}/run
  • Auth: none declared

Path parameters

batch_idstring uuid required

Request body

rolesColumnRole[] required

One role per column, in order: license_number, name, state or keep.

Response

Successful Response

idstring uuid required

The batch's ID.

filenamestring required

The uploaded file's name.

status'draft' | 'queued' | 'running' | 'done' | 'failed' required

Where a batch verification is: uploaded, waiting, being verified, or finished.

Attributes: DRAFT: Uploaded and matched, waiting for the customer to confirm the columns and cost. QUEUED: Confirmed; waiting for a worker. RUNNING: A worker is reading each matched row's verdict. DONE: Every matched row has its verdict. FAILED: The worker gave up on it; rows verified before that keep their results.

rowsinteger required

Data rows in the file.

matchedinteger required

Rows matched to one contractor: verified, one verification each.

ambiguousinteger required

Rows several contractors could be: never charged until you pick one.

not_foundinteger required

Rows no license matches: never charged.

invalidinteger required

Rows with no usable number or name, or an unknown state: never charged.

with_numberinteger required

Rows with a license number.

processedinteger required

Matched rows verified so far.

levelsobject required

Verified rows by verdict: clear, review, risk.

verificationsinteger required

New verifications the batch has used.

created_atstring date-time required

When it was uploaded.

finished_atstring date-time nullable required

When it finished, if it has.

Changes

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