API request
POSTProject API key required
/v1/resumes/parse
- Multipart files[] upload
- x-api-key authentication
- Idempotency key for retries
Resume Parsing API
Turn resume files into structured data.
Extract contact details, experience, education and skills from resumes. Submit files through the CVault API and retrieve parsing data for your own application.
- Structured parsing data
- Project-scoped API keys
- Signed job webhooks
Illustrative API flow; not a live parse
Example files
5 documentsNo.FileFormatFilesOutcome
Document outcome
Succeededresume.pdf · 1 file in example
Handle each document outcome, including failures.
✓Structured API resultsRetrieve separately after processing
API controls
3 operations- ✓Authenticate with a project keyaccess
- ✓Retry with the same idempotency keyretry
- ✓Request job erasure when neededcleanup
Output groups
3Groups
- Contact details2
- Experience & education2
- Skills & other fields1
01 / Parser capabilities
Resume files. Structured fields. A documented API.
Read contact details, summary, experience, education, skills, languages and certifications from parsing results. The limits below describe the public contract, not accuracy or speed benchmarks.
Native processing
OCR processing
- Top-level output groups Reported by GET /v1/schema
- Accepted file formats Documents and images
- Maximum size per file Batch and project limits also apply
- Files per upload session Declaration limit; byte limits still apply
credit for native credits for OCR MiB per file files per upload session
From resume file to API result
Four steps. One integration.
Prepare your files, submit a job, follow its status and retrieve the parsing data. Use the docs for the complete request and response contracts.
Use an accepted file format and check the file size. Create a project API key and keep it on your server. Do not place it in browser code.
Send multipart files directly, or complete an upload session. Keep the same idempotency key when retrying the same operation and content.
Store data.job_id. Poll the job or subscribe to signed webhook events. A batch can have both successful and failed documents.
Fetch projected parsing results separately. Follow next_cursor whenever has_more is true. Handle missing values and preserve unknown fields.
resume.pdf / local file
Prepare the upload
Accepted formats: PDF, DOCX, DOC, TXT, PNG, JPG and JPEG.
Files must pass type, size and malware validation.
A project API key is required for submission.
Request fieldsMultipart form
Headerx-api-key: <project-key>
HeaderIdempotency-Key: first-resume-0001
Filefiles[]: resume.pdf
EndpointPOST /v1/resumes/parse
03 / Security and trust
Resume data needs clear boundaries.
Use project-scoped API keys, verify webhook signatures and handle deletion explicitly. Confirm deployment terms before sending production resume data.
Available nowCustomer scopedPolicy commitment
Keys belong to a project and environment. Endpoint scopes control the operations a key can perform. Store keys in a secret manager.
Deliveries use HMAC-SHA256 with a timestamp and nonce. Verify the original request bytes, freshness and delivery identity.
Customer resumes are not used to train models by default. Confirm deployment-specific model and provider terms.
Data-processing terms are reviewed and agreed for the deployment scope.
Accepted erasure blocks result reads. Source, result and cache cleanup can remain pending; poll until erased. External copies need their own lifecycle.
04 / Pricing
Start with free credits. Add capacity.
Choose parser credits for your workload. Native processing costs 1 credit per document; OCR costs 3 credits total. Paid packs are planned and not yet on sale.
Example credit consumption for OCR12 native credits across 12 documents.
12
41424
Native12 credits
OCR36 credits
Free
Try the parser
USD 0No card
100 free credits once, subject to eligibility and account provisioning. Inspect the static Playground sample for free.
- 100 parser credits
- Up to 100 native documents
- Or up to 33 OCR documents
- No credit expiry
- Same API and schema
Planned pack
Starter
Your first integration
USD 39one-time planned price
A planned credit pack for applications starting to process resumes. Contact us about availability.
- 1,250 parser credits
- Up to 1,250 native documents
- Or up to 416 OCR documents
- No credit expiry
- No recurring subscription
Not yet on sale. USD prices exclude applicable taxes.
Not yet on sale
Growth
More parsing capacity
USD 149one-time planned price
A larger planned credit pack for higher document volumes. Project quotas and rate limits still apply.
- 6,500 parser credits
- Up to 6,500 native documents
- Or up to 2,166 OCR documents
- No credit expiry
- No recurring subscription
Not yet on sale. USD prices exclude applicable taxes.
Credit capacities assume all documents use one processing mode. Paid packs are not on sale yet. Contact us for enterprise requirements.
05 / Questions
Questions to answer before integrating.
File formats, results, evidence limits, data handling and parser credit availability.
Structured parsing data covering contact details, summary, experience, education, skills, languages and certifications. Handle missing values and preserve unknown fields. GET /v1/schema reports top-level capabilities; it is not a complete nested JSON Schema.
PDF, DOCX, DOC, TXT, PNG, JPG and JPEG are accepted, up to 10 MiB per file. Batch limits, validation, project quotas and rate limits also apply.
Yes. Direct multipart submission accepts multiple files. Upload sessions let you declare files, upload each whole file to its signed URL, then complete the session. An upload session can declare up to 1,000 files; byte limits and quotas still apply.
Store data.job_id from the submission response. Poll the job or receive signed webhook events, then fetch results separately. Follow next_cursor when has_more is true and handle each document's outcome.
Do not assume it does. The standard public submission contract does not expose a selectable none/compact/full evidence mode. A processing workspace can add its selected-field projection, evidence and validation result; see the workspace guide for that contract.
No model training by default is CVault's policy commitment. Confirm deployment-specific model providers and data-processing terms before sending production resume data.
100 parser credits once, subject to eligibility and account provisioning, with no card required. Native processing costs 1 credit per successful document; OCR costs 3 credits total. The Playground's static sample is always free.
Paid packs are not on sale yet. Starter and Growth show planned one-time USD prices before applicable taxes. Credits do not expire and packs do not renew automatically. Contact us about availability or an enterprise workload.
Build with the Resume Parsing API