Skip to main content

Phase 1: Job setup (once per job)

1

Generate clarification questions (optional)

POST /v1/jobs/{jobId}/question-sets with your job context.Store questionSet.id and show questionSet.questions in your UI.
2

Generate criteria

POST /v1/jobs/{jobId}/criteria/generate with your job context.If you collected answers, include questionSetId and answers.
3

Refine criteria (optional)

Use the criteria management endpoints to add, edit, remove, or archive criteria. See criteria versioning for how changes affect scoring.

Phase 2: Application scoring (per application)

1

Generate a resume URL

Produce a public HTTPS URL. See supported formats for requirements.
2

Submit a scoring request

POST /v1/jobs/{jobId}/applications/{applicationId}/scoring-jobs with the resume object and jobDescription.Store scoringJob.id and scoringJob.criteriaVersionId for webhook correlation and polling.
3

Handle webhooks

Verify the signature and process score.completed and score.failed events. See webhooks.

Polling fallback

If you miss a webhook: GET /v1/jobs/{jobId}/applications/{applicationId}/scoring-jobs/{scoringJobId}