Skip to main content

Process a ∀Doc asynchronously

POST 
/api/v8/partner/any-documents/async

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

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.

    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.

    meta.device_data.uuid (string | null)

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Device unique identifier

    meta.device_data.user_uuid (string | null)

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    User unique identifier, like a digital fingerprint (hashed login) used to access the app where they upload their documents. Used in fraud detection.

    max_pages_to_process (integer | null)

    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 | null)

    Possible values: non-empty

    The name of the extraction blueprints. Default blueprints include [auto_insurance_card, bill_of_lading, flight_itinerary, goods_received_note, incorporation_document, incorporation_document_latam, indian_passport, latam_passport, prescription_medication_label, product_nutrition_facts, restaurant_menu, shipping_label, uk_drivers_license, us_driver_license, us_health_insurance_card, us_passport, vehicle_registration, vendor_statement, work_order]

    template_name (string | null)deprecated

    Possible values: non-empty

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

    auto_delete boolean

    Default value: false

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

Responses​

Returns a document id.

Schema
    id integerrequired
Loading...