Class: Dataleon::Models::Individual::IdentityCard

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dataleon/models/individual.rb

Overview

See Also:

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from Dataleon::Internal::Type::BaseModel

Instance Attribute Details

#back_document_signed_url ⇒ String?

Signed URL linking to the back image of the document.

Returns:

  • (String, nil) 


336
 
# File 'lib/dataleon/models/individual.rb', line 336

optional :back_document_signed_url, String

#birth_place ⇒ String?

Place of birth as indicated on the document.

Returns:

  • (String, nil) 


342
 
# File 'lib/dataleon/models/individual.rb', line 342

optional :birth_place, String

#birthday ⇒ String?

Date of birth in DD/MM/YYYY format as shown on the document.

Returns:

  • (String, nil) 


348
 
# File 'lib/dataleon/models/individual.rb', line 348

optional :birthday, String

#country ⇒ String?

Country code issuing the document (ISO 3166-1 alpha-2).

Returns:

  • (String, nil) 


354
 
# File 'lib/dataleon/models/individual.rb', line 354

optional :country, String

#entitlement_date ⇒ String?

Date of entitlement or validity start date, in YYYY-MM-DD format.

Returns:

  • (String, nil) 


360
 
# File 'lib/dataleon/models/individual.rb', line 360

optional :entitlement_date, String

#expiration_date ⇒ String?

Expiration date of the document, in YYYY-MM-DD format.

Returns:

  • (String, nil) 


366
 
# File 'lib/dataleon/models/individual.rb', line 366

optional :expiration_date, String

#first_name ⇒ String?

First name as shown on the document.

Returns:

  • (String, nil) 


372
 
# File 'lib/dataleon/models/individual.rb', line 372

optional :first_name, String

#front_document_signed_url ⇒ String?

Signed URL linking to the front image of the document.

Returns:

  • (String, nil) 


378
 
# File 'lib/dataleon/models/individual.rb', line 378

optional :front_document_signed_url, String

#gender ⇒ String?

Gender indicated on the document (e.g., “M” or “F”).

Returns:

  • (String, nil) 


384
 
# File 'lib/dataleon/models/individual.rb', line 384

optional :gender, String

#id ⇒ String?

Unique identifier for the document.

Returns:

  • (String, nil) 


330
 
# File 'lib/dataleon/models/individual.rb', line 330

optional :id, String

#issue_date ⇒ String?

Date when the document was issued, in YYYY-MM-DD format.

Returns:

  • (String, nil) 


390
 
# File 'lib/dataleon/models/individual.rb', line 390

optional :issue_date, String

#last_name ⇒ String?

Last name as shown on the document.

Returns:

  • (String, nil) 


396
 
# File 'lib/dataleon/models/individual.rb', line 396

optional :last_name, String

#mrz_line_1 ⇒ String?

First line of the Machine Readable Zone (MRZ) on the document.

Returns:

  • (String, nil) 


402
 
# File 'lib/dataleon/models/individual.rb', line 402

optional :mrz_line_1, String

#mrz_line_2 ⇒ String?

Second line of the MRZ on the document.

Returns:

  • (String, nil) 


408
 
# File 'lib/dataleon/models/individual.rb', line 408

optional :mrz_line_2, String

#mrz_line_3 ⇒ String?

Third line of the MRZ if applicable; otherwise null.

Returns:

  • (String, nil) 


414
 
# File 'lib/dataleon/models/individual.rb', line 414

optional :mrz_line_3, String, nil?: true

#type ⇒ String?

Type of document (e.g., passport, identity card).

Returns:

  • (String, nil) 


420
 
# File 'lib/dataleon/models/individual.rb', line 420

optional :type, String