Visualization Region

Overview

Model Name: VisualizationRegion

A highlighted region of suspected fraud, as well as the information needed to depict it visually.

Properties

visual_type

Type
String
Required
true

A machine-readable identifier that indicates the type of file tampering visualization offered in this image. This value will not change; you may rely on it in your application logic.

  • tamper_overview: Tampered fields are highlighted in red.
  • edit_regions: Red highlights indicate the areas of the original document that were changed.
  • original_pdf: Red highlights indicate the areas of the original document that were changed.
  • tampered_font: The same field appears to use multiple fonts. Where possible, the fonts within a field are highlighted with different colors.
  • added_fonts: Text that was added to the document is highlighted in red.
  • overwritten_text: Text has been added to (or modified from) the original document. Where possible, unchanged text will be highlighted in green while added text will be highlighted in red. In some cases, only one of these two regions will be shown; this still indicates suspicious activity.

Possible Values

  • tamper_overview
  • edit_regions
  • original_pdf
  • tampered_fonts
  • added_fonts
  • overwritten_text

display_name

Type
String
Required
true
Min. Length
1

A human-readable version of the value given in identifier. You should display this value within your application.

description

Type
String
Required
true
Min. Length
1

A human-readable description of the visualized fraud signal and guidance on how to interpret it. You should display this value within your application.

image_url

Type
String (url)
Required
true

A URL to an image that represents this visualization. The image's content is the analyzed page with translucent colored squares overlaid on the regions of suspected fraud.
The image requires authentication to access, which means it can't be hot-linked within your own web apps. You can provide your credentials to retrieve it the same way you would with our other endpoints.
The image is stored indefinitely, but will be deleted if the associated Book or Document is deleted.