account.AuthorizationForm

class pyrogram.raw.types.account.AuthorizationForm

Telegram Passport authorization form

Constructor of AuthorizationForm.

Details:
  • Layer: 227

  • ID: AD2E1CD8

Parameters:
  • required_types (List of SecureRequiredType) – Required Telegram Passport documents

  • values (List of SecureValue) – Already submitted Telegram Passport documents

  • errors (List of SecureValueError) – Telegram Passport errors

  • users (List of User) – Info about the bot to which the form will be submitted

  • privacy_policy_url (str, optional) – URL of the service’s privacy policy

Functions:

This object can be returned by 1 function.

account.GetAuthorizationForm

Returns a Telegram Passport authorization form for sharing data with a service

TL Schema

account.authorizationForm#ad2e1cd8
flags:#
required_types:Vector<SecureRequiredType>
values:Vector<SecureValue>
errors:Vector<SecureValueError>
users:Vector<User>
privacy_policy_url:flags.0?string

= account.AuthorizationForm

Parameter Tree

AuthorizationForm
├── required_types → Vector < SecureRequiredType >
│ ├── SecureRequiredType
│ │ ├── native_names → true (optional)
│ │ ├── selfie_required → true (optional)
│ │ ├── translation_required → true (optional)
│ │ └── type → SecureValueType
│ │ ├── SecureValueTypePassport
│ │ ├── SecureValueTypeIdentityCard
│ │ ├── SecureValueTypeAddress
│ │ ├── SecureValueTypeUtilityBill
│ │ ├── SecureValueTypePhone
│ │ └── SecureValueTypeEmail
│ └── types → Vector < SecureRequiredType >
│ ├── SecureRequiredType
│ │ ├── native_names → true (optional)
│ │ ├── selfie_required → true (optional)
│ │ ├── translation_required → true (optional)
│ │ └── type → SecureValueType
│ │ ├── SecureValueTypePassport
│ │ ├── SecureValueTypeIdentityCard
│ │ ├── SecureValueTypeAddress
│ │ ├── SecureValueTypeUtilityBill
│ │ ├── SecureValueTypePhone
│ │ └── SecureValueTypeEmail
│ └── types → Vector < SecureRequiredType >
│ ├── SecureRequiredType
├── values → Vector < SecureValue >
│ └── SecureValue
│ ├── type → SecureValueType
│ │ ├── SecureValueTypePassport
│ │ ├── SecureValueTypeIdentityCard
│ │ ├── SecureValueTypeAddress
│ │ ├── SecureValueTypeUtilityBill
│ │ ├── SecureValueTypePhone
│ │ └── SecureValueTypeEmail
│ ├── data → SecureData (optional)
│ │ └── SecureData
│ │ ├── data → bytes
│ │ ├── data_hash → bytes
│ │ └── secret → bytes
│ ├── front_side → SecureFile (optional)
│ │ ├── SecureFileEmpty
│ │ └── SecureFile
│ │ ├── id → long
│ │ ├── access_hash → long
│ │ ├── size → long
│ │ ├── dc_id → int
│ │ ├── date → int
│ │ ├── file_hash → bytes
│ │ └── secret → bytes
│ ├── reverse_side → SecureFile (optional)
│ │ ├── SecureFileEmpty
│ │ └── SecureFile
│ │ ├── id → long
│ │ ├── access_hash → long
│ │ ├── size → long
│ │ ├── dc_id → int
│ │ ├── date → int
│ │ ├── file_hash → bytes
│ │ └── secret → bytes
│ ├── selfie → SecureFile (optional)
│ │ ├── SecureFileEmpty
│ │ └── SecureFile
│ │ ├── id → long
│ │ ├── access_hash → long
│ │ ├── size → long
│ │ ├── dc_id → int
│ │ ├── date → int
│ │ ├── file_hash → bytes
│ │ └── secret → bytes
│ ├── translation → Vector < SecureFile > (optional)
│ │ ├── SecureFileEmpty
│ │ └── SecureFile
│ │ ├── id → long
│ │ ├── access_hash → long
│ │ ├── size → long
│ │ ├── dc_id → int
│ │ ├── date → int
│ │ ├── file_hash → bytes
│ │ └── secret → bytes
│ ├── files → Vector < SecureFile > (optional)
│ │ ├── SecureFileEmpty
│ │ └── SecureFile
│ │ ├── id → long
│ │ ├── access_hash → long
│ │ ├── size → long
│ │ ├── dc_id → int
│ │ ├── date → int
│ │ ├── file_hash → bytes
│ │ └── secret → bytes
│ ├── plain_data → SecurePlainData (optional)
│ │ ├── SecurePlainPhone
│ │ │ └── phone → string
│ │ └── SecurePlainEmail
│ │ └── email → string
│ └── hash → bytes
├── errors → Vector < SecureValueError >
│ ├── SecureValueErrorData
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── data_hash → bytes
│ │ ├── field → string
│ │ └── text → string
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── file_hash → bytes
│ │ └── text → string
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── file_hash → bytes
│ │ └── text → string
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── file_hash → bytes
│ │ └── text → string
│ ├── SecureValueErrorFile
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── file_hash → bytes
│ │ └── text → string
│ ├── SecureValueErrorFiles
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── file_hash → Vector < bytes >
│ │ └── text → string
│ ├── SecureValueError
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── hash → bytes
│ │ └── text → string
│ │ ├── type → SecureValueType
│ │ │ ├── SecureValueTypePersonalDetails
│ │ │ ├── SecureValueTypePassport
│ │ │ ├── SecureValueTypeDriverLicense
│ │ │ ├── SecureValueTypeIdentityCard
│ │ │ ├── SecureValueTypeInternalPassport
│ │ │ ├── SecureValueTypeAddress
│ │ │ ├── SecureValueTypeUtilityBill
│ │ │ ├── SecureValueTypeBankStatement
│ │ │ ├── SecureValueTypeRentalAgreement
│ │ │ ├── SecureValueTypePhone
│ │ │ └── SecureValueTypeEmail
│ │ ├── file_hash → bytes
│ │ └── text → string
│ ├── type → SecureValueType
│ │ ├── SecureValueTypePassport
│ │ ├── SecureValueTypeIdentityCard
│ │ ├── SecureValueTypeAddress
│ │ ├── SecureValueTypeUtilityBill
│ │ ├── SecureValueTypePhone
│ │ └── SecureValueTypeEmail
│ ├── file_hash → Vector < bytes >
│ └── text → string
├── users → Vector < User >
│ ├── UserEmpty
│ │ └── id → long
│ └── User
│ ├── is_self → true (optional)
│ ├── contact → true (optional)
│ ├── mutual_contact → true (optional)
│ ├── deleted → true (optional)
│ ├── bot → true (optional)
│ ├── bot_chat_history → true (optional)
│ ├── bot_nochats → true (optional)
│ ├── verified → true (optional)
│ ├── restricted → true (optional)
│ ├── min → true (optional)
│ ├── bot_inline_geo → true (optional)
│ ├── support → true (optional)
│ ├── scam → true (optional)
│ ├── apply_min_photo → true (optional)
│ ├── fake → true (optional)
│ ├── bot_attach_menu → true (optional)
│ ├── premium → true (optional)
│ ├── attach_menu_enabled → true (optional)
│ ├── bot_can_edit → true (optional)
│ ├── close_friend → true (optional)
│ ├── stories_hidden → true (optional)
│ ├── stories_unavailable → true (optional)
│ ├── contact_require_premium → true (optional)
│ ├── bot_business → true (optional)
│ ├── bot_has_main_app → true (optional)
│ ├── bot_forum_view → true (optional)
│ ├── bot_forum_can_manage_topics → true (optional)
│ ├── bot_can_manage_bots → true (optional)
│ ├── bot_guestchat → true (optional)
│ ├── bot_guard → true (optional)
│ ├── id → long
│ ├── access_hash → long (optional)
│ ├── first_name → string (optional)
│ ├── last_name → string (optional)
│ ├── username → string (optional)
│ ├── phone → string (optional)
│ ├── photo → UserProfilePhoto (optional)
│ │ ├── UserProfilePhotoEmpty
│ │ └── UserProfilePhoto
│ │ ├── has_video → true (optional)
│ │ ├── personal → true (optional)
│ │ ├── photo_id → long
│ │ ├── stripped_thumb → bytes (optional)
│ │ └── dc_id → int
│ ├── status → UserStatus (optional)
│ │ ├── UserStatusEmpty
│ │ ├── UserStatusOnline
│ │ │ └── expires → int
│ │ ├── UserStatusOffline
│ │ │ └── was_online → int
│ │ ├── UserStatusRecently
│ │ │ └── by_me → true (optional)
│ │ ├── UserStatusLastWeek
│ │ │ └── by_me → true (optional)
│ │ └── UserStatusLastMonth
│ │ └── by_me → true (optional)
│ ├── bot_info_version → int (optional)
│ ├── restriction_reason → Vector < RestrictionReason > (optional)
│ │ └── RestrictionReason
│ │ ├── platform → string
│ │ ├── reason → string
│ │ └── text → string
│ ├── bot_inline_placeholder → string (optional)
│ ├── lang_code → string (optional)
│ ├── emoji_status → EmojiStatus (optional)
│ │ ├── EmojiStatusEmpty
│ │ ├── EmojiStatus
│ │ │ ├── document_id → long
│ │ │ └── until → int (optional)
│ │ ├── EmojiStatusCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── document_id → long
│ │ │ ├── title → string
│ │ │ ├── slug → string
│ │ │ ├── pattern_document_id → long
│ │ │ ├── center_color → int
│ │ │ ├── edge_color → int
│ │ │ ├── pattern_color → int
│ │ │ ├── text_color → int
│ │ │ └── until → int (optional)
│ │ └── InputEmojiStatusCollectible
│ │ ├── collectible_id → long
│ │ └── until → int (optional)
│ ├── usernames → Vector < Username > (optional)
│ │ └── Username
│ │ ├── editable → true (optional)
│ │ ├── active → true (optional)
│ │ └── username → string
│ ├── stories_max_id → RecentStory (optional)
│ │ └── RecentStory
│ │ ├── live → true (optional)
│ │ └── max_id → int (optional)
│ ├── color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── profile_color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── bot_active_users → int (optional)
│ ├── bot_verification_icon → long (optional)
│ └── send_paid_messages_stars → long (optional)
└── privacy_policy_url → string (optional)

Example

AuthorizationForm(
    required_types=[
            SecureRequiredType(type=SecureValueTypePersonalDetails())
        ],
    values=[
            SecureValue(
                type=SecureValueTypePersonalDetails(),
                hash=b"data"
            )
        ],
    errors=[
            SecureValueErrorData(
                type=SecureValueTypePersonalDetails(),
                data_hash=b"data",
                field="text",
                text="Open"
            )
        ],
    users=[
            UserEmpty(id=0)
        ],
)