class Plaid::DocumentaryVerificationDocument

Overview

Images, extracted data, and analysis from a user's identity document

Included Modules

Defined in:

plaid/models/documentary_verification_document.cr

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(*, status : Plaid::DocumentStatus | Nil = nil, attempt : Int32 | Nil = nil, images : PhysicalDocumentImages | Nil = nil, extracted_data : PhysicalDocumentExtractedData | Nil = nil, analysis : DocumentAnalysis | Nil = nil, redacted_at : Time | 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 analysis : DocumentAnalysis | Nil #

[View source]
def analysis=(new_value : DocumentAnalysis | Nil) #

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


[View source]
def attempt : Int32 | Nil #

[View source]
def attempt=(new_value : Int32 | Nil) #

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


[View source]
def extracted_data : PhysicalDocumentExtractedData | Nil #

[View source]
def extracted_data=(new_value : PhysicalDocumentExtractedData | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] extracted_data 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 images : PhysicalDocumentImages | Nil #

[View source]
def images=(new_value : PhysicalDocumentImages | Nil) #

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


[View source]
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 redacted_at : Time | Nil #

[View source]
def redacted_at=(new_value : Time | Nil) #

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


[View source]
def status : Plaid::DocumentStatus | Nil #

[View source]
def status=(new_value : Plaid::DocumentStatus | Nil) #

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