EncryptedPassportElement

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

Contains information about documents or other Telegram Passport elements shared with the bot by the user.

Parameters

data

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

phoneNumber

Optional. User's verified phone number, available only for “phone_number” type

email

Optional. User's verified email address, available only for “email” type

files

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

frontSide

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

reverseSide

Optional. Encrypted file with the reverse side of the document, provided by the user. Available 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 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.

hash

Base64-encoded element hash for using in PassportElementErrorUnspecified

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

Constructors

EncryptedPassportElement
Link copied to clipboard
common
fun EncryptedPassportElement(data: String? = null, phoneNumber: String? = null, email: String? = null, files: List<PassportFile> = emptyList(), frontSide: PassportFile? = null, reverseSide: PassportFile? = null, selfie: PassportFile? = null, translation: List<PassportFile> = emptyList(), hash: String, type: String)
Optional.

Functions

component1
Link copied to clipboard
common
operator fun component1(): String?
component10
Link copied to clipboard
common
operator fun component10(): String
component2
Link copied to clipboard
common
operator fun component2(): String?
component3
Link copied to clipboard
common
operator fun component3(): String?
component4
Link copied to clipboard
common
operator fun component4(): List<PassportFile>
component5
Link copied to clipboard
common
operator fun component5(): PassportFile?
component6
Link copied to clipboard
common
operator fun component6(): PassportFile?
component7
Link copied to clipboard
common
operator fun component7(): PassportFile?
component8
Link copied to clipboard
common
operator fun component8(): List<PassportFile>
component9
Link copied to clipboard
common
operator fun component9(): String
copy
Link copied to clipboard
common
fun copy(data: String? = null, phoneNumber: String? = null, email: String? = null, files: List<PassportFile> = emptyList(), frontSide: PassportFile? = null, reverseSide: PassportFile? = null, selfie: PassportFile? = null, translation: List<PassportFile> = emptyList(), hash: String, type: String): EncryptedPassportElement
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

data
Link copied to clipboard
common
val data: String? = null
Optional.
email
Link copied to clipboard
common
val email: String? = null
Optional.
files
Link copied to clipboard
common
val files: List<PassportFile>
Optional.
frontSide
Link copied to clipboard
common
val frontSide: PassportFile? = null
Optional.
hash
Link copied to clipboard
common
val hash: String
Base64-encoded element hash for using in PassportElementErrorUnspecified
phoneNumber
Link copied to clipboard
common
val phoneNumber: String? = null
Optional.
reverseSide
Link copied to clipboard
common
val reverseSide: PassportFile? = null
Optional.
selfie
Link copied to clipboard
common
val selfie: PassportFile? = null
Optional.
translation
Link copied to clipboard
common
val translation: List<PassportFile>
Optional.
type
Link copied to clipboard
common
val type: String
Element type.