Hide navigation sidebar
Hide table of contents sidebar
PTB has undergone significant changes in v20. Please read the documentation carefully and also check out the transition guide in the wiki.
Back to top
Toggle table of contents sidebar

# SecureData

class telegram.SecureData(personal_details=None, passport=None, internal_passport=None, driver_license=None, identity_card=None, address=None, utility_bill=None, bank_statement=None, rental_agreement=None, passport_registration=None, temporary_registration=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  This object represents the credentials that were used to decrypt the encrypted data. All fields are optional and depend on fields that were requested.

  Parameters:

    - personal_details (`telegram.SecureValue`, optional) – Credentials for encrypted personal details.

    - passport (`telegram.SecureValue`, optional) – Credentials for encrypted passport.

    - internal_passport (`telegram.SecureValue`, optional) – Credentials for encrypted internal passport.

    - driver_license (`telegram.SecureValue`, optional) – Credentials for encrypted driver license.

    - identity_card (`telegram.SecureValue`, optional) – Credentials for encrypted ID card

    - address (`telegram.SecureValue`, optional) – Credentials for encrypted residential address.

    - utility_bill (`telegram.SecureValue`, optional) – Credentials for encrypted utility bill.

    - bank_statement (`telegram.SecureValue`, optional) – Credentials for encrypted bank statement.

    - rental_agreement (`telegram.SecureValue`, optional) – Credentials for encrypted rental agreement.

    - passport_registration (`telegram.SecureValue`, optional) – Credentials for encrypted registration from internal passport.

    - temporary_registration (`telegram.SecureValue`, optional) – Credentials for encrypted temporary registration.

  personal_details

    Optional. Credentials for encrypted personal details.

    Type:

      `telegram.SecureValue`

  passport

    Optional. Credentials for encrypted passport.

    Type:

      `telegram.SecureValue`

  internal_passport

    Optional. Credentials for encrypted internal passport.

    Type:

      `telegram.SecureValue`

  driver_license

    Optional. Credentials for encrypted driver license.

    Type:

      `telegram.SecureValue`

  identity_card

    Optional. Credentials for encrypted ID card

    Type:

      `telegram.SecureValue`

  address

    Optional. Credentials for encrypted residential address.

    Type:

      `telegram.SecureValue`

  utility_bill

    Optional. Credentials for encrypted utility bill.

    Type:

      `telegram.SecureValue`

  bank_statement

    Optional. Credentials for encrypted bank statement.

    Type:

      `telegram.SecureValue`

  rental_agreement

    Optional. Credentials for encrypted rental agreement.

    Type:

      `telegram.SecureValue`

  passport_registration

    Optional. Credentials for encrypted registration from internal passport.

    Type:

      `telegram.SecureValue`

  temporary_registration

    Optional. Credentials for encrypted temporary registration.

    Type:

      `telegram.SecureValue`

  Available In

  `telegram.Credentials.secure_data`

  classmethod de_json(data, bot)

    See `telegram.TelegramObject.de_json()`.