Skip to navigation

Accept a colour Candidate

Accepts a pending candidate. Send the candidate_sha256 you reviewed: a candidate already decided answers 409 CANDIDATE_DECIDED, and another digest 409 CANDIDATE_DIGEST_MISMATCH. Acceptance checks, at the moment it is decided, that the evidence is still stored and intact and that the assessment and colour contract are still the ones the candidate names; otherwise it answers 409 CANDIDATE_NOT_ACCEPTABLE; read the evidence and the assessment back to see which. You can still reject it. A refused decision records nothing. Send an Idempotency-Key: it is required, and a retry with the same key and the same request answers the first response, byte for byte, with Idempotency-Replayed: true. Requires the digitisation.review 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

candidate_idstringRequired

Headers

Idempotency-Keystring or nullOptional

Request

Accept or reject a candidate: the digest of the candidate the reviewer saw.

candidate_sha256stringRequired

Response

The candidate, accepted; a replay under the same Idempotency-Key answers with Idempotency-Replayed: true

assessment_idstring
candidatemap from strings to any
candidate_sha256stringformat: "^[0-9a-f]{64}$"
colour_contract_versioninteger
created_atdatetime
derived_from_candidate_idstring or null
fieldsmap from strings to objects
idstring
review_statusenum
Allowed values:
reviewed_atdatetime or null
review_urlstring or nullOptional
reviewed_byobject or nullOptional

Who made a decision: user, a person in the Platform, or api_key. It names no person; the Platform shows who.

Errors

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