Skip to main content

Get a ∀Doc

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

Veryfi's Get a ∀Doc endpoint allows you to retrieve a previously processed ∀Doc.

Request​

Path Parameters

    document_id int64required

    The unique identifier of the document.

Query Parameters

    bounding_boxes boolean

    A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

    confidence_details boolean

    A field used to determine whether or not to return the score and ocr_score fields in the Document response.

Responses​

Returns a processed ∀Doc.

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

    is_blurry ClassNullableBoolField

    The processed page is blurry or not

    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 (boolean | null)required

    The extracted value.

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

    original_file_name (string | null)

    Possible values: non-empty

    The original file name of the uploaded document.

    source string

    Possible values: [api.email, api.web, api, browser_extension, lens.bill, lens.invoice, lens.long_receipt, lens.other, lens.receipt, lens.web, lens]

    Default value: api

    The source of the document's submission for processing.

    device_data ResponsesDeviceData

    device data containing uuid

    uuid object

    Device unique identifier

    anyOf

    string

    user_uuid object

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

    anyOf

    string

    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, ai generated, duplicate, digital tampering, multiple profiles or devices, high velocity, critical velocity, invalid mrz data]

    List of attributions which marked the document as fraud

    details AnyDocumentFraudDetails

    Strictly typed descriptions and reasons keyed by fraud type.

    lcd_photo _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    screenshot _ScreenshotDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    reasons object[]
  • Array [
    • name stringrequired

    Possible values: [mobile_screenshot, other_screenshot]

    description stringrequired

    Possible values: non-empty

  • ]
    • fraudulent_pdf _FraudulentPDFDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    reasons object[]
  • Array [
    • anyOf
    name stringrequired

    Possible values: [text_overlay, font_mismatch, modified, date_inversion, producer_content_mismatch, writer_mismatch, null_metadata, xmp_info_mismatch, future_metadata_date, raster_profile_mismatch, uncompressed_raster, double_jpeg, scrubbed_provenance]

    description stringrequired

    Possible values: non-empty

  • ]
    • not_a_document _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    generated_document _GeneratedDocumentDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    reasons object[]
  • Array [
    • name stringrequired

    Possible values: [ai_generated_provenance, ai_enhanced_provenance, possible_ai_provenance, provenance_integrity_clash, headless_browser_render]

    description stringrequired

    Possible values: non-empty

    field (string | null)
    value (string | null)

    Possible values: non-empty

  • ]
    • ai_generated _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    duplicate _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    digital_tampering _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    multiple_profiles_or_devices _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    high_velocity _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    critical_velocity _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    invalid_mrz_data _FraudTypeDetails
    description stringrequired

    Possible values: non-empty

    Human-readable explanation of the fired fraud type.

    submissions object

    The amount of submissions from specific device id, used in velocity fraud detection.

    property name* integer
    duplicate_detection_method (string | null)

    Possible values: [text_similarity, field_matching]

    Method used to detect duplicates for fraud

    duplicates object[]

    An array of duplicate documents found for purposes of fraud detection

  • Array [
    • id integerrequired

    The id of the duplicate document.

    url urirequired

    Possible values: non-empty and <= 2083 characters

    The url of the duplicate document.

  • ]
    • fraudulent_pdf FraudulentPDFResult

    Results of the pdf analysis.

    fraudulent_pdf_creator (number | null)
    text_overlay (number | null)
    font_mismatch (number | null)
    has_digital_signature (boolean | null)
    pdf_modified (number | null)
    incremental_updates (integer | null)
    incremental_changes string[]

    Possible values: non-empty

    What incremental PDF revisions changed.

    incremental_edits object[]

    Which word an incremental PDF revision replaced, and on which page.

  • Array [
    • page integerrequired

    Possible values: > 0

    1-based number of the page the edit landed on.

    before (string | null)

    Possible values: non-empty

    The replaced word, or null when the word was inserted.

    after (string | null)

    Possible values: non-empty

    The replacing word, or null when the word was deleted.

  • ]
    • signature_creation_tools string[]

    Possible values: non-empty

    date_inversion (number | null)
    producer_content_mismatch (number | null)
    writer_mismatch (number | null)
    null_metadata (number | null)
    xmp_info_mismatch (number | null)
    future_metadata_date (number | null)
    raster_profile_mismatch (number | null)
    uncompressed_raster (number | null)
    spliced_page (number | null)
    spliced_page_number (integer | null)

    Possible values: > 0

    1-based number of the first page written after the pages surrounding it. Later pages may belong to the same block.

    headless_desktop_render (number | null)

    Score for a PDF an automated browser rendered from a desktop operating system. It is reported here but scored against the generated document signal, so it does not move the fraudulent pdf score.

    headless_render_platform (string | null)

    Possible values: non-empty

    Operating system named by the headless browser that rendered the PDF. Reported for every headless render, including the server platforms that do not score.

    double_jpeg (number | null)

    Score for a raster that was JPEG-compressed more than once. An original capture is compressed exactly once, so a second compression means the file is not the first-generation scan it presents itself as. Disabled by default, and reported as 0.0 until it is enabled for your account.

    first_quantization_quality (integer | null)

    Possible values: > 0

    JPEG quality of the first compression, recovered from the coefficient histograms. Evidence for a reviewer rather than a score, and absent when nothing coherent was recovered.

    scrubbed_provenance (number | null)

    Score for a raster whose encoder signature carries no provenance: grayscale content in a subsampled colour JPEG, no EXIF, a placeholder JFIF density and a stock quantization table. Reaches the same conclusion as double_jpeg for a re-encode too coarse to leave a recoverable first compression. Disabled by default, and reported as 0.0 until it is enabled for your account.

    score (number | null)
    device_profiles object[]

    Device/profile pairs supporting the multiple profiles or devices fraud signal.

  • Array [
    • device_id stringrequired

    Possible values: non-empty

    profile_id stringrequired

    Possible values: non-empty

    document_count integerrequired
  • ]
    • 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

  • ]
    • ai_generated 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.

    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
  • ]
  • ]
    • digital_tampering_fields string[]

    List of fields which were digitally tampered. Does not work with the parameter boost_mode set to true.

    blueprint_version BlueprintVersionInfo

    The version of the blueprint used to extract data.

    id integerrequired
    number integerrequired
    name (string | null)

    Possible values: non-empty

    barcodes object[]

    An array of barcodes detected on the document.

  • Array [
    • bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    data (string | null)

    Possible values: non-empty

    The machine-readable representation of the barcode found on the document.

    type (string | null)

    Possible values: non-empty

    The name of the encoding for the barcode. Supported types include: QR Code, PDF417, EAN, UPC, Code128, Code39, I25

  • ]
    • warnings object[]

    An array of warnings to help catch errors or fraud on the processed document.

  • Array [
    • type stringrequired

    Possible values: [tax_rate_mismatch, item_counts_mismatch, totals_mismatch, line_item_amount_mismatch, line_item_repeats, barcode_decoding_issue, barcode_code_missing_in_ocr, logo_vendor_mismatch, malware, weekend_transaction, time_and_currency_mismatch, exif_creation_modified_date_mismatch, missing_date, suspicious_document_aspect_ratio, generic_placeholder_content]

    Type of the warning, e.g. barcode_code_missing_in_ocr. Type is an enumerated field and comes from a defined number of enumerated values.

    message stringrequired

    Possible values: non-empty

    The detailed message about the warning.

  • ]
    • handwritten_fields string[]

    List of fields which were handwritten. Does not work with the parameter boost_mode set to true.

    fully_handwritten_fields string[]

    List of fields which were fully handwritten (excluding tampering). Does not work with the parameter boost_mode set to true.

    handwritten_tampered_fields string[]

    List of fields which were tampered. Does not work with the parameter boost_mode set to true.

    handwriting_detected (boolean | null)

    Heads-up flag set to true when handwriting (including handwritten tampering) is detected anywhere on the document, including outside the fields configured in fraud.handwriting.enabled_fields. Independent from handwritten_fields. Does not work with the parameter boost_mode set to true.

    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.

Loading...