Struct plaid::model::EntityWatchlistProgram

pub struct EntityWatchlistProgram {
    pub audit_trail: WatchlistScreeningAuditTrail,
    pub created_at: DateTime<Utc>,
    pub id: String,
    pub is_archived: bool,
    pub is_rescanning_enabled: bool,
    pub lists_enabled: Vec<String>,
    pub name: String,
    pub name_sensitivity: String,
}

A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.

Fields

audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

created_at: DateTime<Utc>

An ISO8601 formatted timestamp.

id: String

ID of the associated entity program.

is_archived: bool

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

is_rescanning_enabled: bool

Indicator specifying whether the program is enabled and will perform daily rescans.

lists_enabled: Vec<String>

Watchlists enabled for the associated program

name: String

A name for the entity program to define its purpose. For example, “High Risk Organizations” or “Applicants”.

name_sensitivity: String

The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity.

coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.

balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.

strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.

exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.

Trait Implementations

impl Clone for EntityWatchlistProgram

fn clone(&self) -> EntityWatchlistProgram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityWatchlistProgram

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

Formats the value using the given formatter.

impl Default for EntityWatchlistProgram

fn default() -> EntityWatchlistProgram

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntityWatchlistProgram

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EntityWatchlistProgram

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

Formats the value using the given formatter.

impl Serialize for EntityWatchlistProgram

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

where __S: Serializer,

Serialize this value into the given Serde serializer.