Help center
https://api.certo.bio/v1openapi.json
A candidate's checklist
GET
/v1/candidates/{id}/requirementsscope hiring:readWhat the organisation asked the candidate to have ready, item by item: ready, waiting or missing, gated by what the candidate shared.
As an MCP tool: get_candidate_checklist
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | uuid | Yes | The candidate's id from /candidates (the grant). |
Response fields
- items
- array of object. Each item asked for.
- items[].key
- string. The item: identity, work_history, education, certifications, roles, languages, right_to_work, contact or birth_date.
- items[].state
- one of ready, waiting, missing. ready: in; waiting: asked, not back yet; missing: the candidate still has to add or ask for it.
- items[].counts
- object. How many of the item's parts are in, such as {"ready": 3, "total": 4}.
- items[].detail
- string or null. What the item needs, where it says more than its state.
- complete
- boolean. Every item is ready.
- last_sent_at
- string or null. When the candidate last sent you the checklist (ISO 8601).
Errors
- 404 candidate.not_found
- 400 api.credential_in_url
- 401 api.key_invalid
- 401 api.key_expired
- 401 api.key_revoked
- 401 api.key_suspended
- 403 api.scope_missing
- 429 api.rate_limited