Phenom Parsers API

Resume and job-description parsing/extraction.

OpenAPI Specification

phenom-parsers-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Phenom Talent Experience Platform Applicants Parsers API
  version: '1.0'
  description: 'Phenom platform APIs for talent acquisition and experience management: job sync, candidate management, onboarding, applications and applicants, resume/JD parsing, SCIM-based user management, candidate tags, and AI skills prediction.'
  contact:
    name: Phenom Developer Portal
    url: https://developer.phenom.com/
  termsOfService: https://www.phenom.com/terms--conditions
servers:
- url: https://api-qa.phenompro.com
  description: QA / sandbox environment (documented base host)
security:
- bearerAuth: []
tags:
- name: Parsers
  description: Resume and job-description parsing/extraction.
paths:
  /parser/resume/v1/parse:
    post:
      operationId: parseResume
      tags:
      - Parsers
      summary: Parse a resume (base64)
      description: Extract candidate information (name, contact, education, work experience, skills) from a resume.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResumeRequest'
      responses:
        '200':
          description: Resume parsed.
        4XX:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response returned for all 4xx and 5xx responses.
      properties:
        status:
          type: integer
          description: HTTP status code of the error.
        message:
          type: string
          description: Human-readable description of the error.
    ResumeRequest:
      type: object
      description: Request object to parse a resume using a base64 stream.
      properties:
        filename:
          type: string
          description: Resume file name.
        datastream:
          type: string
          description: Base64 encoded value.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer token supplied in the Authorization header. Documented on every operation as `Authorization: <token>`.'