batches

Resolve Row

Tell a row which license it means (one of its candidates, or one you found) and verify it now.

It's one verification, like any matched row, and the row joins the results file.

Args: batch_id: The batch. row_number: The row. body: The license. key: Injected: the caller's paid key. batches: Injected BatchRepository. licenses: Injected LicenseRepository. keys: Injected ApiKeyRepository.

Returns: The verified row.

Raises: HTTPException: 404 for an unknown row or license; 409 before the batch finishes, or for a matched row.

post/batches/{batch_id}/rows/{row_number}/resolve

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}/rows/{row_number}/resolve
  • Auth: none declared

Path parameters

batch_idstring uuid required
row_numberinteger required

Request body

license_idstring uuid required

One of the row's candidates, or any license you found by search.

Response

Successful Response

rowinteger required

Its number in the file, 1 for the first row under the header.

cellsobject required

Your values, by column.

match_status'matched' | 'ambiguous' | 'not_found' | 'invalid' required

How one uploaded row matched a license.

Attributes: MATCHED: Exactly one license (or one contractor's licenses in the state): verified and billed. AMBIGUOUS: Several contractors could be meant; never verified or billed until the customer picks one. NOT_FOUND: No license matches; never billed. INVALID: The row has no usable number or name, or names an unknown state; never billed.

license_idstring uuid nullable required

The matched license, if any.

notestring nullable required

Why it didn't match, or how it did.

Changes

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