Skip to content
Tx Platform
Format Parsed Resume

Format a Parsed Resume🔗︎

HTTP Verb Path
POST /v10/formatter/resume

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

Info

Request Body🔗︎

ResumeData 🔗︎ object required

ResumeData🔗︎

Parsed ResumeData or RedactedResumeData from the Textkernel CV/Resume Parser. See Parse a Resume

Options 🔗︎ object required

Options🔗︎

Options for content/formatting of the generated resume document.


Options properties

OutputType 🔗︎ string required

OutputType🔗︎

Either DOCX or PDF

CompanyInfo 🔗︎ object

CompanyInfo🔗︎

Options for putting company/firm information on the formatted resume header.


CompanyInfo properties

CompanyName 🔗︎ string

CompanyName🔗︎

The company name to include in the resume header.

Phone 🔗︎ string

Phone🔗︎

The contact phone to include in the resume header.

Email 🔗︎ string

Email🔗︎

The contact email to include in the resume header.

CandidateId 🔗︎ string

CandidateId🔗︎

The candidate id for this resume to include in the resume header.

Footer 🔗︎ string

Any information (such as confidentiality clause) to put in the resume footer.

Placement 🔗︎ string

Placement🔗︎

Either FirstHeader (default) or AllHeaders.

Logo 🔗︎ object

The company logo to include in the resume header.


Logo properties

Logo 🔗︎ string required

The Base64-encoded image file to use as the logo (PNG, JPG, or SVG).

Width 🔗︎ integer required

Width🔗︎

The width of the logo in pixels.

Height 🔗︎ integer required

Height🔗︎

The height of the logo in pixels.

WorkHistory 🔗︎ object

WorkHistory🔗︎

Options to include/exclude certain data from the work history section of the resume.


WorkHistory properties

EmployerNames 🔗︎ string

EmployerNames🔗︎

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
MaxYearsOfWorkHistory 🔗︎ integer

MaxYearsOfWorkHistory🔗︎

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.

NumPositions 🔗︎ object

NumPositions🔗︎

The min/max number of positions/jobs to show.


NumPositions properties

Minimum 🔗︎ integer required

Minimum🔗︎

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.

Maximum 🔗︎ integer required

Maximum🔗︎

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.

Metadata 🔗︎ object

Metadata🔗︎

Options to show/hide Textkernel metadata on the generated resume.


Metadata properties

HideCandidateSummary 🔗︎ boolean

HideCandidateSummary🔗︎

Whether to hide the Textkernel candidate summary in the generated resume.

HideTopSkills 🔗︎ boolean

HideTopSkills🔗︎

Whether to hide the 'Top Skills' tree in the generated resume.

Sample JSON
{
  "ResumeData": {},
  "Options": {
    "OutputType": "",
    "CompanyInfo": {
      "CompanyName": "",
      "Phone": "",
      "Email": "",
      "CandidateId": "",
      "Footer": "",
      "Placement": "",
      "Logo": {
        "Logo": "",
        "Width": 0,
        "Height": 0
      }
    },
    "WorkHistory": {
      "EmployerNames": "",
      "MaxYearsOfWorkHistory": 0,
      "NumPositions": {
        "Minimum": 0,
        "Maximum": 0
      }
    },
    "Metadata": {
      "HideCandidateSummary": false,
      "HideTopSkills": false
    }
  }
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.


Info properties

Code 🔗︎ string

Code🔗︎

Code Description
Success Successful transaction
MissingParameter A required parameter wasn't provided
InvalidParameter A parameter was incorrectly specified
AuthenticationError An error occurred with the credentials provided
Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

TransactionId 🔗︎ string

TransactionId🔗︎

The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal

TransactionCost🔗︎

How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object

CustomerDetails🔗︎

Information about the customer who made the API call.


CustomerDetails properties

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

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.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.


Value properties

DocumentAsBase64String 🔗︎ string

DocumentAsBase64String🔗︎

The formatted resume document (either PDF or DOCX). This is a byte[] as a Base64-encoded string.

Sample JSON
{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "DocumentAsBase64String": ""
  }
}