Parse Resume

curl --request POST \
  --url https://api.harmonyforstaffing.com/resume/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'file=@/path/to/resume.pdf' \
  --form candidate_id=1234

curl --request POST \
  --url https://api.harmonyforstaffing.com/resume/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'file_url=https://example.com/path/to/resume.pdf' \
  --form candidate_id=1234

{
  "personalInfo": {
    "name": {
      "firstName": "Jane",
      "lastName": "Smith",
      "middleName": "Marie"
    },
    "contact": {
      "email": "jane.smith@email.com",
      "phone": "+12125551234",
      "alternativePhone": "+12125555678",
      "linkedIn": "https://linkedin.com/in/janesmith"
    },
    "location": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipCode": "94143",
      "country": "USA",
      "willingToRelocate": true
    }
  },
  "professionalSummary": {
    "overview": "Experienced ICU nurse with 5+ years specializing in critical care...",
    "yearsOfExperience": 5,
    "specialtyExperience": [
      {
        "specialty": "ICU",
        "totalYears": 3,
        "lastPracticed": "2024-03-01"
      },
      {
        "specialty": "ER",
        "totalYears": 2,
        "lastPracticed": "2021-02-15"
      }
    ]
  },
  "workHistory": [
    {
      "employer": "Saint Francis Hospital",
      "title": "ICU Nurse",
      "location": {
        "city": "San Francisco",
        "state": "CA",
        "remote": false
      },
      "startDate": "2021-03-01",
      "endDate": null,
      "isCurrent": true,
      "monthsInRole": 36,
      "specialty": "ICU",
      "responsibilities": [
        "Provide critical care to patients in 20-bed ICU",
        "Mentor new nursing staff",
        "Coordinate with interdisciplinary care team"
      ],
      "technologies": [
        "EPIC EMR",
        "Philips Patient Monitoring Systems",
        "Pyxis MedStation"
      ],
      "skills": [
        {
          "name": "Critical Care",
          "category": "Clinical",
          "context": "Primary ICU nurse managing complex patient cases"
        },
        {
          "name": "Team Leadership",
          "category": "Management",
          "context": "Led team of 4 nurses during night shifts"
        },
        {
          "name": "EPIC EMR",
          "category": "Technical",
          "context": "Daily charting and order management"
        }
      ],
      "projectHighlights": [
        {
          "name": "ICU Protocol Optimization",
          "description": "Led initiative to update ventilator weaning protocols",
          "outcomes": [
            "Reduced average ventilator days by 15%",
            "Improved patient outcomes with 20% faster recovery times"
          ]
        },
        {
          "name": "New Nurse Orientation Program",
          "description": "Developed and implemented improved orientation program",
          "outcomes": [
            "Trained 12 new ICU nurses",
            "Reduced orientation period by 2 weeks"
          ]
        }
      ]
    },
    {
      "employer": "Memorial Hospital",
      "title": "ER Nurse",
      "location": {
        "city": "Oakland",
        "state": "CA",
        "remote": false
      },
      "startDate": "2019-06-01",
      "endDate": "2021-02-15",
      "isCurrent": false,
      "monthsInRole": 20,
      "specialty": "Emergency",
      "responsibilities": [
        "Managed care for critical emergency patients",
        "Triaged incoming patients",
        "Coordinated with trauma teams"
      ],
      "technologies": [
        "Meditech EMR",
        "Emergency Department Information System",
        "Automated Medication Dispensing System"
      ],
      "skills": [
        {
          "name": "Emergency Care",
          "category": "Clinical",
          "context": "Primary ER nurse handling trauma cases"
        },
        {
          "name": "Triage",
          "category": "Clinical",
          "context": "Lead triage nurse during high-volume periods"
        }
      ],
      "projectHighlights": [
        {
          "name": "Triage Process Improvement",
          "description": "Implemented new triage assessment tools",
          "outcomes": [
            "Reduced wait times by 25%",
            "Improved patient satisfaction scores by 30%"
          ]
        }
      ]
    }
  ],
  "education": [
    {
      "institution": "University of California, San Francisco",
      "degree": "Bachelor of Science",
      "major": "Nursing",
      "minor": "Public Health",
      "graduationDate": "2019-05-15",
    }
  ],
  "certifications": [
    {
      "name": "ACLS",
      "issuingOrganization": "American Heart Association",
      "issueDate": "2023-01-15",
      "expirationDate": "2025-01-15"
    },
    {
      "name": "BLS",
      "issuingOrganization": "American Heart Association",
      "issueDate": "2023-03-01",
      "expirationDate": "2025-03-01"
    }
  ],
  "skills": {
    "technical": [
      {
        "category": "EPIC EMR",
        "skills": [
          {
            "name": "EPIC EMR",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      },
      {
        "category": "IV Administration",
        "skills": [
          {
            "name": "IV Administration",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      },
      {
        "category": "Ventilator Management",
        "skills": [
          {
            "name": "Ventilator Management",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      }
    ],
    "softSkills": [
      "Team Leadership",
      "Critical Thinking",
      "Patient Education"
    ],
    "languages": [
      {
        "language": "English",
        "proficiency": "Native"
      },
      {
        "language": "Spanish",
        "proficiency": "Conversational"
      }
    ]
  },
  "additionalInfo": {
    "employmentGaps": [
    {
        "gapType": "Gap in Experience",
        "duration": "1 year",
        "reason": "Career Break"
    },
    {
        "gapType": "Gap in Experience",
        "duration": "2 years",
        "reason": "Career Break"
    }
    ]
  }
}

POST

resume

parse

curl --request POST \
  --url https://api.harmonyforstaffing.com/resume/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'file=@/path/to/resume.pdf' \
  --form candidate_id=1234

curl --request POST \
  --url https://api.harmonyforstaffing.com/resume/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'file_url=https://example.com/path/to/resume.pdf' \
  --form candidate_id=1234

{
  "personalInfo": {
    "name": {
      "firstName": "Jane",
      "lastName": "Smith",
      "middleName": "Marie"
    },
    "contact": {
      "email": "jane.smith@email.com",
      "phone": "+12125551234",
      "alternativePhone": "+12125555678",
      "linkedIn": "https://linkedin.com/in/janesmith"
    },
    "location": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipCode": "94143",
      "country": "USA",
      "willingToRelocate": true
    }
  },
  "professionalSummary": {
    "overview": "Experienced ICU nurse with 5+ years specializing in critical care...",
    "yearsOfExperience": 5,
    "specialtyExperience": [
      {
        "specialty": "ICU",
        "totalYears": 3,
        "lastPracticed": "2024-03-01"
      },
      {
        "specialty": "ER",
        "totalYears": 2,
        "lastPracticed": "2021-02-15"
      }
    ]
  },
  "workHistory": [
    {
      "employer": "Saint Francis Hospital",
      "title": "ICU Nurse",
      "location": {
        "city": "San Francisco",
        "state": "CA",
        "remote": false
      },
      "startDate": "2021-03-01",
      "endDate": null,
      "isCurrent": true,
      "monthsInRole": 36,
      "specialty": "ICU",
      "responsibilities": [
        "Provide critical care to patients in 20-bed ICU",
        "Mentor new nursing staff",
        "Coordinate with interdisciplinary care team"
      ],
      "technologies": [
        "EPIC EMR",
        "Philips Patient Monitoring Systems",
        "Pyxis MedStation"
      ],
      "skills": [
        {
          "name": "Critical Care",
          "category": "Clinical",
          "context": "Primary ICU nurse managing complex patient cases"
        },
        {
          "name": "Team Leadership",
          "category": "Management",
          "context": "Led team of 4 nurses during night shifts"
        },
        {
          "name": "EPIC EMR",
          "category": "Technical",
          "context": "Daily charting and order management"
        }
      ],
      "projectHighlights": [
        {
          "name": "ICU Protocol Optimization",
          "description": "Led initiative to update ventilator weaning protocols",
          "outcomes": [
            "Reduced average ventilator days by 15%",
            "Improved patient outcomes with 20% faster recovery times"
          ]
        },
        {
          "name": "New Nurse Orientation Program",
          "description": "Developed and implemented improved orientation program",
          "outcomes": [
            "Trained 12 new ICU nurses",
            "Reduced orientation period by 2 weeks"
          ]
        }
      ]
    },
    {
      "employer": "Memorial Hospital",
      "title": "ER Nurse",
      "location": {
        "city": "Oakland",
        "state": "CA",
        "remote": false
      },
      "startDate": "2019-06-01",
      "endDate": "2021-02-15",
      "isCurrent": false,
      "monthsInRole": 20,
      "specialty": "Emergency",
      "responsibilities": [
        "Managed care for critical emergency patients",
        "Triaged incoming patients",
        "Coordinated with trauma teams"
      ],
      "technologies": [
        "Meditech EMR",
        "Emergency Department Information System",
        "Automated Medication Dispensing System"
      ],
      "skills": [
        {
          "name": "Emergency Care",
          "category": "Clinical",
          "context": "Primary ER nurse handling trauma cases"
        },
        {
          "name": "Triage",
          "category": "Clinical",
          "context": "Lead triage nurse during high-volume periods"
        }
      ],
      "projectHighlights": [
        {
          "name": "Triage Process Improvement",
          "description": "Implemented new triage assessment tools",
          "outcomes": [
            "Reduced wait times by 25%",
            "Improved patient satisfaction scores by 30%"
          ]
        }
      ]
    }
  ],
  "education": [
    {
      "institution": "University of California, San Francisco",
      "degree": "Bachelor of Science",
      "major": "Nursing",
      "minor": "Public Health",
      "graduationDate": "2019-05-15",
    }
  ],
  "certifications": [
    {
      "name": "ACLS",
      "issuingOrganization": "American Heart Association",
      "issueDate": "2023-01-15",
      "expirationDate": "2025-01-15"
    },
    {
      "name": "BLS",
      "issuingOrganization": "American Heart Association",
      "issueDate": "2023-03-01",
      "expirationDate": "2025-03-01"
    }
  ],
  "skills": {
    "technical": [
      {
        "category": "EPIC EMR",
        "skills": [
          {
            "name": "EPIC EMR",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      },
      {
        "category": "IV Administration",
        "skills": [
          {
            "name": "IV Administration",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      },
      {
        "category": "Ventilator Management",
        "skills": [
          {
            "name": "Ventilator Management",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      }
    ],
    "softSkills": [
      "Team Leadership",
      "Critical Thinking",
      "Patient Education"
    ],
    "languages": [
      {
        "language": "English",
        "proficiency": "Native"
      },
      {
        "language": "Spanish",
        "proficiency": "Conversational"
      }
    ]
  },
  "additionalInfo": {
    "employmentGaps": [
    {
        "gapType": "Gap in Experience",
        "duration": "1 year",
        "reason": "Career Break"
    },
    {
        "gapType": "Gap in Experience",
        "duration": "2 years",
        "reason": "Career Break"
    }
    ]
  }
}

Upload and parse a resume file to extract structured information about the candidate’s experience, skills, education, and other relevant details.

Body Parameters

file

The resume file to parse (PDF, DOC, DOCX, TXT)

string

URL to a resume file to download and parse

integer

ATS ID of the candidate this resume belongs to (optional)

You must provide either file or file_url, but not both.

curl --request POST \
  --url https://api.harmonyforstaffing.com/resume/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'file=@/path/to/resume.pdf' \
  --form candidate_id=1234

curl --request POST \
  --url https://api.harmonyforstaffing.com/resume/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'file_url=https://example.com/path/to/resume.pdf' \
  --form candidate_id=1234

Response Fields

object

Basic information about the candidate

Show Personal Info Object

object

string

First name of the candidate

string

Last name of the candidate

string

Middle name or initial if available

object

string

Primary email address

string

Phone number in E.164 format

string

Alternative phone number in E.164 format

string

LinkedIn profile URL

object

string

Street address

string

City of residence

string

State/province code

string

Postal/ZIP code

string

default:"USA"

Country of residence

boolean

Whether candidate is open to relocation

object

Overview of professional background

Show Summary Object

string

Brief professional summary

number

Total years of experience

array

Experience breakdown by specialty

Show Specialty Object

string

Specialty area (e.g., “ICU”)

number

Years in this specialty

string

Last date in specialty (YYYY-MM-DD)

array

Different settings where specialty was practiced

array

List of primary skills and competencies

array

Specific industries worked in

array

Employment history in reverse chronological order

Show Work History Object

string

Company/organization name

string

Job title/position

object

string

City name

string

State code

boolean

Whether position was remote

string

Start date (YYYY-MM-DD)

string

End date (YYYY-MM-DD)

boolean

Whether this is the current position

number

Duration in months

string

Primary specialty in role

array

Key job duties

array

Technologies/tools used

array

Skills demonstrated in this role

Show Skill Object

string

Name of the skill

string

Category of skill

string

How the skill was used

array

Notable projects

Show Project Object

string

Project name

string

Project description

array

Measurable achievements

array

Educational background

Show Education Object

string

School name

string

Degree earned

string

Field of study

string

Secondary field of study

string

Graduation date (YYYY-MM-DD)

array

Professional certifications

Show Certification Object

string

Certification name

string

Issuing body

string

Issue date (YYYY-MM-DD)

string

Expiration date (YYYY-MM-DD)

string

Certification number or identifier

object

Professional skills and competencies

Show Skills Object

array

Technical skills by category

Show Technical Category

string

Skill category

array

Show Skill Object

string

Name of the skill

number

Years of experience

string

One of: Beginner, Intermediate, Advanced, Expert

array

Interpersonal skills

array

Language proficiencies

Show Language Object

string

Language name

string

One of: Basic, Conversational, Professional, Native/Bilingual

object

Additional candidate information

Show Additional Info Object

array

Employment gaps in work history

{
  "personalInfo": {
    "name": {
      "firstName": "Jane",
      "lastName": "Smith",
      "middleName": "Marie"
    },
    "contact": {
      "email": "jane.smith@email.com",
      "phone": "+12125551234",
      "alternativePhone": "+12125555678",
      "linkedIn": "https://linkedin.com/in/janesmith"
    },
    "location": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipCode": "94143",
      "country": "USA",
      "willingToRelocate": true
    }
  },
  "professionalSummary": {
    "overview": "Experienced ICU nurse with 5+ years specializing in critical care...",
    "yearsOfExperience": 5,
    "specialtyExperience": [
      {
        "specialty": "ICU",
        "totalYears": 3,
        "lastPracticed": "2024-03-01"
      },
      {
        "specialty": "ER",
        "totalYears": 2,
        "lastPracticed": "2021-02-15"
      }
    ]
  },
  "workHistory": [
    {
      "employer": "Saint Francis Hospital",
      "title": "ICU Nurse",
      "location": {
        "city": "San Francisco",
        "state": "CA",
        "remote": false
      },
      "startDate": "2021-03-01",
      "endDate": null,
      "isCurrent": true,
      "monthsInRole": 36,
      "specialty": "ICU",
      "responsibilities": [
        "Provide critical care to patients in 20-bed ICU",
        "Mentor new nursing staff",
        "Coordinate with interdisciplinary care team"
      ],
      "technologies": [
        "EPIC EMR",
        "Philips Patient Monitoring Systems",
        "Pyxis MedStation"
      ],
      "skills": [
        {
          "name": "Critical Care",
          "category": "Clinical",
          "context": "Primary ICU nurse managing complex patient cases"
        },
        {
          "name": "Team Leadership",
          "category": "Management",
          "context": "Led team of 4 nurses during night shifts"
        },
        {
          "name": "EPIC EMR",
          "category": "Technical",
          "context": "Daily charting and order management"
        }
      ],
      "projectHighlights": [
        {
          "name": "ICU Protocol Optimization",
          "description": "Led initiative to update ventilator weaning protocols",
          "outcomes": [
            "Reduced average ventilator days by 15%",
            "Improved patient outcomes with 20% faster recovery times"
          ]
        },
        {
          "name": "New Nurse Orientation Program",
          "description": "Developed and implemented improved orientation program",
          "outcomes": [
            "Trained 12 new ICU nurses",
            "Reduced orientation period by 2 weeks"
          ]
        }
      ]
    },
    {
      "employer": "Memorial Hospital",
      "title": "ER Nurse",
      "location": {
        "city": "Oakland",
        "state": "CA",
        "remote": false
      },
      "startDate": "2019-06-01",
      "endDate": "2021-02-15",
      "isCurrent": false,
      "monthsInRole": 20,
      "specialty": "Emergency",
      "responsibilities": [
        "Managed care for critical emergency patients",
        "Triaged incoming patients",
        "Coordinated with trauma teams"
      ],
      "technologies": [
        "Meditech EMR",
        "Emergency Department Information System",
        "Automated Medication Dispensing System"
      ],
      "skills": [
        {
          "name": "Emergency Care",
          "category": "Clinical",
          "context": "Primary ER nurse handling trauma cases"
        },
        {
          "name": "Triage",
          "category": "Clinical",
          "context": "Lead triage nurse during high-volume periods"
        }
      ],
      "projectHighlights": [
        {
          "name": "Triage Process Improvement",
          "description": "Implemented new triage assessment tools",
          "outcomes": [
            "Reduced wait times by 25%",
            "Improved patient satisfaction scores by 30%"
          ]
        }
      ]
    }
  ],
  "education": [
    {
      "institution": "University of California, San Francisco",
      "degree": "Bachelor of Science",
      "major": "Nursing",
      "minor": "Public Health",
      "graduationDate": "2019-05-15",
    }
  ],
  "certifications": [
    {
      "name": "ACLS",
      "issuingOrganization": "American Heart Association",
      "issueDate": "2023-01-15",
      "expirationDate": "2025-01-15"
    },
    {
      "name": "BLS",
      "issuingOrganization": "American Heart Association",
      "issueDate": "2023-03-01",
      "expirationDate": "2025-03-01"
    }
  ],
  "skills": {
    "technical": [
      {
        "category": "EPIC EMR",
        "skills": [
          {
            "name": "EPIC EMR",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      },
      {
        "category": "IV Administration",
        "skills": [
          {
            "name": "IV Administration",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      },
      {
        "category": "Ventilator Management",
        "skills": [
          {
            "name": "Ventilator Management",
            "yearsOfExperience": 3,
            "proficiencyLevel": "Advanced"
          }
        ]
      }
    ],
    "softSkills": [
      "Team Leadership",
      "Critical Thinking",
      "Patient Education"
    ],
    "languages": [
      {
        "language": "English",
        "proficiency": "Native"
      },
      {
        "language": "Spanish",
        "proficiency": "Conversational"
      }
    ]
  },
  "additionalInfo": {
    "employmentGaps": [
    {
        "gapType": "Gap in Experience",
        "duration": "1 year",
        "reason": "Career Break"
    },
    {
        "gapType": "Gap in Experience",
        "duration": "2 years",
        "reason": "Career Break"
    }
    ]
  }
}

{
  "error": "validation_error",
  "message": "Invalid request parameters",
  "details": [
    "Resume file is required",
    "Unsupported file type. Must be PDF, DOC, or DOCX"
  ]
}

{
  "error": "not_found",
  "message": "Candidate not found"
}

Getting Started

API Reference

Body Parameters

Response Fields

​Body Parameters

​Response Fields

Body Parameters

Response Fields