Skip to Content
InvyteDocs

Compare candidates

Compare 2–5 Applications of one Job like with like: UMatch+, each named Interview and each Job Workflow Playground activity separately. Scores are never combined across unlike activities.

POST
/operations/candidates.compare

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.compare' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "jobId": "string",    "applicationIds": [      "string",      "string"    ]  }}'
Example Response
{  "status": "done",  "output": {    "jobId": "string",    "candidates": [      {        "applicationId": "string",        "candidateName": "string",        "candidate": {          "location": "string",          "title": "string",          "company": "string",          "appliedAt": "string",          "reviewStatus": "string"        },        "umatch": {          "score": 0,          "readiness": "string",          "reasonCode": "string",          "detailReadiness": "string",          "skillsScore": 0,          "experienceScore": 0,          "educationScore": 0,          "verificationScore": 0,          "potentialScore": 0,          "yearsExperience": 0,          "careerLevel": "string",          "interviewReadiness": "string",          "domains": [            "string"          ],          "flags": null        },        "interviewActivities": [          {            "activityLabel": "string",            "activityType": "string",            "activityRunPublicId": "string",            "canonical": true,            "status": "string",            "readiness": "string",            "reasonCode": "string",            "score": 0,            "summary": "string",            "integrityWarning": "string"          }        ],        "playgroundActivities": [          {            "activityLabel": "string",            "activityType": "string",            "activityRunPublicId": "string",            "canonical": true,            "status": "string",            "readiness": "string",            "reasonCode": "string",            "score": 0,            "summary": "string",            "integrityWarning": "string"          }        ]      }    ]  },  "actionId": "string"}