Signal

Overview

Model Name: Signal

Details about a suspected instance of fraudulent document manipulation and all accompanying data.

Properties

identifier

Type
String
Required
true

An identifier that describes the type of suspected fraud signal. This value is stable and can be relied upon in your application logic.

Possible Values

  • account_holder_address_edits
  • account_holder_edits
  • account_number_edits
  • account_type_edits
  • date_edits
  • deductions_edits
  • dollar_amount_edits
  • earnings_edits
  • employee_address_edits
  • employee_details_edits
  • employee_name_edits
  • employee_taxpayer_id_edits
  • employer_address_edits
  • employer_id_edits
  • employer_name_edits
  • other_edits
  • pay_frequency_edits
  • transaction_edits
  • withholdings_edits

display_name

Type
String
Required
true

A human-friendly name for the fraud signal named in identifier. This value is unlikely to change, but you shouldn't rely on it for application logic. You should display this value within your own application where applicable.

signal_count

Type
Integer
Required
true
Min. Value
1

The number of fraud signals that we've identified. Will be the same as the length of the page_supporting_data array.

page_number

Type
Integer (or null)
Required
true
Min. Value
1

The (one-indexed) number of the flagged page. Will be null if the fraud signal isn't specific to any particular page, such as for inconsistent data or erroneous arithmetic.
This number refers to the index of the page within the document, rather than any number that's captured from the page or its metadata. In other words, this value will be 1 for the first page of a document, even "Page 2" is written in one of its corners.

page_supporting_data

Type
List of PageSupportingData objects
Required
true
Min. Item Count
1

The specific captured data that supports a claim of fraudulent activity.