class

Plaid::PhysicalDocumentExtractedData

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Data extracted from a user-submitted document.

Constants

MIN_LENGTH_FOR_ISSUING_COUNTRY = 2

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id_number : String | Nil = nil, category : Plaid::PhysicalDocumentCategory | Nil = nil, expiration_date : Time | Nil = nil, issuing_country : String | Nil = nil, issuing_region : String | Nil = nil, date_of_birth : Time | Nil = nil, address : IdentityVerificationDocumentAddressResponse | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

address
Source
address=(new_value : IdentityVerificationDocumentAddressResponse | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] address Object to be assigned

Source
category
Source
category=(new_value : Plaid::PhysicalDocumentCategory | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] category Object to be assigned

Source
date_of_birth

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

Source
date_of_birth=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] date_of_birth Object to be assigned

Source
expiration_date

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

Source
expiration_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expiration_date Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id_number

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

Source
id_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id_number Object to be assigned

Source
issuing_country

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

Source
issuing_country=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] issuing_country Object to be assigned

Source
issuing_region

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

Source
issuing_region=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] issuing_region Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source