Telegram Bot/eu.vendeli.tgbot.types.passport/EncryptedPassportElement

EncryptedPassportElement

@Serializable

data class EncryptedPassportElement(val type: EncryptedPassportElementType, val data: String? = null, val phoneNumber: String? = null, val email: String? = null, val files: List<PassportFile>? = null, val frontSide: PassportFile? = null, val reverseSide: PassportFile? = null, val selfie: PassportFile? = null, val translation: List<PassportFile>? = null, val hash: String)

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

Api reference

Constructors

EncryptedPassportElement

constructor(type: EncryptedPassportElementType, data: String? = null, phoneNumber: String? = null, email: String? = null, files: List<PassportFile>? = null, frontSide: PassportFile? = null, reverseSide: PassportFile? = null, selfie: PassportFile? = null, translation: List<PassportFile>? = null, hash: String)

Properties

data

val data: String? = null

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.

val email: String? = null

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

files

val files: List<PassportFile>? = null

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.

frontSide

val frontSide: PassportFile? = null

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

val hash: String

Base64-encoded element hash for using in PassportElementErrorUnspecified

phoneNumber

val phoneNumber: String? = null

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

reverseSide

val reverseSide: PassportFile? = null

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

val selfie: PassportFile? = null

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

val translation: List<PassportFile>? = null

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

val type: EncryptedPassportElementType

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".