Endpoint Reference

Batch Init

Name: EvalCV API
Rating: 4.9 (120 reviews)

Register candidates for a job by submitting signed document URLs (PDF, DOCX, TXT). Each resume is downloaded, parsed, validated, and stored in AWS S3 and DynamoDB. Multipart file uploads are not supported.

POST/v1/batch/init

Request Parameters

Name	Type	Description
job_idRequired	string	The target Job string identifier.
language	string	Optional document language.
candidatesRequired	array(object)	Array of candidate objects, each with a signed document_url (1 to 25).
candidates[].document_urlRequired	string	Signed HTTPS URL to download the resume (PDF, DOCX, TXT).
candidates[].name	string	Candidate display name (optional).
candidates[].external_candidate_id	string	Your own candidate identifier. We store and echo it back (optional).

Pro Tip

Always handle rate limiting headers in your logic. For best performance, use asynchronous processing for large files.

curl -X POST "https://api.evalcv.com/v1/batch/init" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "job_id": "YOUR_JOB_ID",
    "language": "en",
    "candidates": [
      {
        "name": "Jane Doe",
        "external_candidate_id": "ATS-0042",
        "document_url": "https://s3.amazonaws.com/bucket/resume1.pdf"
      },
      {
        "document_url": "https://s3.amazonaws.com/bucket/resume2.pdf"
      }
    ]
  }'