Skip to main content
This guide walks through the full integration flow from job setup to candidate scoring.

​
Phase 1: Job setup

Run this once per job.
1

Generate clarification questions (optional)

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

Generate criteria

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

Optional: refine criteria

Use the criteria management endpoints to add, edit, remove, or archive criteria.

Criteria Management

View all criteria endpoints

Criteria Versioning

Understand how versions affect scoring

​
Phase 2: Application scoring

Run this for each application.
1

Generate a resume URL

Generate a public HTTPS URL for the resume file.
See Supported Formats for format and URL requirements.
2

Submit a scoring request

Call POST /v1/jobs/{jobId}/applications/{applicationId}/scoring-jobs with the resumeUrl and jobDescription.Store scoringJob.id and scoringJob.criteriaVersionId so you can correlate webhooks, poll later, and fetch the exact criteria snapshot used for scoring via GET /v1/jobs/{jobId}/criteria/versions/{criteriaVersionId}.
3

Handle webhooks

Verify the signature and process score.completed and score.failed events.See Webhooks for signature verification and headers.

​
Polling fallback

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