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_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
fingerprint_match
future_date
future_year
invalid_bank_statement_txn_date
invalid_date
invalid_year
misaligned_text
online_generated_paystub
other_edits
page_edited
pay_frequency_edits
suspected_template
suspicious_address
transaction_description_edits
txn_data_unavailable
unreconciled_bank_statement_balance_data
withholdings_edits
w2_excessive_social_security_tax_wage_base_limit
w2_invalid_medicare_wages
w2_invalid_medicare_wages_and_tips
w2_medicare_wage_base_missing
w2_invalid_state_taxes_paid
w2_invalid_statutory_employee_federal_tax
w2_state_taxes_not_paid
w2_social_security_wage_base_missing
w2_unreconciled_medicare_tax_withholding
w2_unreconciled_social_security_tax_withholding
w2_unreconciled_state_tax_base

`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 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.

`supporting_data`

Type: List of SupportingData objects
Required: true
Min. Item Count: 1

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