Struct DocumentRiskSignal 

pub struct DocumentRiskSignal {
    pub actual_value: Option<String>,
    pub expected_value: Option<String>,
    pub field: Option<String>,
    pub has_fraud_risk: Option<bool>,
    pub institution_metadata: Option<DocumentRiskSignalInstitutionMetadata>,
    pub page_number: Option<i64>,
    pub signal_description: Option<String>,
    pub type_: Option<String>,
}

Details about a certain reason as to why a document could potentially be fraudulent.

Fields

actual_value: Option<String>

The derived value obtained in the risk signal calculation process for this field

expected_value: Option<String>

The expected value of the field, as seen on the document

field: Option<String>

The field which the risk signal was computed for

has_fraud_risk: Option<bool>

A flag used to quickly identify if the signal indicates that this field is authentic or fraudulent

institution_metadata: Option<DocumentRiskSignalInstitutionMetadata>

An object which contains additional metadata about the institution used to compute the verification attribute

page_number: Option<i64>

The relevant page associated with the risk signal. If the risk signal is not associated with a specific page, the value will be 0.

signal_description: Option<String>

A human-readable explanation providing more detail into the particular risk signal

type_: Option<String>

The type of risk found in the risk signal check.

Trait Implementations

impl Clone for DocumentRiskSignal

fn clone(&self) -> DocumentRiskSignal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentRiskSignal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocumentRiskSignal

fn default() -> DocumentRiskSignal

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentRiskSignal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocumentRiskSignal

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for DocumentRiskSignal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.