Struct plaid::model::PhysicalDocumentExtractedData

pub struct PhysicalDocumentExtractedData {
    pub address: Option<IdentityVerificationDocumentAddressResponse>,
    pub category: String,
    pub date_of_birth: Option<NaiveDate>,
    pub expiration_date: Option<NaiveDate>,
    pub id_number: Option<String>,
    pub issuing_country: String,
    pub issuing_region: Option<String>,
}

Data extracted from a user-submitted document.

Fields

address: Option<IdentityVerificationDocumentAddressResponse>

The address extracted from the document. The address must at least contain the following fields to be a valid address: street, city, country. If any are missing or unable to be extracted, the address will be null.

region, and postal_code may be null based on the addressing system. For example:

Addresses from the United Kingdom will not include a region

Addresses from Hong Kong will not include postal code

Note: Optical Character Recognition (OCR) technology may sometimes extract incorrect data from a document.

category: String

The type of identity document detected in the images provided. Will always be one of the following values:

drivers_license - A driver’s license issued by the associated country, establishing identity without any guarantee as to citizenship, and granting driving privileges

id_card - A general national identification card, distinct from driver’s licenses as it only establishes identity

passport - A travel passport issued by the associated country for one of its citizens

residence_permit_card - An identity document issued by the associated country permitting a foreign citizen to temporarily reside there

resident_card - An identity document issued by the associated country permitting a foreign citizen to permanently reside there

visa - An identity document issued by the associated country permitting a foreign citizen entry for a short duration and for a specific purpose, typically no longer than 6 months

Note: This value may be different from the ID type that the user selects within Link. For example, if they select “Driver’s License” but then submit a picture of a passport, this field will say passport

date_of_birth: Option<NaiveDate>

A date extracted from the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).

expiration_date: Option<NaiveDate>

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

id_number: Option<String>

Alpha-numeric ID number extracted via OCR from the user’s document image.

issuing_country: String

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

issuing_region: Option<String>

An ISO 3166-2 subdivision code. Related terms would be “state”, “province”, “prefecture”, “zone”, “subdivision”, etc.

Trait Implementations

impl Clone for PhysicalDocumentExtractedData

fn clone(&self) -> PhysicalDocumentExtractedData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicalDocumentExtractedData

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

Formats the value using the given formatter.

impl Default for PhysicalDocumentExtractedData

fn default() -> PhysicalDocumentExtractedData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PhysicalDocumentExtractedData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PhysicalDocumentExtractedData

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

Formats the value using the given formatter.

impl Serialize for PhysicalDocumentExtractedData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.