ZenHire CV DeepMatch API
Asynchronous CV-to-Job-Description matching. Submit a candidate's CV
(PDF) along with a job description and a requirements configuration,
receive an id, then either poll the status endpoint or wait
for the webhook callback to deliver the final match result.
All endpoints require an X-API-Key header. The calling client's
permissions[] must contain cvdeepmatch — contact support to
enable.
File support at launch
- PDF only. DOCX support is on the roadmap (tracked as AWS Issue
#2). DOCX uploads are rejected with
INVALID_INPUT. - 5 MB maximum per CV.
Webhook callback
Match results are delivered to your webhook_url as a POST with
HMAC-SHA256 signature in the X-CVDM-Signature header (Stripe-style
t=<unix-ts>,v1=<hex>). See the
CV DeepMatch integration guide for the
verification snippet.
Polling
Minimum interval between polls for the same id is 10
seconds. Faster polls return 429 with a Retry-After header.
Authentication
- API Key: ApiKeyAuth
API key issued in the ZenHire dashboard. Format: zh_live_… or zh_test_….
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |