Skip to navigation

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_idstringRequired

Response

The candidate
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
503
Service Unavailable Error