Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 3.66 KB

EncryptedPassportElement.md

File metadata and controls

36 lines (30 loc) · 3.66 KB
Raw

TelegramBotOpenapi::EncryptedPassportElement

Properties

Name Type Description Notes
type String Element type. One of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email".
data String Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials. [optional]
phone_number String Optional. User's verified phone number; available only for "phone_number" type [optional]
email String Optional. User's verified email address; available only for "email" type [optional]
files Array<PassportFile> Optional. Array of encrypted files with documents provided by the user; available only for &quot;utility_bill&quot;, &quot;bank_statement&quot;, &quot;rental_agreement&quot;, &quot;passport_registration&quot; and &quot;temporary_registration&quot; types. Files can be decrypted and verified using the accompanying EncryptedCredentials. [optional]
front_side PassportFile Optional. Encrypted file with the front side of the document, provided by the user; available only for &quot;passport&quot;, &quot;driver_license&quot;, &quot;identity_card&quot; and &quot;internal_passport&quot;. The file can be decrypted and verified using the accompanying EncryptedCredentials. [optional]
reverse_side PassportFile Optional. Encrypted file with the reverse side of the document, provided by the user; available only for &quot;driver_license&quot; and &quot;identity_card&quot;. The file can be decrypted and verified using the accompanying EncryptedCredentials. [optional]
selfie PassportFile Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for &quot;passport&quot;, &quot;driver_license&quot;, &quot;identity_card&quot; and &quot;internal_passport&quot;. The file can be decrypted and verified using the accompanying EncryptedCredentials. [optional]
translation Array<PassportFile> Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for &quot;passport&quot;, &quot;driver_license&quot;, &quot;identity_card&quot;, &quot;internal_passport&quot;, &quot;utility_bill&quot;, &quot;bank_statement&quot;, &quot;rental_agreement&quot;, &quot;passport_registration&quot; and &quot;temporary_registration&quot; types. Files can be decrypted and verified using the accompanying EncryptedCredentials. [optional]
hash String Base64-encoded element hash for using in PassportElementErrorUnspecified

Example

require 'telegram-bot-openapi'

instance = TelegramBotOpenapi::EncryptedPassportElement.new(
  type: null,
  data: null,
  phone_number: null,
  email: null,
  files: null,
  front_side: null,
  reverse_side: null,
  selfie: null,
  translation: null,
  hash: null
)