Read a colour Candidate
One of your candidates: its candidate document, which never changes, and its
review. review_status is pending until the candidate is accepted or
rejected, once, at reviewed_at. Another account’s candidate, and one that does
not exist, both answer 404 CANDIDATE_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
candidate_id
Response
The candidate
assessment_id
candidate
candidate_sha256
colour_contract_version
created_at
derived_from_candidate_id
fields
id
review_status
Allowed values:
reviewed_at
review_url
reviewed_by
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
503
Service Unavailable Error