Documentation

CVReaderPro Documentation API

Automate CV parsing, matching, and generation for efficient and GDPR-compliant recruitment.

Key Features

Feature	Description	Delivery Method
Resume Parsing	Extract structured data (skills, experience, education, etc.) from a CV/Resume.	Synchronous (API Response)
CV/Job Offer Matching	Compare Resumes with your job offers to find the best candidates.	API or Webhook
Resume Generation	Generate standard or anonymized resumes according to your company's template.	Webhook or Email

1. Resume Parsing

Extract structured data from CV/Resume files (PDF, DOCX, etc.).

POST https://cvreader.fr/api/v1/parser

Headers:
- Authorization: ApiKey YOUR_API_KEY
- Accept: application/json (default) or application/xml
Body (multipart/form-data):
- file: CV/Resume file (PDF, DOCX, TXT, etc.)
- parserType: "DEFAULT" (fast) or "ADVANCED" (precise, recommended)

curl -X POST https://cvreader.fr/api/v1/parser   -H "Authorization: ApiKey YOUR_API_KEY"   -F "file=@/path/to/cv.pdf"   -F "parserType=ADVANCED"

Response

Returns a structured JSON including personal information (maskable), experiences, education, skills, and a unique Resume ID (resumeId).

{
  "resumeId": "c8cd44a0-d765-4d47-ba04-67903ef650e5",
  "documentType": "CV",
  "documentLanguage": "FR",
  "candidate": {
    "firstName": "Jean",
    "lastName": "Dupont"
  },
  "profile":"",
  "experienceLevel": "",
  "experiences": [],
  "educationLevel": "",
  "educations": [],
  "languages": [],
  "skills": [],
  "softSkills": [],
  "references": [],
  "hobbies": "",
  
}

2. CV/Job Offer Matching

Compare Resumes with your job offers to identify the best candidates.

Provide an API that returns your job offers in JobItem format.
Register your API URL in CVReaderPro (Settings → API Integrations).

Synchronous API Endpoint

POST https://cvreader.fr/api/scores/jobs-for-resume/{resumeId}

Headers:

Authorization: ApiKey YOUR_API_KEY

Response

{
  [
      {
        "id": "c561d0dd-4397-4a37-979f-87cf42bdb3a1",
        "jobId": "e918ab2f-d2f8-4890-b2d6-b049a76207a9",
        "candidateId": "96b029fc-568e-4e34-9e06-711216e92e22",
        "distance": "75.7km",
        "totalScore": 88.79,
        "profileScore": 0,
        "experienceScore": 6.65,
        "educationScore": 2.14,
        "languageScore": 25,
        "matchedKeywords": []
      }
   ]
}

Asynchronous API Endpoint

POST https://cvreader.fr/api/jobs/queue

Headers:

Authorization: ApiKey YOUR_API_KEY

Body

[
  "offre-123",
  "offre-456"
]

3. Resume Generation (Standard or Anonymized)

Generate resumes in PDF format with optional anonymization (masking of personal data).

POST https://cvreader.fr/api/resume-settings/format

How It Works

Configure anonymization rules in your subscriber area under "CV Settings".

Headers:

Authorization: ApiKey YOUR_API_KEY

Body


  [
    "resume-data-uuid-1",
    "a10288d7-b4ad-4181-8a45-2b7af9671b7c",
    "parsed-resume-unique-id-3"
  ]

Generated resumes are delivered with a download link (downloadUrl) via webhook or email.

🔧 Required Configuration

Parsing: No configuration required.
Matching: Implement a JobItem API and register the URL in CVReaderPro.
Generation: Configure anonymization rules and define a webhook or email.

📝 Use Cases

1. Automate Candidate Pre-screening

Parse received CVs → Obtain 'resumeId' values.
Send 'resumeId' and 'offerId' to /api/jobs/queue.
Receive scores via webhook → Sort CVs by 'totalScore'.

2. Fair Hiring with Anonymized CVs

Parse CVs → Obtain 'resumeIds'.
Configure anonymization in 'CV Settings' (mask name, photo, contact).

Error Management

HTTP	Cause	Solution
400	Malformed Request	Check the body format.
401	Invalid API Key	Check the 'Authorization' header.
404	Resource Not Found	Check 'resumeId'/'jobId'.
429	Too Many Requests	Reduce frequency or contact support.

Best Practices

Test in the sandbox environment before going to production.
Systematically anonymize CVs for sensitive roles.
Monitor your webhooks/emails for asynchronous results.
Securely archive original CVs (GDPR).

Support

Need help? Contact us.