class

Plaid::PhysicalDocumentImages

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

URLs for downloading original and cropped images for this document submission. The URLs are designed to only allow downloading, not hot linking, so the URL will only serve the document image for 60 seconds before expiring. The expiration time is 60 seconds after the GET request for the associated Identity Verification attempt. A new expiring URL is generated with each request, so you can always rerequest the Identity Verification attempt if one of your URLs expires.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, original_front : String | Nil = nil, original_back : String | Nil = nil, cropped_front : String | Nil = nil, cropped_back : String | Nil = nil, face : 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

cropped_back

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document was not collected.

Source
cropped_back=(new_value : String | Nil)

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

Source
cropped_front

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.

Source
cropped_front=(new_value : String | Nil)

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

Source
face

Temporary URL that expires after 60 seconds for downloading a crop of just the user's face from the document image. Might be null if the document does not contain a face photo.

Source
face=(new_value : String | Nil)

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

Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not collected.

Source
original_back=(new_value : String | Nil)

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

Source
original_front

Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.

Source
original_front=(new_value : String | Nil)

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