GramIO API Reference / gramio/dist / TelegramEncryptedPassportElement
Interface: TelegramEncryptedPassportElement
Defined in: @gramio/types/out/objects.d.ts:8362
Describes documents or other Telegram Passport elements shared with the bot by the user.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
data? | string | 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. | @gramio/types/out/objects.d.ts:8370 |
email? | string | Optional. User's verified email address; available only for “email” type | @gramio/types/out/objects.d.ts:8378 |
files? | TelegramPassportFile[] | 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. | @gramio/types/out/objects.d.ts:8382 |
front_side? | TelegramPassportFile | 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. | @gramio/types/out/objects.d.ts:8386 |
hash | string | Base64-encoded element hash for using in PassportElementErrorUnspecified | @gramio/types/out/objects.d.ts:8402 |
phone_number? | string | Optional. User's verified phone number; available only for “phone_number” type | @gramio/types/out/objects.d.ts:8374 |
reverse_side? | TelegramPassportFile | 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. | @gramio/types/out/objects.d.ts:8390 |
selfie? | TelegramPassportFile | 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. | @gramio/types/out/objects.d.ts:8394 |
translation? | TelegramPassportFile[] | 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. | @gramio/types/out/objects.d.ts:8398 |
type | TelegramEncryptedPassportElementType | 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”. | @gramio/types/out/objects.d.ts:8366 |