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

# Parse Documents via Ping.Extraction

> Send attached documents to Ping.Extraction for parsing.



## OpenAPI

````yaml https://vision.staging.pingintel.com/api/schema/?format=json post /api/v1/submission/{id}/sovfixer-parse
openapi: 3.0.3
info:
  title: Ping.Vision API
  version: v1.0
  description: >
    ### Ping.Vision API


    This API provides convenient, efficient access to Ping Intel's data and
    services. It is designed to be used by developers and data scientists to
    integrate Ping Intel's capabilities into their applications.


    Once SSO is set up with your organization, you can create an Organization or
    Personal API key at https://auth.pingintel.com/org.


    Please see the Python client library
    [pingintel-api](https://pypi.org/project/pingintel-api/) for commandline
    tools and programmatic access, and you

    can refer to the following documentation for details on interacting with the
    system via the HTTP API.
  contact:
    email: support@pingintel.com
    name: Ping Intel
    url: https://www.pingintel.com
servers:
  - url: https://vision.pingintel.com
    description: Ping.Vision API
  - url: https://vision.staging.pingintel.com
    description: Ping.Vision API (staging)
security: []
tags:
  - name: Create Submission
    description: The Create Submission API allows you to add new data into the system.
  - name: Update Submission
    description: >-
      The Update Submission API provides various endpoints to update, modify, or
      act upon existing submissions.
  - name: Get Submission Data
    description: ''
  - name: User Memberships
    description: >-
      The User Memberships API allows you to add, remove, and change the role of
      users in different teams, divisions, or companies.
  - name: Miscellaneous
    description: ''
paths:
  /api/v1/submission/{id}/sovfixer-parse:
    post:
      tags:
        - Update Submission
      summary: Parse Documents via Ping.Extraction
      description: Send attached documents to Ping.Extraction for parsing.
      operationId: api_v1_submission_sovfixer_parse_create
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: The pingid of the submission.
          required: true
          examples:
            Example:
              value: p-lo-ping-abc123
              description: Example ping ID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmissionSovfixerParse'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SubmissionSovfixerParse'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SubmissionSovfixerParse'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionSovfixerParseResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionSovfixerParseErrorResponse'
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    SubmissionSovfixerParse:
      type: object
      properties:
        filenames:
          type: array
          items:
            type: string
          description: >-
            List of filenames to parse.  Filenames are references to documents
            that are already attached to the submission.
        sovfixer_request_type:
          enum:
            - WORKING_SOV
            - UPDATED_SOV
            - OTHER
            - null
          type: string
          x-spec-enum-id: 73abf0b0e9ef57b9
          nullable: true
          description: >-
            Optional selection for the type of SOV to request.


            * `WORKING_SOV` - Working SOV: Simplified or preprocessed copy of
            the original submission doc, with the intent of allowing Extraction
            to work more smoothly.

            * `UPDATED_SOV` - Updated SOV: Revised submission with updated data,
            such as a quarterly schedule update or with completed exposure data.

            * `OTHER` - Other: Please provide details in the
            `sovfixer_request_type_notes` field.
        sovfixer_request_type_notes:
          type: string
          nullable: true
          description: Free-form notes when request type is 'OTHER'
      required:
        - filenames
    SubmissionSovfixerParseResponse:
      type: object
      properties:
        message:
          type: string
          description: Message indicating the status of the request.
        sovid:
          type: string
          description: >-
            SOVID identifier returned by Ping.Extraction to track the fixing
            job.
      required:
        - message
        - sovid
    SubmissionSovfixerParseErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````