class

Plaid::IdentityVerificationDocumentAddressResponse

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

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.

Constants

MIN_LENGTH_FOR_COUNTRY = 2

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, street : String | Nil = nil, city : String | Nil = nil, region : String | Nil = nil, postal_code : String | Nil = nil, country : String | 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

city

City extracted from the document.

Source
city=(new_value : String | Nil)

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

Source
country

Valid, capitalized, two-letter ISO code representing the country extracted from the document. Must be in ISO 3166-1 alpha-2 form.

Source
country=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] country 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

list_invalid_properties

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

Source
postal_code

The postal code extracted from the document. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.

Source
postal_code=(new_value : String | Nil)

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

Source
region

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

Source
region=(new_value : String | Nil)

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

Source
street

The full street address extracted from the document.

Source
street=(new_value : String | Nil)

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

Source
valid?

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

Source