---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend]
keyword: [Extend, Workday AI Gateway, AI Gateway]
nav: wcp_docs
parent_url: /wcp_docs/
title: Resume REST API
layout: subsection
---

The Resume REST API uses machine learning to simplify the handling and processing of resumes in order to automate user flows. Using Optical Character Recognition (OCR) and Natural Language Processing (NLP) technologies, the Resume REST APIs can scan images (or PDFs) and extract key entities from the resume.

Sample use case:

-   As a recruiter, you receive intern resumes from local colleges via a resume book (instead of individual applications). You can call the Resumes REST API to extract key fields from student resumes, and use the response as input to automated onboarding candidates at your company.


## <a id="section_17"></a>URL Base Path

The Resume REST API endpoint uses this base URL:

```
https://api.workday.com/ml/docint/{version}
```

For regional URL base paths, see [Reference: Workday Extend API Gateways and Authorization Base URLs](/wcp_docs/dlh1653340161856.html)

## <a id="section_6"></a>Scanning Resumes

To scan a receipt, call this endpoint:

```
POST {baseURL}/resume
```

In the request body, attach a data-binary file. The supported file types are:

-   DOCX
-   PDF - Must contain text that's not image-based.


The endpoint scans the file attachment and returns structured text data, which includes these resume properties:

-   contact
-   education
-   experience
-   references
-   summary


## <a id="section_16"></a>Example

This sample request returns extracted sections and properties from a resume.

```
POST https://api.workday.com/ml/docint/v1/resume
```

