telegram.PassportData

class telegram.PassportData(data, credentials, bot=None, **kwargs)

Bases: telegram.base.TelegramObject

Contains information about Telegram Passport data shared with the bot by the user.

data

List[telegram.EncryptedPassportElement] – Array with encrypted information about documents and other Telegram Passport elements that was shared with the bot.

credentials

telegram.EncryptedCredentials – Encrypted credentials.

bot

telegram.Bot, optional – The Bot to use for instance methods.

Parameters:
  • data (List[telegram.EncryptedPassportElement]) – Array with encrypted information about documents and other Telegram Passport elements that was shared with the bot.
  • credentials (str) – Encrypted credentials.
  • bot (telegram.Bot, optional) – The Bot to use for instance methods.
  • **kwargs (dict) – Arbitrary keyword arguments.

Note

To be able to decrypt this object, you must pass your private_key to either telegram.Updater or telegram.Bot. Decrypted data is then found in decrypted_data and the payload can be found in decrypted_credentials’s attribute telegram.Credentials.payload.

decrypted_credentials

telegram.Credentials

Lazily decrypt and return credentials that were used
to decrypt the data. This object also contains the user specified payload as decrypted_data.payload.
Raises:telegram.TelegramDecryptionError – Decryption failed. Usually due to bad private/public key but can also suggest malformed/tampered data.
decrypted_data

List[telegram.EncryptedPassportElement] –

Lazily decrypt and return information
about documents and other Telegram Passport elements which were shared with the bot.
Raises:telegram.TelegramDecryptionError – Decryption failed. Usually due to bad private/public key but can also suggest malformed/tampered data.