Skip to main content

Update a ∀Doc

PUT 
/api/v8/partner/any-documents/:document_id

Veryfi's Update a Document by ID endpoint allows you to change a Document that Veryfi's Machine Learning models have already processed. This feature will enable users to update Documents previously processed by Veryfi to ensure data extraction accuracy. Updating a Document is especially useful for correcting mistakes and updating information over time. By changing a processed Document, Veryfi's Machine Learning models can re-learn the updated information, allowing them to stay accurate and up-to-date.

Request​

Path Parameters

    document_id int64required

    The unique identifier of the document.

Body

    external_id (string | null)deprecated

    Possible values: non-empty

    Deprecated 2025-01-09, use meta.external_id instead.

    meta PutMeta
    external_id (string | null)

    Possible values: non-empty

    tags string[]

    Possible values: non-empty

    Default value: ``

Responses​

A processed ∀Doc response.

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

    pages object[]
  • Array [
    • ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the page.

    width (integer | null)

    The width of the page.

    height (integer | null)

    The height of the page.

  • ]
    • tags string[]

    Possible values: non-empty

    Default value: ``

    Tags associated with the document.

    ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the whole document.

    model (string | null)

    Possible values: non-empty

    The version of the model used to process the document.

    device_data ResponsesDeviceData

    device data containing uuid

    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

    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.

    duplicates object[]

    An array of duplicate documents found in the system.

  • Array [
    • id integerrequired

    The id of the duplicate document.

    url urirequired

    Possible values: non-empty and <= 2083 characters

    The url of the duplicate document.

    score numberrequired

    Possible values: <= 1

    How close is the match

  • ]
    • fraud AnydocFraud

    An object that contains additional information to help check for fraud.

    score (number | null)

    Possible values: <= 1

    Confidence of Fraud Detector in it's prediction

    color (string | null)

    Possible values: [green, yellow, red]

    Color from Fraud Detector: green means legitimate, yellow means review needed and red means fraud

    types string[]

    Possible values: [LCD photo, screenshot, fraudulent pdf, not a document, generated document, multiple profiles or devices]

    List of attributions which marked the document as fraud

    pages object[]

    An array containing fraud info about each extracted page

  • Array [
    • is_lcd ClassBoolField
    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 booleanrequired

    The extracted value.

    flags object[]

    List of flags which marked the document as fraud

  • Array [
    • 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 stringrequired

    Possible values: non-empty

  • ]
    • handwriting object[]

    An array containing handwriting info about each extracted page

  • Array [
    • bounding_region number[]required

    Possible values: >= 8, <= 8

    Bounding region of the artifact in [x1,y1,x2,y2,x3,y3,x4,y4] format

    type stringrequired

    Possible values: non-empty

    Type of the artifact

    score number
  • ]
    • digital_tampering object[]

    An array containing digital tampering info about each extracted page

  • Array [
    • bounding_region number[]required

    Possible values: >= 8, <= 8

    Bounding region of the artifact in [x1,y1,x2,y2,x3,y3,x4,y4] format

    type stringrequired

    Possible values: non-empty

    Type of the artifact

    score number
  • ]
  • ]
    • 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.

    text (string | null)

    The text returned from converting the document into a machine-readable text format.

    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.

    property name* any
Loading...