---
updatedAt: 2026-04-21T07:28:47.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Parse a resume

Parse a resume

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1",
    "title": "Candidates API",
    "contact": {
      "name": "SmartRecruiters",
      "url": "https://developers.smartrecruiters.com"
    }
  },
  "tags": [
    {
      "name": "candidates"
    }
  ],
  "paths": {
    "/candidates/cv/parse": {
      "post": {
        "responses": {
          "200": {
            "description": "Parsed candidate data.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ParsedCandidateDetails"
                }
              }
            }
          },
          "400": {
            "description": "with codes\n* **UNPARSABLE_RESUME** when provided resume cannot be parsed, e.g. an image\n* **INCOMPLETE_RESUME** when provided resume does not contain all required information to parse a candidate.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Access denied.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "with code **PERMISSION_DENIED** when you are not permitted to parse resume",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests. Please try again later.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "description": "Parse a resume",
        "tags": [
          "candidates"
        ],
        "summary": "Parse a resume",
        "operationId": "candidates.resume.parse",
        "security": [
          {
            "key": []
          },
          {
            "oauth": [
              "candidates_parse_resume"
            ]
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/ResumeParse"
        }
      }
    }
  },
  "components": {
    "requestBodies": {
      "ResumeParse": {
        "content": {
          "multipart/form-data": {
            "schema": {
              "type": "object",
              "properties": {
                "file": {
                  "description": "The resume file to parse.",
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "key": {
        "type": "apiKey",
        "in": "header",
        "name": "x-smarttoken"
      },
      "oauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://www.smartrecruiters.com/identity/oauth/allow",
            "tokenUrl": "https://api.smartrecruiters.com/identity/oauth/token",
            "scopes": {
              "candidates_read": "Access Candidates",
              "candidates_create": "Create Candidates",
              "candidates_offers_read": "Access Offer Terms",
              "candidates_manage": "Manage Candidate Status and Properties",
              "candidate_status_read": "Access Candidate's status",
              "candidates_parse_resume": "Access Resume Parsing"
            }
          }
        }
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "ParsedCandidateDetails": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          },
          "location": {
            "$ref": "#/components/schemas/CandidateLocation"
          },
          "web": {
            "$ref": "#/components/schemas/WebProfile"
          },
          "education": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Education"
            }
          },
          "experience": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Experience"
            }
          }
        }
      },
      "CandidateLocation": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "minLength": 1
          },
          "countryCode": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2
          },
          "regionCode": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "city": {
            "type": "string",
            "minLength": 1
          },
          "lat": {
            "type": "number",
            "format": "float"
          },
          "lng": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "WebProfile": {
        "type": "object",
        "properties": {
          "skype": {
            "type": "string"
          },
          "linkedin": {
            "type": "string"
          },
          "facebook": {
            "type": "string"
          },
          "twitter": {
            "type": "string"
          },
          "website": {
            "type": "string"
          }
        }
      },
      "Education": {
        "type": "object",
        "properties": {
          "institution": {
            "type": "string",
            "minLength": 1
          },
          "degree": {
            "type": "string",
            "minLength": 1
          },
          "major": {
            "type": "string",
            "minLength": 1
          },
          "current": {
            "type": "boolean"
          },
          "location": {
            "type": "string"
          },
          "startDate": {
            "$ref": "#/components/schemas/When"
          },
          "endDate": {
            "$ref": "#/components/schemas/When"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "Experience": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "minLength": 1
          },
          "company": {
            "type": "string",
            "minLength": 1
          },
          "current": {
            "type": "boolean"
          },
          "startDate": {
            "$ref": "#/components/schemas/When"
          },
          "endDate": {
            "$ref": "#/components/schemas/When"
          },
          "location": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "When": {
        "type": "string",
        "format": "when",
        "description": "date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. \"2016\", \"2016-11\", \"2016-11-29\""
      }
    }
  },
  "servers": [
    {
      "url": "https://api.smartrecruiters.com"
    }
  ]
}
```