CVault
Explore synthetic demo
Menu

Developer docs

Connect CVault without losing evidence or review context.

Start with API-key authentication, parser requests, job status, result retrieval, and webhooks. The docs stay concise until an endpoint is reviewed.

What APIs and workflows are available, and how do I start safely?

Review access optionsDeveloper overview
Technical workflow
POST/api/portal/parse_cv_batch_parallel
{

"candidate": "review-safe payload",
"evidence": ["source snippet", "confidence"],
"event": "parse.completed"

}
CVault fieldATS fieldreview_statuscandidate.noteevidence_refsattachment.meta

Integration path

The public docs cover the stable workflow groups buyers ask about first.

  1. Create a scoped key

    Use workspace API keys and keep credentials out of client-side code.

  2. Parse or enrich resumes

    Send permitted files and receive structured candidate fields with review context.

  3. Poll long-running jobs

    Use job status and results endpoints for larger batches or heavier processing.

  4. Handle events

    Subscribe to parse completion or failure events and verify signatures server-side.

API surface

Endpoint groups

Resume parsing

Upload permitted PDF, DOCX, DOC, or text resumes for structured candidate output.

Job status and results

Track asynchronous parse work and retrieve paginated output when processing completes.

Webhooks

Receive signed parse completion and failure events in your own backend.

Minimal parser request
curl -X POST https://cvault.tech/api/portal/parse_cv_batch_parallel \
  -H "x-api-key: cv_live_your_key_here" \
  -F "files[][email protected]" \
  -F "job_description=Senior backend engineer with PostgreSQL experience"

Reviewed rollout

Need an integration reviewed?

Start with one workflow and confirm the payload shape before committing to a wider platform connection.

Review access options