Skip to main content

Process a Markdown Document asynchronously

POST 
/api/v8/partner/document-to-markdown/async

Same as the Process a Markdown Document endpoint, but returns a document id instead of a processed Markdown Document and processes the document asynchronously.

Request​

Body

    auto_delete boolean

    Default value: false

    Whether to delete the document after processing. In async deletes the document after the first GET request.

    details (boolean | null)
    document_type (string | null)

    Default value: document

    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.

    tags string[]
    max_pages_to_process (integer | null)

    Possible values: >= 1 and <= 50

    Default value: 50

    meta.tags string[]

    Possible values: non-empty

    Default value: ``

    Tags you want to associate with the document.

    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.

Responses​

Returns a document id.

Schema
    id integerrequired
Loading...