Type Members

1.  final case class EncryptedCredentials(data: String, hash: String, secret: String) extends Product with Serializable

   Data required for decrypting and authenticating EncryptedPassportElement.

   Data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

   data

   Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication

   hash

   Base64-encoded data hash for data authentication

   secret

   Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption

2.  sealed trait EncryptedPassportElement extends Product
3.  final case class PassportData(data: List[EncryptedPassportElement], credentials: EncryptedCredentials) extends Product with Serializable

   Telegram Passport data shared with the bot by the user

   Telegram Passport data shared with the bot by the user

   data

   Documents and other Telegram Passport elements that was shared with the bot

   credentials

   Encrypted credentials required to decrypt the data

4.  sealed trait PassportElementError extends Product

   Error in the Telegram Passport element which was submitted that should be resolved by the user

5.  final case class PassportElementErrorDataField(type: String, fieldName: String, dataHash: String, message: String, source: String = "data") extends PassportElementError with Product with Serializable

   Issue in one of the data fields that was provided by the user.

   Issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

   fieldName

   Name of the data field which has the error

   dataHash

   Base64-encoded data hash

   message

   Error message

   source

   Error source, must be 'data'

6.  final case class PassportElementErrorFile(type: String, fileHash: String, message: String, source: String = "file") extends PassportElementError with Product with Serializable

   Issue with a document scan.

   Issue with a document scan. The error is considered resolved when the file with the document scan changes.

   fileHash

   Base64-encoded file hash

   message

   Error message

   source

   Error source, must be 'file'

7.  final case class PassportElementErrorFiles(type: String, fileHashes: List[String], message: String, source: String = "files") extends PassportElementError with Product with Serializable

   Issue with a list of scans.

   Issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

   fileHashes

   List of base64-encoded file hashes

   message

   Error message

   source

   Error source, must be 'files'

8.  final case class PassportElementErrorFrontSide(type: String, fileHash: String, message: String, source: String = "front_side") extends PassportElementError with Product with Serializable

   Issue with the front side of a document.

   Issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

   fileHash

   Base64-encoded hash of the file with the front side of the document

   message

   Error message

   source

   Error source, must be 'front_side'

9.  final case class PassportElementErrorReverseSide(type: String, fileHash: String, message: String, source: String = "reverse_side") extends PassportElementError with Product with Serializable

   Issue with the reverse side of a document.

   Issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

   fileHash

   Base64-encoded hash of the file with the reverse side of the document

   message

   Error message

   source

   Error source, must be 'reverse_side'

10.  final case class PassportElementErrorSelfie(type: String, fileHash: String, message: String, source: String = "selfie") extends PassportElementError with Product with Serializable

    Issue with the selfie with a document.

    Issue with the selfie with a document. The error is considered resolved when the file with the selfie

    fileHash

    Base64-encoded hash of the file with the selfie

    message

    Error message

    source

    Error source, must be 'selfie'

11.  final case class PassportElementErrorTranslationFile(type: String, fileHash: String, message: String, source: String = "translation_file") extends PassportElementError with Product with Serializable

    Issue with the translated version of a document.

    Issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

    fileHash

    Base64-encoded file hash

    message

    Error message

    source

    Error source, must be 'translation_file'

12.  final case class PassportElementErrorTranslationFiles(type: String, fileHashes: List[String], message: String, source: String = "translation_files") extends PassportElementError with Product with Serializable

    Issue with the translated version of a document.

    Issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

    fileHashes

    List of base64-encoded file hashes

    message

    Error message

    source

    Error source, must be 'translation_files'

13.  final case class PassportElementErrorUnspecified(type: String, element_hash: String, message: String, source: String = "unspecified") extends PassportElementError with Product with Serializable

    Issue in an unspecified place.

    Issue in an unspecified place. The error is considered resolved when new data is added.

    element_hash

    Base64-encoded element hash

    message

    Error message

    source

    Error source, must be 'unspecified'

14.  final case class PassportFile(fileId: String, fileUniqueId: String, fileSize: Int, fileDate: Int) extends Product with Serializable

    File uploaded to Telegram Passport.

    File uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

    fileId

    Identifier for this file

    fileUniqueId

    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.

    fileSize

    File size

    fileDate

    Unix time when the file was uploaded