class

Tourmaline::EncryptedPassportElement

Inherits JSON::Serializable < Reference < Object

Describes documents or other Telegram Passport elements shared with the bot by the user.

Constructors

new(type : String, hash : String, data : String | Nil = nil, phone_number : String | Nil = nil, email : String | Nil = nil, files : Array(Tourmaline::PassportFile) = [] of Tourmaline::PassportFile, front_side : Tourmaline::PassportFile | Nil = nil, reverse_side : Tourmaline::PassportFile | Nil = nil, selfie : Tourmaline::PassportFile | Nil = nil, translation : Array(Tourmaline::PassportFile) = [] of Tourmaline::PassportFile)

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

data

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials.

data=(data : String | Nil)

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials.

email

Optional. User's verified email address; available only for "email" type

email=(email : String | Nil)

Optional. User's verified email address; available only for "email" type

files

Optional. Array of encrypted files with documents provided by the user; available only for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

files=(files : Array(Tourmaline::PassportFile))

Optional. Array of encrypted files with documents provided by the user; available only for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

front_side

Optional. Encrypted file with the front side of the document, provided by the user; available only for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.

front_side=(front_side : Tourmaline::PassportFile | Nil)

Optional. Encrypted file with the front side of the document, provided by the user; available only for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.

hash

Base64-encoded element hash for using in PassportElementErrorUnspecified

hash=(hash : String)

Base64-encoded element hash for using in PassportElementErrorUnspecified

phone_number

Optional. User's verified phone number; available only for "phone_number" type

phone_number=(phone_number : String | Nil)

Optional. User's verified phone number; available only for "phone_number" type

reverse_side

Optional. Encrypted file with the reverse side of the document, provided by the user; available only for "driver_license" and "identity_card". The file can be decrypted and verified using the accompanying EncryptedCredentials.

reverse_side=(reverse_side : Tourmaline::PassportFile | Nil)

Optional. Encrypted file with the reverse side of the document, provided by the user; available only for "driver_license" and "identity_card". The file can be decrypted and verified using the accompanying EncryptedCredentials.

selfie

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.

selfie=(selfie : Tourmaline::PassportFile | Nil)

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.

translation

Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

translation=(translation : Array(Tourmaline::PassportFile))

Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

type

Element type. One of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email".

type=(type : String)

Element type. One of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email".