Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Format a Parsed Resume

POST /v9/formatter/resume

Format a Parsed Resume into a standardized DOCX or PDF file.

Notes

Request Body

ParsedDocumentrequiredstring
The existing parsed JSON of a Resume.
Optionsrequiredobject
Options for content/formatting of the generated resume document.
Options.OutputTyperequiredstring
Either DOCX or PDF
Options.CompanyInfooptionalobject
Options for putting company/firm information on the formatted resume header.
Options.CompanyInfo.CompanyNameoptionalstring
The company name to include in the resume header.
Options.CompanyInfo.Phoneoptionalstring
The contact phone to include in the resume header.
Options.CompanyInfo.Emailoptionalstring
The contact email to include in the resume header.
Options.CompanyInfo.CandidateIdoptionalstring
The candidate id for this resume to include in the resume header.
Options.CompanyInfo.Footeroptionalstring
Any information (such as confidentiality clause) to put in the resume footer.
Options.CompanyInfo.Placementoptionalstring
Either FirstHeader (default) or AllHeaders.
Options.CompanyInfo.Logo.Widthrequiredinteger
The width of the logo in pixels.
Options.CompanyInfo.Logo.Heightrequiredinteger
The height of the logo in pixels.
Options.WorkHistoryoptionalobject
Options to include/exclude certain data from the work history section of the resume.
Options.WorkHistory.EmployerNamesoptionalstring
One of:
  • ShowAll - shows all employers on the resume (this is the default value)
  • HideAll - hides all employers on the resume
  • HideRecentAndCurrent - hides only the most recent/current employers on the resume
Options.WorkHistory.MaxYearsOfWorkHistoryoptionalinteger
Hides any positions from the original resume that ended longer than N years ago. This only applies in the case that NumPositions.Minimum (below) has been met. The default for this value is 10 years.
Options.WorkHistory.NumPositionsoptionalobject
The min/max number of positions/jobs to show.
Options.WorkHistory.NumPositions.Minimumrequiredinteger
Positions from the original resume will be shown in chronological order until at least this number is met. Positions in excess of this number may be hidden depending on other settings. The default for this value is 2.
Options.WorkHistory.NumPositions.Maximumrequiredinteger
No matter the end date, the generated resume will contain a maximum of this many positions from the original resume. The default for this value is 5.
Options.Metadataoptionalobject
Options to show/hide Sovren metadata on the generated resume.
Options.Metadata.HideCandidateSummaryoptionalboolean
Whether to hide the Sovren candidate summary in the generated resume.
Options.Metadata.HideTopSkillsoptionalboolean
Whether to hide the 'Top Skills' tree in the generated resume.

Sample Request

{ ... 
"ParsedDocument" :  "",{ ... 
"OutputType" :  "",{ ... 
"CompanyName" :  "","Phone" :  "","Email" :  "","CandidateId" :  "","Footer" :  "","Placement" :  "",{ ... 
"Logo" :  "","Width" :  0,"Height" :  0
}
},
{ ... 
"EmployerNames" :  "","MaxYearsOfWorkHistory" :  0,{ ... 
"Minimum" :  0,"Maximum" :  0
}
},
{ ... 
"HideCandidateSummary" :  false,"HideTopSkills" :  false
}
}
}

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
Contains response data for the transaction.
Value.DocumentAsBase64Stringstring
The formatted resume document (either PDF or DOCX). This is a byte[] as a Base64-encoded string.

Sample Response

{ ... 
{ ... 
"Code" :  "","Message" :  ""
},
{ ... 
"DocumentAsBase64String" :  ""
}
}