Documentation
Everything you need to integrate Resume Mapper into your recruitment portal
Quick Start
Installation
1. Install the package
pnpm add @resume-mapper/widget2. Add the widget to your app
SignUpForm.tsx
import { ResumeMapper } from '@resume-mapper/widget'
function SignUpForm() {
const handleParsed = (result) => {
// Automatically fill form fields
setFirstName(result.rawData.personalInfo.firstName)
setLastName(result.rawData.personalInfo.lastName)
setEmail(result.rawData.personalInfo.email)
// ... more fields
}
return (
<div>
<h2>Upload your CV to auto-fill</h2>
<ResumeMapper
apiKey="rm_your_api_key"
onParsed={handleParsed}
locale="en"
/>
</div>
)
}REST API
Parse CV Endpoint
POST /api/parse
Request
terminal
curl -X POST https://resume-mapper.dev/api/parse \
-H "x-api-key: rm_your_api_key" \
-F "file=@resume.pdf"Response
response.json
{
"success": true,
"data": { /* Your mapped fields */ },
"rawData": {
"personalInfo": {
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"phone": "+1 555 123 4567",
"location": "San Francisco, CA"
},
"experience": [...],
"education": [...],
"skills": [...],
"languages": [...],
"certifications": [...],
"projects": [...]
},
"metadata": {
"fileName": "resume.pdf",
"parsedAt": "2024-01-15T10:30:00Z"
}
}Webhooks
Webhook Payload
Configure webhooks in your dashboard to receive parsed CV data automatically
webhook-payload.json
{
"event": "cv.parsed",
"data": { /* Your mapped fields */ },
"rawData": { /* Full parsed CV data */ },
"metadata": {
"fileName": "resume.pdf",
"parsedAt": "2024-01-15T10:30:00Z"
}
}Field Mapping (Pro)
Custom Field Mapping
Map CV fields to match your database schema
With Pro plan, you can configure custom field mappings in your dashboard to transform parsed CV data to match your exact database schema.
Available Source Fields
- personalInfo.firstName, lastName, email, phone, location, linkedIn, github, summary
- experience[].company, position, startDate, endDate, description
- education[].institution, degree, field, startDate, endDate
- skills[].name, level, category
- languages[].name, level
- certifications[].name, issuer, date
- projects[].name, description, technologies, url