class Plaid::IdentityVerificationDocumentAddressResponse

Overview

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.

Included Modules

Defined in:

plaid/models/identity_verification_document_address_response.cr

Constant Summary

MIN_LENGTH_FOR_COUNTRY = 2

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def city : String | Nil #

[View source]
def city=(new_value : String | Nil) #

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


[View source]
def country : String | Nil #

[View source]
def country=(new_value : String | Nil) #

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


[View source]
def hash(hasher) #

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


def list_invalid_properties : Array(String) #

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


[View source]
def postal_code : String | Nil #

[View source]
def postal_code=(new_value : String | Nil) #

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


[View source]
def region : String | Nil #

[View source]
def region=(new_value : String | Nil) #

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


[View source]
def street : String | Nil #

[View source]
def street=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]