Resume Parsing & Intelligence
This collection provides endpoints for parsing, analyzing, and enriching resumes. Upload resumes in plain text, PDF, or DOCX format to extract structured data, detect bias, verify details, and generate analysis.
Available APIs
Resume Parsing
POST
Parse Resume
Parses a resume from plain text, PDF, or DOCX. Returns a `resumeId` and parsing status.
If parsing is complete, the parsed resume is included in the response; otherwise, poll `GET /resumes/{id}` or subscribe to the `resume.parsed` webhook to get the result. This endpoint is idempotent, submitting the same resume won't create duplicates.
The resume file must be sent as a `multipart/form-data` upload.
See the [Resume schema](/schema-reference#resume) for the structure of a parsed resume.
/v1/resumes
View APIGET
Retrieve Parsed Resume
Retrieves the parsed resume by ID.
If parsing is still in progress, the response will include `resumeId`, `status`, and `data` (which will be `null`).
Once parsing is complete, the full Resume object is returned.
/v1/resumes/{id}
View APIGET
Resume Analysis
Returns AI-generated analysis of a parsed resume, including career progression, skill alignment, and role fit.
The response includes experience level, education level, industry tags, suitable job titles, and core technologies. It also provides a career progression rating, AI-generated summary, key highlights, and any detected red flags. If parsing inferred a location, it will be included.
See the ResumeAnalysis schema for the full response structure.
/v1/resumes/{id}/analysis
View APIResume Verification
POST
Verification
Verifies resume content such as education, work history, and contact details using available external sources.
/v1/verifications
View APIGET
Get Verification
Retrieves a single verification result by its verification ID.
/v1/verifications/{id}
View APIGET
Search Verifications
Searches verification results using filters such as resumeId, type, status, or date range. Supports pagination.
/v1/verifications
View APIResume Redaction
POST
Create PII Redaction
Creates a redacted version of the parsed resume. Specify which fields and targets to redact; the response returns a redactionId, the list of redacted fields, and the redacted resume.
/v1/resumes/{id}/redactions
View APIGET
Get PII Redaction
Retrieves a previously created redacted resume by redactionId.
/v1/resumes/{id}/redactions/{redactionId}
View APIResume Templates
POST
Create Template
Creates a new resume template. Provide HTML with inline CSS and Mustache variables.
/v1/templates
View APIPATCH
Update Template
Updates a resume template’s HTML or metadata.
/v1/templates/{id}
View APIGET
Get Template
Retrieves a single resume template by ID. Returns HTML with inline CSS and metadata.
/v1/templates/{id}
View APIGET
List Templates
Retrieves templates for the organization. Supports filtering and pagination. Returns summaries by default (no HTML) for faster listing.
/v1/templates
View API