Telegram Bot Api Base
Back to top  

Class EncryptedPassportElementType.

see
package Default

 Properties

 

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.

$data : string | null

Default

Can be decrypted and verified using the accompanying EncryptedCredentials.

 

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

$email : string | null

Default

 

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 : array<mixed,\TgBotApi\BotApiBase\Type\PassportFileType> | null

Default

Files can be decrypted and verified using the accompanying EncryptedCredentials.

 

Optional. Encrypted file with the front side of the document, provided by the user.

$frontSide : \TgBotApi\BotApiBase\Type\PassportFileType | null

Default

Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

 

Base64-encoded element hash for using in PassportElementErrorUnspecified.

$hash : string | null

Default

 

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

$phoneNumber : string | null

Default

 

Optional. Encrypted file with the reverse side of the document, provided by the user.

$reverseSide : \TgBotApi\BotApiBase\Type\PassportFileType | null

Default

Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

 

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

$selfie : \TgBotApi\BotApiBase\Type\PassportFileType | null

Default

The file can be decrypted and verified using the accompanying EncryptedCredentials.

 

Optional. Array of encrypted files with translated versions of documents provided by the user.

$translation : array<mixed,\TgBotApi\BotApiBase\Type\PassportFileType> | null

Default

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.

 

Element type.

$type : string

Default

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