Skip to main content

Classify a document

POST 
/api/v8/partner/classify

Veryfi's Classify a document endpoint allows you to classify a document. The following document types are supported: .ofd, .heif, .odt, .rtf, .csv, .gif, .htm, .png, .xlsx, .webp, .docx, .eml, .html, .doc, .pdf, .xls, .jpg, .jpeg, .avif, .bmp, .txt, .zip, .heic. The max file size is 20mb, min file size is 0.25kb. Rate limit is 60 requests per second.

Request​

Body

    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    package_path (string | null)

    Possible values: non-empty

    A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

    bucket (string | null)

    Possible values: non-empty

    An S3 bucket for 'package_path', e.g. 'documents'.

    file_data (string | null)

    Possible values: non-empty

    Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls or uploading zip files.

    file_url (string | null)

    Possible values: non-empty

    A URL to a publicly accessible document to be sent to Veryfi for processing.

    file_urls string[]

    Possible values: non-empty

    An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

    file_name (string | null)

    Possible values: non-empty

    An optional filename. Useful to determine file type.

    document_types object[]

    Possible values: >= 1

    The types to classify the document into. If omitted, a preset set of types will be used.

  • Array [
    • anyOf

    string

  • ]

Responses​

Returns the document type prediction result. When the model cannot determine a type, document_type.value is null and the HTTP status remains 200. A 400 with Failed to predict document type indicates the classification service failed, not that the model was uncertain.

Schema
    id integerrequired

    Possible values: > 0

    The unique identifier of the classification.

    document_type object required

    The type of the document. If a list of custom types is provided, CustomDocumentType will be the model for this field.

    anyOf
    score (number | null)

    Possible values: <= 1

    The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

    value (string | null)required

    Possible values: [other, receipt, invoice, purchase_order, w9, statement, check, contract, w8, remittance_advice, business_card, bank_statement, w2, packing_slip, credit_note]

    The type of the document.

Loading...