For a sample receipt attachment, see the <i>App Catalog App: Document Intelligence with the AI Gateway</i> article in the [Developer Forum](https://forum.developer.workday.com/).

Sample response:

```
{
"ResDoc": {
"resume": [
{
 "canonversion": "2",
 "contact": [
   {
     "address": [
       {
         "city": [
           "Brooklyn"
         ],
         "lat": "40.7261",
         "lon": "-73.9463",
         "majorcity": "NEW YORK",
         "postalcode": [
           ", ",
           "11222"
         ],
         "state": [
           {
             "abbrev": "NY",
             "value": "NY"
           }
         ]
       }
     ],
     "email": [
       {
         "value": "joanhensley@email.com"
       }
     ],
     "name": [
       {
         "givenname": [
           "JOAN"
         ],
         "surname": [
           "HENSLEY"
         ]
       }
     ],
     "phone": [
       {
         "value": "(123) 456-7890"
       }
     ],
     "website": [
       "\nHUMAN RESOURCES\nCONTACT\n"
     ]
   }
 ],
 "dateversion": "2",
 "education": [
   {
     "honors": [
       "EDUCATION\n"
     ],
     "school": [
       {
         "address": [
           {
             "city": [
               "Pittsburgh"
             ],
             "lat": "40.47",
             "lon": "-79.95",
             "majorcity": "PITTSBURGH",
             "postalcode": [
               ", "
             ],
             "state": [
               {
                 "abbrev": "PA",
                 "value": "PA"
               }
             ]
           }
         ],
         "daterange": [
           {
             "end": [
               {
                 "days": "735236",
                 "iso8601": "2014-01-01",
                 "value": "2014"
               }
             ],
             "start": [
               {
                 "days": "733775",
                 "iso8601": "2010-01-01",
                 "value": "2010"
               }
             ],
             "value": [
               " - "
             ]
           }
         ],
         "degree": [
           {
             "level": "16",
             "name": "Bachelor of Arts",
             "value": "Bachelor of Arts"
           }
         ],
         "id": "4",
         "institution": [
           {
             "value": [
               "University of Pittsburgh"
             ]
           }
         ],
         "major": [
           {
             "code": "2999",
             "value": "Human Resource Management"
           }
         ]
       }
     ]
   }
 ],
 "experience": [
   {
     "end": "present",
     "job": [
       {
         "address": [
           {
             "city": [
               "New York"
             ],
             "lat": "40.75",
             "lon": "-74",
             "majorcity": "NEW YORK",
             "postalcode": [
               ", "
             ],
             "state": [
               {
                 "abbrev": "NY",
                 "value": "NY"
               }
             ]
           }
         ],
         "daterange": [
           {
             "end": [
               {
                 "days": "present",
                 "iso8601": "2023-10-24",
                 "value": "current"
               }
             ],
             "start": [
               {
                 "days": "736756",
                 "iso8601": "2018-03-01",
                 "value": "March 2018"
               }
             ],
             "value": [
               " - "
             ]
           }
         ],
         "description": [
           {
             "skill": [
               "Led new talent acquisition and recruitment processes for over 50 new full-time hires\nAdministered company-wide compensation and benefit
               plans\nConducted employee onboarding and helped organize over 1K hours of training and development initiatives\nWorked with team members 1 to 1 and in
               small groups to enhance performance and employee satisfaction"
             ]
           }
         ],
         "end": "present",
         "id": "1",
         "jobtype": [
           "\nStorebound\n",
           " / "
         ],
         "pos": "1",
         "span": "6",
         "start": "736756",
         "title": [
           "Human Resources Manager"
         ]
       },
       {
         "address": [
           {
             "city": [
               "New York"
             ],
             "lat": "40.75",
             "lon": "-74",
             "majorcity": "NEW YORK",
             "postalcode": [
               ", "
             ],
             "state": [
               {
                 "abbrev": "NY",
                 "value": "NY"
               }
             ]
           }
         ],
         "daterange": [
           {
             "end": [
               {
                 "days": "736728",
                 "iso8601": "2018-02-01",
                 "value": "February 2018"
               }
             ],
             "start": [
               {
                 "days": "735966",
                 "iso8601": "2016-01-01",
                 "value": "January 2016"
               }
             ],
             "value": [
               " - "
             ]
           }
         ],
         "description": [
           {
             "skill": [
               "Collaborated with leadership on recruitment strategies, development plans, performance management, and employee engagement to improve retention rates
               by 12%\nProvided guidance on employee relations and matters of corrective action that reduced turnover rates by 8%\nManaged company organizational structure,
               responsibilities, and staffing levels, creating strong hierarchy channels"
             ]
           }
         ],
         "employer": [
           "Uline"
         ],
         "end": "736728",
         "id": "2",
         "jobtype": [
           " / "
         ],
         "pos": "2",
         "sic": "731908",
         "sic2": "73",
         "span": "2",
         "start": "735966",
         "title": [
           "Human Resources Manager"
         ]
       },
       {
         "address": [
           {
             "city": [
               "New York"
             ],
             "lat": "40.75",
             "lon": "-74",
             "majorcity": "NEW YORK",
             "postalcode": [
               ", "
             ],
             "state": [
               {
                 "abbrev": "NY",
                 "value": "NY"
               }
             ]
           }
         ],
         "daterange": [
           {
             "end": [
               {
                 "days": "735935",
                 "iso8601": "2015-12-01",
                 "value": "December 2015"
               }
             ],
             "start": [
               {
                 "days": "735479",
                 "iso8601": "2014-09-01",
                 "value": "September 2014"
               }
             ],
             "value": [
               " - "
             ]
           }
         ],
         "description": [
           {
             "skill": [
               "Scheduled interviews for candidates across 30 roles\nManaged and administered 100% of pre-employment assessments to prospective
               candidates\nAssisted with new employee onboarding, and ensured all pre- employment forms were completed within 72 hours\nCollected feedback
               after final round interviews, and put together comprehensive compensation packages for prospective hires\nimage1.png\nimage2.png\nimage3.png\nimage4.png"
             ]
           }
         ],
         "employer": [
           "Uline"
         ],
         "end": "735935",
         "id": "3",
         "jobtype": [
           " / "
         ],
         "pos": "3",
         "sic": "731908",
         "sic2": "73",
         "span": "1",
         "start": "735479",
         "title": [
           "Human Resources Coordinator"
         ]
       }
     ],
     "jobtype": [
       "WORK EXPERIENCE\n"
     ],
     "start": "735479"
   }
 ],
 "iso8601": "2023-10-24",
 "present": "738819",
 "references": [
   "\nLinkedIn\n"
 ],
 "space": "preserve",
 "summary": [
   {
     "objective": [
       "SKILLS\nPHR certification ATS (Workday, Jobvite) Compensation and Benefits\nPayroll Performance Management\nCAREER SUMMARY\n"
     ],
     "summary": [
       {
         "objective": [
           "PHR certified human resources professional with 7 years of experience who is well-versed in designing and administering recruiting,
           on-boarding, and compensation plans. I am looking to continue developing as a well-rounded HR manager at an established company like Purcell
           International Group."
         ]
       }
     ]
   }
 ]
}
]
}
}
```

## <a id="section_18"></a>Resume Guidelines for Improved Parsing Results

Unstructured resumes with inconsistent layout and format can lead to inconsistent results from the resume parser. Consider these guidelines when using the Resume REST API:

-   Avoid personal information in the header and footer sections, such as name, phone and address.
-   Avoid visual objects such as images, text boxes, clip arts, logos, and annotations.
-   Avoid tabular and column formats.
-   Use a clear resume structure:

    -   Provide proper headings for resume sections, such as <b>EDUCATION</b> and <b>EXPERIENCE</b>.
    -   Don't combine multiple sections under a single heading such as <b>EDUCATION and EXPERIENCE</b>
    -   Insert additional new lines between work history job profiles or education.
    -   To clearly separate job profiles and school sections, add bullets or numbers at the start of each job profile or education.
    -   Write the description for each job in a single paragraph.
    -   Avoid combining positions based on employers. Separate each job for better parsing.

-   For better name parsing, always start writing names with the hint “Name: Xxxx Yyyy”.

    -   Always mention names in separate lines.
    -   Place the candidate's name at the top of the document, which enables the resume parser to quickly identify the candidate.
    -   Multi-word names should always start with either Initial Capital letters or FULL CAPITAL letters.
    -   Avoid writing names in all lower case letters.
    -   Writing contact information at the starting of resumes results in better identification.

-   Provide hints that provide clear signals to the resume parser. Examples:

    -   Name: Xxxx Yyyy
    -   Address: xxxx yyyy zzzz, abcd, efgh, 00000.
    -   Mobile Phone: 123 456 7890
    -   Email: xxxx@yyyy.com
    -   Date: Jan 2015 – Present

-   Write the reference section at the end of the document with the proper hint <b>REFERENCE:</b>.