v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

esume Field Extraction

Parses resumes and extracts specific structured fields from the parsed data.

post/parserservice/resume

Request body

binaryDatastring required

The binary resume data.

instanceTypestring required

Instance type to be used to parse. For example, use "XRAY" to process with LENS xray.

extensionstring

The document extension (e.g. txt, doc, docx, rtf). Default is "txt".

localestring

Locale to be used to parse (e.g. en_us).

Example request

{
  "binaryData": "JVBERi0xLjUNJeLjz9MNCjEw....",
  "extension": "pdf",
  "locale": "en_us",
  "instanceType": "TM"
}

Response

statusboolean

statusCodestring

requestIdstring uuid

timeStampstring date-time

processedWithLocalestring

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "337a56ff-cbcf-457b-964c-cce3d9e4a875",
  "responseData": {
    "Candidate": {
      "@xmlns": "http://www.hr-xml.org/3",
      "@xmlns:oa": "http://www.openapplications.org/oagis/9",
      "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
      "CandidatePerson": {
        "PersonName": {
          "FormattedName": "SCOTT GRITTON",
          "LegalName": "SCOTT GRITTON",
          "oa:GivenName": {
            "@xmlns:oa": "http://www.openapplications.org/oagis/9",
            "#text": "SCOTT"
          },
          "FamilyName": "GRITTON",
          "PersonNameInitials": "S"
        },
        "FatherName": {
          "FormattedName": "GRITTON"
        },
        "Communication": [
          {
            "Address": {
              "oa:AddressLine": {
                "@xmlns:oa": "http://www.openapplications.org/oagis/9",
                "#text": "515 Chestnut Street"
              },
              "oa:CityName": {
                "@xmlns:oa": "http://www.openapplications.org/oagis/9",
                "#text": "Santa Cruz"
              },
              "oa:CountrySubDivisionCode": {
                "@xmlns:oa": "http://www.openapplications.org/oagis/9",
                "@listID": "State",
                "#text": "CA"
              },
              "CountryCode": "US",
              "oa:PostalCode": {
                "@xmlns:oa": "http://www.openapplications.org/oagis/9",
                "#text": "95060"
              }
            }
          },
          {
            "oa:DialNumber": {
              "@xmlns:oa": "http://www.openapplications.org/oagis/9",
              "#text": "(831) 247-4893"
            }
          },
          {
            "ChannelCode": "Email",
            "UseCode": "Personal",
            "oa:URI": {
              "@xmlns:oa": "http://www.openapplications.org/oagis/9",
              "#text": "scott09@ix.netcom.com"
            }
          }
        ],
        "CitizenshipCountryCode": "US",
        "ResidencyCountryCode": "US",
        "MaritalStatusCode": "notReported"
      }
    }
  },
  "timeStamp": "2023-08-02T01:41:45.795Z",
  "processedWithLocale": "en_us"
}