---
title: "Fetch document classification"
method: GET
path: "/v2/submission/{submission_id}/classification"
---

# Fetch document classification

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

Fetch classification of the type of the submitted document

## Path parameters

- `submission_id` string, required

## Response `200`

Results of document type classification if classification analysis was enabled for the submission.

- union
  - ClassificationSuccessResponse
    - `status` 'SUCCESS', required
    - `analysis_time` string, required — Timestamp of analysis
    - `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
    - `mime_type` string, required — Mime type of the input file, e.g. `application/pdf`, `image/jpeg`, etc.
    - `document_classification` DocumentClassification — Information about the type and issuer of the submitted document
      - `score` 'CLASSIFIED' | 'DOCUMENT_MISSING' | 'NOT_CLASSIFIED', nullable — Toplevel score for classification
      - `document_type` 'id_document' | 'income_confirmation' | 'loan_document' | 'bank_document' | 'utility_bill' | 'company_information' | 'government_document' | 'commercial_document' | 'legal_document' | 'insurance_document' | 'tax_details' | 'vehicle_documentation' | 'other_document' | 'document_missing' | 'no_classification' | 'null', nullable — A unique identifier of the document type
      - `detailed_type` 'birth_certificate' | 'drivers_license' | 'health_insurance_card' | 'id_card' | 'id_certificate' | 'passport' | 'residence_permit' | 'proof_of_address' | 'other' | 'earnings_confirmation' | 'earnings_statement' | 'earnings_summary' | 'payslip' | 'unemployment_certificate' | 'other' | 'client_assessment' | 'costs_estimate' | 'loan_agreement' | 'loan_application' | 'loan_closure' | 'security_agreement' | 'other' | 'account_confirmation' | 'account_statement' | 'transaction_history' | 'bank_details' | 'fees_statement' | 'payment_confirmation' | 'bank_card' | 'bank_cheque' | 'other' | 'energy' | 'water' | 'utilities' | 'telco' | 'mobile_phone' | 'municipal_services' | 'other' | 'company_detail' | 'employer_identification_number' | 'financial_report' | 'accounting_records' | 'company_share_capital_detail' | 'incorporation_certificate' | 'other' | 'maternity_allowance_claim' | 'property_detail' | 'postal_document' | 'other' | 'invoice' | 'receipt' | 'delivery_note' | 'order_confirmation' | 'tracking_note' | 'transport_order' | 'quote' | 'payment_request' | 'rate_confirmation' | 'load_confirmation' | 'order' | 'other' | 'rental_agreement' | 'court_document' | 'employment_contract' | 'contract' | 'policy' | 'education_certificate' | 'marriage_certificate' | 'death_certificate' | 'divorce_certificate' | 'apostille' | 'other' | 'insurance_claim' | 'insurance_documentation' | 'insurance_claim_settlement' | 'investigation_report' | 'proof_of_insurance' | 'other' | 'tax_form' | 'tax_information' | 'other' | 'vehicle_appraisal' | 'vehicle_registration_certificate' | 'vehicle_technical_certificate' | 'other' | 'medical_report' | 'email' | 'letter' | 'loan_offer' | 'credit_card' | 'ticket' | 'report' | 'paper_date' | 'screenshot' | 'resume' | 'other' | 'missing' | 'null', nullable — More specific type of document
      - `issuer_parent` DocumentIssuer, nullable — Document issuer information
        - `name` string, required — Legal entity name
        - `country` string, nullable, required — [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) of the country or the string `UNKNOWN`
        - `issuer_id` string — Official identificator of the issuing legal entity
        - `legal_address` PhysicalAddress
          - `street_address` string, required
      - `issuer` DocumentIssuer, nullable — Document issuer information
        - `name` string, required — Legal entity name
        - `country` string, nullable, required — [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) of the country or the string `UNKNOWN`
        - `issuer_id` string — Official identificator of the issuing legal entity
        - `legal_address` PhysicalAddress
          - `street_address` string, required
      - `variant` string, nullable — The values assigned to the "variant" field should accurately reflect the specific version or variation of the document, allowing for precise classification and subsequent processing.
  - 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.
- `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)
