Skip to main content

Process a ∀Doc

POST 
/api/v8/partner/any-documents

Veryfi's Process a ∀Doc endpoint allows you to submit and extract data from unstructured documents such as Contracts, Articles of Incorporation and any other documents and turn them into valuable business insights. The Process a ∀Doc endpoint enables you to submit the following image formats: .pdf,.jpg,.jpeg,.png,.tiff,.tif,.bmp,.gif and retrieve extracted data in JSON format. The max file size is 20mb, min file size is 1kb. Rate limit is 60 requests per second.

Request​

Body

    file_url

Responses​

Returns a processed ∀Doc.

Schema
    anyOf
    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.

    meta object
    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.

    pages object[]
  • Array [
    • ocr_score number

    Possible values: <= 1

    The average OCR score of the page.

    width integer

    The width of the page.

    height integer

    The height of the page.

  • ]
    • tags string[]

    Possible values: non-empty

    Default value: ``

    Tags associated with the document.

    ocr_score number

    Possible values: <= 1

    The average OCR score of the whole document.

    model string

    Possible values: non-empty

    The version of the model used to process the document.

    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.

    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. Sample blueprints: [ "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 stringdeprecated

    Possible values: non-empty

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

Loading...