Template Styles

API

Integrate with our API

As an alternative to using our dashboard, recruiters can integrate directly with our REST API.

Overview

Our REST API can easily be integrated by any developer. Please note that this option is only available for recruiters in need of optimizing a large number of resumes and have technical knowledge of how to incorporate a REST API.

Transactions take less than 20 seconds on average but more complex resumes may take longer. If you need to optimize a batch of resumes, our recommendation is to process these one at a time and not concurrently.

Endpoint

You can test our API here: https://resumeoptimizerpro.com/api/v1/

Authentication

To authenticate with our REST API, the following request headers are required:

Field Type Description
Username string The user name associated with your account
ApiKey string The API Key associated with your account
Content-Type string This value should be set to application/json

Optimize a resume

POST https://resumeoptimizerpro.com/api/v1/optimize

Request body

{
  "ResumeAsBase64String": "string",
  "ResumeText": "string",
  "SkillsToAdd": [
    "string"
  ],
  "IncludeObjective": true,
  "IncludeCoverLetter": true,
  "AddSkillsToWorkHistory": true,
  "FormattingOptions": {
    "FontStyle": "string",
    "LogoAsBase64String": "string",
    "TemplateStyle": "string",
    "HidePersonalInfo": true
  },
  "IdealJobTitle": "string",
  "JobTitle": "string",
  "CompanyName": "string",
  "WritingStyle": "string"
}

Field definition

ResumeAsBase64String string conditional
The resume file to optimize as a base64 encoded string. Supported file types include .docx .txt, and .pdf. Either ResumeAsBase64String or ResumeText is required.
ResumeText string conditional
As an alternative to the resume file, you can provide the text of the resume to optimize. Use this option for unsupported file formats or poorly formatted resumes. Either ResumeAsBase64String or ResumeText is required.
SkillsToAdd string[] optional
The additional skills to include in the optimized resume. For example, use this option to include any skills that the candidate has experience with but are not currently in the resume.
IncludeObjective bool optional
If true, an objective will be included in the optimized resume (default = false).
IncludeCoverLetter bool optional
If true, a targeted cover letter will be included in the optimized resume (default = false).
AddSkillsToWorkHistory bool optional
This option will integrate the "SkillsToAdd" values into the work history to improve the matching score (default = true).
FormattingOptions object optional
Sets the formatting options for the optimized resume.
FormattingOptions.FontStyle string optional
Sets the font style for the optimized resume. Only set this value if you don't wish to use the template's default font style. Possible values include:

  • "Arial"
  • "Book Antiqua"
  • "Bookman Old Style"
  • "Calibri"
  • "Century Gothic"
  • "Georgia"
  • "Helvetica"
  • "Lucida Calligraphy"
  • "Lucida Sans"
  • "Microsoft Sans Serif"
  • "Rockwell"
  • "Segoe UI"
  • "Tahoma"
  • "Verdana"

FormattingOptions.LogoAsBase64String string optional
A company logo as a base64 encoded string (option for recruiters). Supported file types include .png and .jpg. If included, the provided logo will be inserted within the resume header.
FormattingOptions.TemplateStyle string optional
The template style for the optimized resume (view templates). Possible values include:

  • "1" (plain style and no colors) [default]
  • "2" (light beige main header)
  • "3" (black main header)
  • "4" (centered section headers)
  • "5" (classic style)
  • "6" (gray main header and teal section headers)
  • "7" (blue main and section headers)
  • "8" (red main and section headers)

FormattingOptions.HidePersonalInfo bool optional
This option will redact the candidate's personal information from the optimized resume. This can be useful for recruiters that need to anonymize their candidate profiles before submitting them to clients (default = false).
IdealJobTitle string optional
The ideal job title to be associated with the optimized resume. This value will be included within the main header and cover letter (if selected).
JobTitle string optional
When optimizing for a job posting, the job title associated with the posting.
CompanyName string optional
When optimizing for a job posting, the company name that is posting the job. This value will be included in the targeted cover letter (if selected).
WritingStyle string optional
The writing style for the optimized resume. For example, if you are a designer, you may want to may want to choose "Creative" or if you are a software developer, you may want to choose "Technical". The "Unmodified" option will keep the resume's writing style. Possible values include:

  • "Professional" (default)
  • "Executive"
  • "Technical"
  • "Creative"
  • "Casual"
  • "Unmodified"

Response body

{
  "OptimizedResumeAsBase64String": "string",
  "StatusCode": "string",
  "Message": "string",
  "OptimizationsRemaining": 0,
  "CandidateName": "string",
  "ResumeAnalysis": "string"
}

Field definition

OptimizedResumeAsBase64String string
The optimized resume as a base64 encoded string. The format of the file will be MS Word .docx.
StatusCode string
The status code for the transaction.
Message string
The status message associated with the transaction.
OptimizationsRemaining integer
The number of optimizations remaining in the account.
CandidateName string
The candidate name associated with the optimized resume.
ResumeAnalysis string
The summary analysis for the original resume based on how well it adhered to our best practices.