Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy/types.web.ts>EncryptedPassportElement

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
interface EncryptedPassportElement
import { type EncryptedPassportElement } from "https://deno.land/x/grammy@v1.32.0/types.web.ts";

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

Properties

type:
| "personal_details"
| "passport"
| "driver_license"
| "identity_card"
| "internal_passport"
| "address"
| "utility_bill"
| "bank_statement"
| "rental_agreement"
| "passport_registration"
| "temporary_registration"
| "phone_number"
| "email"

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

optional
data: string

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.

optional
phone_number: string

User's verified phone number; available only for “phone_number” type

optional
email: string

User's verified email address; available only for “email” type

optional
files: PassportFile[]

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.

optional
front_side: PassportFile

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.

optional
reverse_side: PassportFile

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.

optional
selfie: PassportFile

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.

optional
translation: PassportFile[]

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: string

Base64-encoded element hash for using in PassportElementErrorUnspecified