Skip to navigation

Read a colour Assessment

One of your assessments. status runs queued, running, then succeeded, failed or cancelled. A succeeded assessment carries its output: one colour report per region, in the order requested, each under its report_sha256, and the whole under output_sha256. A failed one names its failure_code: evidence_erased, evidence_integrity, colour_contract_changed or attempts_exhausted. Another account’s assessment, and one that does not exist, both answer 404 ASSESSMENT_NOT_FOUND. Requires the digitisation.read scope, which your account operator provisions; served only where digitisation is enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

assessment_idstringRequired

Response

The assessment
attemptsinteger>=0
colour_contract_versioninteger
created_atdatetime
failure_codeenum or null
Allowed values:
finished_atdatetime or null
idstring
outputobject or null

The canonical result; result_sha256 is its digest.

output_sha256string or nullformat: "^[0-9a-f]{64}$"
requestobject

The canonical request; request_sha256 is its digest.

request_sha256stringformat: "^[0-9a-f]{64}$"
started_atdatetime or null
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error