> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rxresu.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Check resume content for ATS issues

> Runs the editor's deterministic contact, date, layout, heading and writing checks. Respects ignored findings saved on the resume.



## OpenAPI

````yaml /spec.json get /resumes/{id}/checks
openapi: 3.1.1
info:
  title: Reactive Resume
  version: 6.0.0
  description: >-
    Reactive Resume API. Mutations do not support Idempotency-Key. Do not
    automatically retry POST, PUT, PATCH or DELETE requests after a timeout:
    first read the resource to determine whether the operation succeeded.
    Existing enum values and response shapes are retained for compatibility.
  license:
    name: MIT
    url: https://github.com/reactive-resume/reactive-resume/blob/main/LICENSE
  contact:
    name: Amruth Pillai
    email: hello@amruthpillai.com
    url: https://amruthpillai.com
servers:
  - url: https://rxresu.me/api/openapi
security:
  - apiKey: []
  - bearerAuth: []
  - cookieAuth: []
externalDocs:
  url: https://docs.rxresu.me
  description: Reactive Resume Documentation
paths:
  /resumes/{id}/checks:
    get:
      tags:
        - Resumes
      summary: Check resume content for ATS issues
      description: >-
        Runs the editor's deterministic contact, date, layout, heading and
        writing checks. Respects ignored findings saved on the resume.
      operationId: getResumeChecks
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  findings:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          enum:
                            - MISSING_NAME
                            - MISSING_EMAIL
                            - MALFORMED_EMAIL
                            - MISSING_PHONE
                            - MISSING_LOCATION
                            - MALFORMED_URL
                            - PICTURE_PRESENT
                            - EMPTY_PERIOD
                            - UNPARSEABLE_PERIOD
                            - UNPARSEABLE_DATE
                            - REVERSED_PERIOD
                            - FUTURE_DATED_PERIOD
                            - SECTION_MISSING_FROM_LAYOUT
                            - NO_VISIBLE_EXPERIENCE
                            - MISSING_EXPERIENCE_DESCRIPTION
                            - NON_STANDARD_SECTION_TITLE
                            - MULTI_COLUMN_PROSE_SECTION
                            - PROSE_SECTION_IN_SIDEBAR
                            - TWO_COLUMN_LAYOUT
                            - SMALL_BODY_FONT
                            - TIGHT_LINE_HEIGHT
                            - TIGHT_PAGE_MARGINS
                          type: string
                        severity:
                          enum:
                            - error
                            - warning
                            - info
                          type: string
                        pointer:
                          type: string
                        key:
                          type: string
                        params:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                      required:
                        - code
                        - severity
                        - pointer
                        - key
                    readOnly: true
                  ignored:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          enum:
                            - MISSING_NAME
                            - MISSING_EMAIL
                            - MALFORMED_EMAIL
                            - MISSING_PHONE
                            - MISSING_LOCATION
                            - MALFORMED_URL
                            - PICTURE_PRESENT
                            - EMPTY_PERIOD
                            - UNPARSEABLE_PERIOD
                            - UNPARSEABLE_DATE
                            - REVERSED_PERIOD
                            - FUTURE_DATED_PERIOD
                            - SECTION_MISSING_FROM_LAYOUT
                            - NO_VISIBLE_EXPERIENCE
                            - MISSING_EXPERIENCE_DESCRIPTION
                            - NON_STANDARD_SECTION_TITLE
                            - MULTI_COLUMN_PROSE_SECTION
                            - PROSE_SECTION_IN_SIDEBAR
                            - TWO_COLUMN_LAYOUT
                            - SMALL_BODY_FONT
                            - TIGHT_LINE_HEIGHT
                            - TIGHT_PAGE_MARGINS
                          type: string
                        severity:
                          enum:
                            - error
                            - warning
                            - info
                          type: string
                        pointer:
                          type: string
                        key:
                          type: string
                        params:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                      required:
                        - code
                        - severity
                        - pointer
                        - key
                    readOnly: true
                  counts:
                    type: object
                    properties:
                      error:
                        type: number
                      warning:
                        type: number
                      info:
                        type: number
                    required:
                      - error
                      - warning
                      - info
                  totalRules:
                    type: number
                  passedRules:
                    type: number
                  score:
                    type: number
                  categories:
                    type: object
                    propertyNames:
                      enum:
                        - contact
                        - dates
                        - layout
                        - headings
                        - writing
                      type: string
                    additionalProperties:
                      type: object
                      properties:
                        total:
                          type: number
                        passed:
                          type: number
                      required:
                        - total
                        - passed
                required:
                  - findings
                  - ignored
                  - counts
                  - totalRules
                  - passedRules
                  - score
                  - categories
        default:
          description: >-
            Structured API error. See status and code; do not branch on message
            text.
          content:
            application/json:
              schema:
                type: object
                required:
                  - defined
                  - code
                  - status
                  - message
                properties:
                  defined:
                    type: boolean
                  code:
                    type: string
                  status:
                    type: integer
                  message:
                    type: string
                  data: {}
      security:
        - apiKey: []
        - bearerAuth: []
        - cookieAuth: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: The API key to authenticate requests.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: An OAuth access token issued by this instance for its API/MCP resource.
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Browser session (secure deployments use the __Secure- prefix). Cookie
        requests must originate from this instance.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.