Skip to main
Group
Free TrialCTA Arrow
Why Sovren?
Products
Group 15
Resume Parser
Parse resume and job orders with control, accuracy and speed.
Group 15
+AI Matching
Match with an engine that mimics your thinking.
PricingResourcesCompany

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Group 6
SaaS     |
Getting Started
First Steps
Sovren SDK
Code Samples
Standard Transaction Cost
Endpoints
Authentication
Versioning
HTTP Status Codes
Resume Parser Overview
Document Last Modified Date
Batch Parsing Concurrency
How Does Resume Parsing Work
Documents That Can Cause Problems
Entry Level
Australia
Config String Builder
Parser Output Settings
Additional Settings
Searching
Sort Order
Matching
Scores
Filtering
Semantic Filter
Full-text Filter
Boolean Syntax
Special Operators
Semantic Expressions
Feature Comparison
UI Overview
Authentication
UI Customization
Hooks
Getting Started
Rate Limits
Skills
Supported Languages
About the Skills Taxonomy
Professions
Supported Taxonomies
Supported Languages
Ontology
Supported Languages
API Technical SpecsPoliciesFAQsDocumentsRelease Notes

Format a Parsed Resume

POST /v10/formatter/resume

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

Notes

Request Body

ResumeDatarequiredobject
Parsed ResumeData or RedactedResumeData from the Sovren Resume Parser. See Parse 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

{ ... 
{ ... 
},{ ... 
"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.
Info.TransactionIdstring
The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.
Info.EngineVersionstring
The version of the parsing/matching engine running under-the-hood.
Info.ApiVersionstring
The version of the API.
Info.TotalElapsedMillisecondsinteger
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
Info.TransactionCostdecimal
How many credits the transaction costs.How many credits the transaction costs.
Info.CustomerDetailsobject
Information about the customer who made the API call.
Value.CustomerDetails.AccountIdstring
The AccountId for the account.
Value.CustomerDetails.Namestring
The customer name on the account.
Value.CustomerDetails.IPAddressstring
The client IP Address where the API call originated.
Value.CustomerDetails.Regionstring
The region for the account, also known as the 'Data Center'.
Value.CustomerDetails.CreditsRemainingdecimal
The number of credits remaining to be used by the account.
Value.CustomerDetails.CreditsUseddecimal
The number of credits used by the account.
Value.CustomerDetails.MaximumConcurrentRequestsinteger
The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
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" :  "string","Message" :  "string","TransactionId" :  "string","EngineVersion" :  "string","ApiVersion" :  "string","TotalElapsedMilliseconds" :  0,"TransactionCost" :  0,{ ... 
"AccountId" :  "string","Name" :  "string","IPAddress" :  "string","Region" :  "string","CreditsRemaining" :  0,"CreditsUsed" :  0,"ExpirationDate" :  "2021-12-31","MaximumConcurrentRequests" :  0}},{ ... 
"DocumentAsBase64String" :  ""}}
SOC II Type 2
Compliant
Why Sovren?
Company
Pricing
Account Login
Have questions? We can help.
© 2023 Textkernel US LLC. All rights reserved.
Privacy Policy | Terms of Service | GDPR