telegram.PassportFile

class telegram.PassportFile(file_id: str, file_unique_id: str, file_date: int, file_size: int = None, bot: Bot = None, credentials: FileCredentials = None, **_kwargs)

Bases: telegram.base.TelegramObject

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don’t exceed 10MB.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their file_unique_id is equal.

file_id

Identifier for this file.

Type:str
file_unique_id

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

Type:str
file_size

File size.

Type:int
file_date

Unix time when the file was uploaded.

Type:int
bot

Optional. The Bot to use for instance methods.

Type:telegram.Bot
Parameters:
  • file_id (str) – Identifier for this file, which can be used to download or reuse the file.
  • file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.
  • file_size (int) – File size.
  • file_date (int) – Unix time when the file was uploaded.
  • bot (telegram.Bot, optional) – The Bot to use for instance methods.
  • **kwargs (dict) – Arbitrary keyword arguments.
get_file(timeout: int = None, api_kwargs: Dict[str, Any] = None) → File

Wrapper over telegram.Bot.get_file. Will automatically assign the correct credentials to the returned telegram.File if originating from telegram.PassportData.decrypted_data.

Parameters:
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • api_kwargs (dict, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
Returns:

telegram.File

Raises:

telegram.TelegramError