Skip to Content
API ReferencePOST /score/requirements

Check which requirements a candidate meets

POST /score/requirements

Deterministic gate check — no LLM, no embeddings: taxonomy-ID and canonical skill matching, min-years vs computed tenure, seniority and experience gaps. Use it to pre-filter pools cheaply before full /match calls.

Requires parsed candidate and role JSON (no raw-document inputs).

Cost: 1 credit.

Request body

FieldTypeDescription
candidateobjectNormalized candidate (résumé) JSON. Dates render as YYYY-MM when the month is known, YYYY otherwise. Rezmatch.ai never stores this — it exists only in the response. (required)
roleobjectNormalized role (job description) JSON. (required)

Example request

curl -X POST "https://api.rezmatch.ai/score/requirements" \ -H "x-access-key: $TALENTKIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'

Example response

{ "success": true, "data": { "met": [ { "requirement": "Go (3+ years)", "severity": "must_have", "status": "met", "evidence": "Go" } ], "missed": [ { "requirement": "Kafka", "severity": "must_have", "status": "missed", "evidence": null } ], "coverage": { "must_have": 0.5, "nice_to_have": 1 } }, "credits_used": 1, "request_id": "req_bc88de56-9efc-4be8-9ae1-22cf86d86ca5" }

Errors

StatusMeaning
401invalid_key — missing, unknown, or revoked access key
402insufficient_credits — top up in the dashboard; the failed call is not charged
422missing_candidate / missing_role

All errors share the error envelope.

Try it

Open this endpoint in the interactive playground  — requests run with your API key.

Last updated on