ResumeParser API Guide

Parse resumes effortlessly with our powerful API. Follow our comprehensive guide to integrate resume parsing into your application.

API Endpoint Details

Endpoint

Method:POST
https://onlineresumeparser.com/api/v2/parser

Required Headers

  • Content-Type: multipart/form-data
  • X-API-Key: YOUR_API_KEY

Body Requirements

  • file: required (file) - The resume file to be parsed.
  • webhook_url: required (string) - The URL to receive the parsing results.
  • application_id: optional (string) - An identifier for the specific application.

Responses

  • 202 AcceptedThe resume processing has been initiated.
  • 400 Bad RequestInvalid input or missing file.
  • 500 Internal Server ErrorFailed to forward the request.

API Call Example

Select your preferred programming language to view the implementation example:

CURL Example
1
2    curl -X POST https://onlineresumeparser.com/api/v2/parser \
3    -H "Content-Type: multipart/form-data" \
4    -H "X-API-Key: YOUR_API_KEY" \
5    -F "file=@/path/to/resume.pdf" \
6    -F "webhook_url=https://yourwebhookurl.com" \
7    -F "application_id=12345"
8

Webhook Data Format

When the resume parsing is complete, we'll send a comprehensive data structure to your webhook URL. The response includes:

Resume Info

Document metadata, parsing date, language, and face detection

Personal Info

Contact details, location, basic information, availability, and driver's license

Work Experience

Work history, roles, responsibilities, contract types, and duration

Education

Academic background, degrees, institutions, and study periods

Job Title Prediction

Predicted job titles and associated ROME data

Languages

Known languages and proficiency levels

Skills

Hard skills, soft skills, and software proficiency

Certifications

Professional certifications and qualifications

Interests

Personal interests and hobbies

Data Dictionary

Education Level (EQF)

Based on the European Qualifications Framework (EQF). See the French equivalent qualifications

  • Level 1
    Basic general education
  • Level 2
    Basic vocational training (DNB/CFG)
  • Level 3
    Secondary education (CAP/BEP)
  • Level 4
    Upper secondary education (Baccalauréat)
  • Level 5
    Short-cycle tertiary education (BTS/DUT/DEUST)
  • Level 6
    Bachelor's or equivalent (Licence)
  • Level 7
    Master's or equivalent (Master/Diplôme d'ingénieur)
  • Level 8
    Doctoral or equivalent (Doctorat)
  • Other
    Qualifications outside the EQF framework

Experience Level

  • 0 to 1 year
  • 1 to 3 years
  • 3 to 5 years
  • 5 to 10 years
  • More than 10 years

Contract Type

  • Permanent contract
  • Fixed-term contract
  • Temporary assignment
  • Internship
  • Apprenticeship
  • Freelance
  • Volunteering
  • Other

Language Level

  • Native or Bilingual (C2)
  • Full Professional Proficiency (C1)
  • Professional Working Proficiency (B2)
  • Limited Working Proficiency (B1)
  • Advanced Basic Proficiency (A2)
  • Introductory Proficiency (A1)

Skill Type

  • Soft skill
  • Hard skill
  • Software skill

Additional Notes

  • All dates in the webhook response are formatted as YYYY-MM-DD
  • Boolean values are used for fields like current employment (currently_active) or ongoing education
  • Phone numbers are normalized to E.164 format (e.g., +33612345678)