← Developer Portal
API docs by Redocly

CV Parser API (1.0.0)

Download OpenAPI specification:

API for uploading and processing CV files (PDF, DOCX, DOC, PPT, PPTX, TXT, HTML, RTF, JPG, PNG, XLS, XLSX, ODT, WPS, MSG, WPD). The file is analysed and the extracted data is returned as JSON.

Upload and process a CV

Supports three Content-Types: - multipart/form-data with a binary file - multipart/form-data with a base64-encoded file - application/json with a base64-encoded file Limits: maximum file size is 5 MB. Only the first 5 pages are processed; additional pages are accepted but ignored.

Authorizations:
ApiKeyAuth
Request Body schema:
required
One of
file
required
string <binary>

The CV file (supported formats: PDF, DOCX, DOC, PPT, PPTX, TXT, HTML, RTF, JPG, PNG, XLS, XLSX, ODT, WPS, MSG, WPD)

correlationId
required
string

Unique identifier for this request (your own reference)

language
string
Default: "nl"
Enum: "nl" "en" "de" "fr"

Language of the CV

country
string
Default: "NL"

Country of origin

Responses

Request samples

Content type
Example
{
  "correlationId": "mijn-referentie-001",
  "language": "nl",
  "country": "NL"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "personalData": {
    },
  • "socialMediaLinks": [
    ],
  • "drivingLicenses": [
    ],
  • "highestCompletedEducation": "string",
  • "highestCompletedInternationalEducation": "string",
  • "highestCompletedEducationCompletionDate": "2019-08-24",
  • "mostRecentEducation": "string",
  • "highestEducation": "string",
  • "highestInternationalEducation": "string",
  • "careerStage": "STUDENT",
  • "yearsSinceCompletionOfHighestCompletedEducation": 0,
  • "yearsOfRelevantWorkingExperience": 0,
  • "monthsOfRelevantWorkingExperience": 0,
  • "yearsOfWorkingExperience": 0,
  • "monthsOfWorkingExperience": 0,
  • "mostRecentJobTitle": "string",
  • "mostRecentEmployer": "string",
  • "summaryAbstractive": "string",
  • "profileDescription": {
    },
  • "educations": [
    ],
  • "experiences": [
    ],
  • "internships": [
    ],
  • "recommendations": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "languageSkills": [
    ],
  • "jobdiggerSkills": [
    ],
  • "headShotBase64Encoded": "string"
}