> ## Documentation Index
> Fetch the complete documentation index at: https://docs.harmonyforstaffing.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Parse Resume

> Parse a resume file to extract structured candidate information

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

### Body Parameters

<ParamField body="file" type="file">
  The resume file to parse (PDF, DOC, DOCX, TXT)
</ParamField>

<ParamField body="file_url" type="string">
  URL to a resume file to download and parse
</ParamField>

<ParamField body="candidate_id" type="integer">
  ATS ID of the candidate this resume belongs to (optional)
</ParamField>

<Note>
  You must provide either `file` or `file_url`, but not both.
</Note>

<RequestExample>
  ```bash cURL with File Upload theme={null}
  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
  ```

  ```bash cURL with File URL theme={null}
  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
  ```
</RequestExample>

### Response Fields

<ResponseField name="personalInfo" type="object">
  Basic information about the candidate

  <Expandable title="Personal Info Object">
    <ResponseField name="name" type="object">
      <ResponseField name="firstName" type="string">First name of the candidate</ResponseField>
      <ResponseField name="lastName" type="string">Last name of the candidate</ResponseField>
      <ResponseField name="middleName" type="string">Middle name or initial if available</ResponseField>
    </ResponseField>

    <ResponseField name="contact" type="object">
      <ResponseField name="email" type="string">Primary email address</ResponseField>
      <ResponseField name="phone" type="string">Phone number in E.164 format</ResponseField>
      <ResponseField name="alternativePhone" type="string">Alternative phone number in E.164 format</ResponseField>
      <ResponseField name="linkedIn" type="string">LinkedIn profile URL</ResponseField>
    </ResponseField>

    <ResponseField name="location" type="object">
      <ResponseField name="street" type="string">Street address</ResponseField>
      <ResponseField name="city" type="string">City of residence</ResponseField>
      <ResponseField name="state" type="string">State/province code</ResponseField>
      <ResponseField name="zipCode" type="string">Postal/ZIP code</ResponseField>
      <ResponseField name="country" type="string" default="USA">Country of residence</ResponseField>
      <ResponseField name="willingToRelocate" type="boolean">Whether candidate is open to relocation</ResponseField>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="professionalSummary" type="object">
  Overview of professional background

  <Expandable title="Summary Object">
    <ResponseField name="overview" type="string">Brief professional summary</ResponseField>
    <ResponseField name="yearsOfExperience" type="number">Total years of experience</ResponseField>

    <ResponseField name="specialtyExperience" type="array">
      Experience breakdown by specialty

      <Expandable title="Specialty Object">
        <ResponseField name="specialty" type="string">Specialty area (e.g., "ICU")</ResponseField>
        <ResponseField name="totalYears" type="number">Years in this specialty</ResponseField>
        <ResponseField name="lastPracticed" type="string">Last date in specialty (YYYY-MM-DD)</ResponseField>
        <ResponseField name="settings" type="array">Different settings where specialty was practiced</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="coreProficiencies" type="array">List of primary skills and competencies</ResponseField>
    <ResponseField name="industryExpertise" type="array">Specific industries worked in</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="workHistory" type="array">
  Employment history in reverse chronological order

  <Expandable title="Work History Object">
    <ResponseField name="employer" type="string">Company/organization name</ResponseField>
    <ResponseField name="title" type="string">Job title/position</ResponseField>

    <ResponseField name="location" type="object">
      <ResponseField name="city" type="string">City name</ResponseField>
      <ResponseField name="state" type="string">State code</ResponseField>
      <ResponseField name="remote" type="boolean">Whether position was remote</ResponseField>
    </ResponseField>

    <ResponseField name="startDate" type="string">Start date (YYYY-MM-DD)</ResponseField>
    <ResponseField name="endDate" type="string">End date (YYYY-MM-DD)</ResponseField>
    <ResponseField name="isCurrent" type="boolean">Whether this is the current position</ResponseField>
    <ResponseField name="monthsInRole" type="number">Duration in months</ResponseField>
    <ResponseField name="specialty" type="string">Primary specialty in role</ResponseField>
    <ResponseField name="responsibilities" type="array">Key job duties</ResponseField>
    <ResponseField name="technologies" type="array">Technologies/tools used</ResponseField>

    <ResponseField name="skills" type="array">
      Skills demonstrated in this role

      <Expandable title="Skill Object">
        <ResponseField name="name" type="string">Name of the skill</ResponseField>
        <ResponseField name="category" type="string">Category of skill</ResponseField>
        <ResponseField name="context" type="string">How the skill was used</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="projectHighlights" type="array">
      Notable projects

      <Expandable title="Project Object">
        <ResponseField name="name" type="string">Project name</ResponseField>
        <ResponseField name="description" type="string">Project description</ResponseField>
        <ResponseField name="outcomes" type="array">Measurable achievements</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="education" type="array">
  Educational background

  <Expandable title="Education Object">
    <ResponseField name="institution" type="string">School name</ResponseField>
    <ResponseField name="degree" type="string">Degree earned</ResponseField>
    <ResponseField name="major" type="string">Field of study</ResponseField>
    <ResponseField name="minor" type="string">Secondary field of study</ResponseField>
    <ResponseField name="graduationDate" type="string">Graduation date (YYYY-MM-DD)</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="certifications" type="array">
  Professional certifications

  <Expandable title="Certification Object">
    <ResponseField name="name" type="string">Certification name</ResponseField>
    <ResponseField name="issuingOrganization" type="string">Issuing body</ResponseField>
    <ResponseField name="issueDate" type="string">Issue date (YYYY-MM-DD)</ResponseField>
    <ResponseField name="expirationDate" type="string">Expiration date (YYYY-MM-DD)</ResponseField>
    <ResponseField name="credentialId" type="string">Certification number or identifier</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="skills" type="object">
  Professional skills and competencies

  <Expandable title="Skills Object">
    <ResponseField name="technical" type="array">
      Technical skills by category

      <Expandable title="Technical Category">
        <ResponseField name="category" type="string">Skill category</ResponseField>

        <ResponseField name="skills" type="array">
          <Expandable title="Skill Object">
            <ResponseField name="name" type="string">Name of the skill</ResponseField>
            <ResponseField name="yearsOfExperience" type="number">Years of experience</ResponseField>
            <ResponseField name="proficiencyLevel" type="string">One of: Beginner, Intermediate, Advanced, Expert</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="softSkills" type="array">Interpersonal skills</ResponseField>

    <ResponseField name="languages" type="array">
      Language proficiencies

      <Expandable title="Language Object">
        <ResponseField name="language" type="string">Language name</ResponseField>
        <ResponseField name="proficiency" type="string">One of: Basic, Conversational, Professional, Native/Bilingual</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="additionalInfo" type="object">
  Additional candidate information

  <Expandable title="Additional Info Object">
    <ResponseField name="employmentGaps" type="array">Employment gaps in work history</ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "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"
      }
      ]
    }
  }
  ```
</ResponseExample>

<ResponseExample>
  ```json 400 Bad Request theme={null}
  {
    "error": "validation_error",
    "message": "Invalid request parameters",
    "details": [
      "Resume file is required",
      "Unsupported file type. Must be PDF, DOC, or DOCX"
    ]
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "error": "not_found",
    "message": "Candidate not found"
  }
  ```
</ResponseExample>