---
title: "Fetch quality result"
method: GET
path: "/v2/submission/{submission_id}/quality"
---

# Fetch quality result

`GET /v2/submission/{submission_id}/quality`

## Path parameters

- `submission_id` string, required

## Response `200`

Asynchronous processing finished (either with a success or an error). Result of the processing is described by specific response object.

- union
  - QualitySuccessResponse
    - `status` 'SUCCESS', required
    - `analysis_time` string, required — Timestamp of analysis
    - `file_type` 'unsupported' | 'pdf' | 'image', required — Type of analyzed file
    - `mime_type` string, required — Mime type of the input file, e.g. `application/pdf`, `image/jpeg`, etc.
    - `deployment_version` string, required — Version of quality engine used for analysis
    - `query_id` string, nullable, required — Customer's own submission ID. This field may contain customer's own internal ID of analyzed file (e.g. ID in database).
    - `sha256` string, required — Sha256 of the input file
    - `score` 'HIGH_QUALITY' | 'LOW_QUALITY' | 'NOT_RELEVANT_DOCUMENT', required — An enumeration.
    - `sample_metadata` SampleMetadata, required — Metadata of an analyzed file.
      - `producer` string, nullable
      - `creator` string, nullable
      - `creation_date` string, nullable
      - `mod_date` string, nullable
      - `author` string, nullable
      - `title` string, nullable
      - `keywords` string, nullable
      - `subject` string, nullable
    - `indicators` QualityIndicator[], required — Indicators contains detailed information about the specific results of our analysis, namely the quality issues detected.
      - `indicator_id` string, required — Unique identifier for the indicator
      - `type` 'RISK' | 'TRUST' | 'INFO', required — Type of a quality indicator.
      - `category` string, required — Category of indicator (e.g. `modifications`, `text_hiding`, etc.)
      - `title` string, required
      - `description` string, required — Detailed description of the indicator.
      - `metadata` union — Additional metadata associated with the indicator. <b>Content of metadata evolves and can change without prior notice</b>. It is intended mainly for visualization in UI and tracking purposes.
        - DataOnlyIndicatorMetadata
          - `type` 'DataOnly', required
          - `column_names` string[], required — Names of individual columns in data table
          - `data` array[], required — Detailed information related to given indicator, e.g. document metadata, details about discrepancies in parsed content, etc.
            - union[]
              - …
        - ElementsCollectionIndicatorMetadata
          - `type` 'ElementsCollection', required
          - `data` IndicatorMetadataElement[] — Metadata elements that represents individual detections, e.g. modified characters, area with flash reflection, etc.
            - union
              - …
          - `columns_definition` ColumnDefinition[] — Definition of columns in data table.
            - `column_name` string, required — Name of column in data table
            - `field_name` string, required — Field name in IndicatorMetadataElement object
        - CombiningIndicatorMetadata
          - `type` 'Combining', required
          - `data` union[] — Metadata elements that represents individual detections, e.g. modified characters, area with flash reflection, etc. and detailed information related to given indicator, e.g. document metadata, details about discrepancies in parsed content, etc.
            - union
              - …
      - `origin` 'quality', required
  - PipelineFailedResponse
    - `status` 'FAILED', required
    - `message` string, required
    - `deployment_version` string, required — Version of analysis engine used for analysis
    - `analysis_time` string, required — Timestamp of analysis
    - `file_type` 'unsupported' | 'pdf' | 'image' — Type of analyzed file
    - `mime_type` string, nullable — Mime type of the input file, e.g. `application/pdf`, `image/jpeg`, etc.
    - `query_id` string, nullable — Customer's own submission ID. This field may contain customer's own internal ID of analyzed file (e.g. ID in database).
  - PipelineInvalidInputResponse
    - `status` 'INVALID_INPUT', required
    - `message` string, required
    - `deployment_version` string, required — Version of analysis engine used for analysis
    - `analysis_time` string, required — Timestamp of analysis
    - `file_type` 'unsupported' | 'pdf' | 'image' — Type of analyzed file
    - `mime_type` string, nullable — Mime type of the input file, e.g. `application/pdf`, `image/jpeg`, etc.
    - `query_id` string, nullable — Customer's own submission ID. This field may contain customer's own internal ID of analyzed file (e.g. ID in database).
  - PipelineSkippedResponse
    - `status` 'SKIPPED'
    - `message` string, required
    - `deployment_version` string, required — Version of analysis engine used for analysis
    - `analysis_time` string, required — Timestamp of analysis
    - `query_id` string, nullable — Customer's own submission ID. This field may contain customer's own internal ID of analyzed file (e.g. ID in database).

## Other responses

- `400` — Bad request.
- `401` — Missing valid authentication credentials.
- `403` — Access to the requested resource is forbidden.
- `404` — The requested resource was not found.
- `415` — Unsupported media type.
- `429` — Request quota was exceeded

---

[API](https://skmtc.dev/resistant/apis/resistant-documents-api.md) · [All operations](https://skmtc.dev/resistant/apis/resistant-documents-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/resistant/resistant-documents-api/revisions/7c1ce5331e7b/schema)