Skip to main content

Process ∀Doc

POST 
/api/v8/partner/any-documents

Veryfi's Process ∀Doc endpoint allows you to submit and extract data from unstructured documents (such as Contracts, Articles of Incorporation and others) and turn them into valuable business insights.

Request​

Body

    file_data string

    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

    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.

    package_path string

    Possible values: non-empty

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

    bucket string

    Possible values: non-empty

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

    file_name string

    Possible values: non-empty

    An optional filename. Useful to determine file type.

    max_pages_to_process integer

    Possible values: >= 1 and <= 50

    Default value: 20

    The number of pages to process for the document. The limit is 50 pages per document.

    blueprint_name string

    Possible values: non-empty

    The name of the extraction blueprints.

    template_name stringdeprecated

    Possible values: non-empty

    The blueprint name which was used to extract the data. Same as blueprint_name.

Responses​

The processed document.

Schema
    pdf_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    id integerrequired

    The unique number created to identify the document.

    external_id string

    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.

    created_date date-timerequired
    updated_date date-timerequired
    img_thumbnail_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated thumbnail created for the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    blueprint_name stringrequired

    Possible values: non-empty

    The blueprint name which was used to extract the data.

    template_name stringdeprecated

    Possible values: non-empty

    The blueprint name which was used to extract the data. Same as blueprint_name.

    property name* any
Loading...