class

Plaid::DocumentaryVerificationDocument

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

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

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

analysis
Source
analysis=(new_value : DocumentAnalysis | Nil)

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

Source
attempt

The attempt field begins with 1 and increments with each subsequent document upload.

Source
attempt=(new_value : Int32 | Nil)

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

Source
extracted_data
Source
extracted_data=(new_value : PhysicalDocumentExtractedData | Nil)

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

images
Source
images=(new_value : PhysicalDocumentImages | Nil)

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

An ISO8601 formatted timestamp.

Source
redacted_at=(new_value : Time | Nil)

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

Source
status
Source
status=(new_value : Plaid::DocumentStatus | Nil)

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