Practical guides for building with HireSignal API
Start from real hiring workflows: parse resumes, match candidates, rank batches, check resume quality, and prepare recruiter communication.
Docs vs guides
Docs explain each endpoint. Guides show which endpoints to combine for a useful product workflow.
Choose a workflow
Each guide points to the relevant API reference section and gives you the shape of the implementation flow.
Analyze uploaded resume files
POST /api/v1/analyze-match/files
Use the file analysis endpoint when users upload PDF, DOC, DOCX, or TXT resumes and you want parsing plus job matching in one flow.
- Collect resume files
- Attach the job description
- Return match scores and evidence
Rank a candidate batch
POST /api/v1/analyze-batch
Compare multiple parsed resumes against one role and return ordered results for shortlist, review, or screening queues.
- Extract resume text
- Send up to 15 candidates
- Sort results by match quality
Check resume quality
POST /api/v1/resume-checker
Score a resume for ATS fit, readability, professionalism, missing sections, keyword coverage, and improvement opportunities.
- Send resume text
- Review score categories
- Show targeted recommendations
Extract job requirements
POST /api/v1/extract-job-requirements
Turn messy job descriptions into structured role requirements that can power matching, filters, and scoring workflows.
- Send the job description
- Read required and preferred skills
- Store normalized keywords
Build a screening workflow
Multiple endpoints
Combine parsing, match scoring, ranking, and recruiter review into a simple end-to-end resume screening pipeline.
- Parse resumes
- Analyze matches
- Rank candidates
- Prepare next steps
Prepare candidate emails
POST /api/v1/generate-candidate-email
Generate recruiter-ready candidate messages for interview invites, next steps, rejection, hold, or application received flows.
- Choose the decision
- Generate a reviewed draft
- Send only after approval
Recommended integration paths
Pick the pattern that matches where resume data enters your product.
File-first products
Best for ATS tools, job boards, and upload-heavy products where resume files arrive before clean text exists.
Text-first automations
Best for CRMs, no-code tools, and backend jobs that already extracted resume text before calling the API.
Candidate communication
Best for teams that want consistent recruiter messaging with a human review step before delivery.
Need endpoint details?
Use the docs for exact request bodies, response examples, errors, and OpenAPI metadata.