Skip to Content
InvyteDocs
Candidates & evidence

Review a candidate

One Application's Candidate Review: profile, UMatch+, the current AI summary, the Job's evidence path with attempt lineage, and attributed recruiter notes. Never returns résumé files. Contact details only on request, to those who may contact the Job's candidates.

POST
/operations/candidates.review

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/candidates.review' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "jobId": "string",    "applicationId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "jobId": "string",    "applicationId": "string",    "candidate": {      "fullName": "string",      "location": "string",      "title": "string",      "company": "string",      "appliedAt": "string",      "lastActivityAt": "string",      "jobTitle": "string",      "email": "string",      "phone": "string"    },    "reviewPlacement": {      "status": "string",      "label": "string"    },    "boardSignal": null,    "evidencePath": [      null    ],    "umatch": null,    "aiSummary": null,    "resume": {      "readiness": "string",      "reasonCode": "string",      "experience": [        null      ],      "education": [        null      ],      "location": "string"    },    "issueFlags": null,    "recruiterNotes": [      {        "source": "human_recruiter_note",        "type": "string",        "stageId": "string",        "activityRunPublicId": "string",        "content": "string",        "rating": 0,        "authorName": "string",        "createdAt": "2019-08-24T14:15:22Z"      }    ],    "invitationDelivery": null,    "readiness": {      "shouldPoll": true,      "reasonCode": "string",      "lastUpdatedAt": "string"    },    "reviewUrl": "string"  },  "actionId": "string"}

Open a candidate's résumé POST

A short-lived link to the résumé file a candidate applied with, for a person to open. The link works for an hour; ask again for a fresh one. Read the résumé's content with candidates.review.

Search a Job's candidates POST

Find a Job's Applications by profile, UMatch+, Review Board column and named Interview evidence, with paging. Filtering or sorting by Interview score needs interviewActivityLabel; scores are never averaged across activities.