telegram.PassportData¶
- class telegram.PassportData(data, credentials, *, api_kwargs=None)[source]¶
Bases:
telegram.TelegramObject
Contains information about Telegram Passport data shared with the bot by the user.
Note
To be able to decrypt this object, you must pass your
private_key
to eithertelegram.ext.Updater
ortelegram.Bot
. Decrypted data is then found indecrypted_data
and the payload can be found indecrypted_credentials
’s attributetelegram.Credentials.nonce
.- Parameters
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.
- data[source]¶
Array with encrypted information about documents and other Telegram Passport elements that was shared with the bot.
- Type
- property decrypted_credentials[source]¶
- 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.error.PassportDecryptionError – Decryption failed. Usually due to bad private/public key but can also suggest malformed/tampered data.
- Type
- property decrypted_data[source]¶
- Lazily decrypt and return information
about documents and other Telegram Passport elements which were shared with the bot.
- Raises
telegram.error.PassportDecryptionError – Decryption failed. Usually due to bad private/public key but can also suggest malformed/tampered data.
- Type