EncryptedPassportElement

Official docs ↗

Describes documents or other Telegram Passport elements shared with the bot by the user.

Fields

typeStringRequired

Values:personal_detailspassportdriver_licenseidentity_cardinternal_passportaddressutility_billbank_statementrental_agreementpassport_registrationtemporary_registrationphone_numberemail

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".

dataStringOptional

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.

phone_numberStringOptional

Optional. User's verified phone number; available only for "phone\_number" type

emailStringOptional

Optional. User's verified email address; available only for "email" type

filesPassportFile[]Optional

Optional. Array of encrypted files with documents provided by the user; available only for "utility\bill", "bank\statement", "rental\agreement", "passport\registration" and "temporary\_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

front_sidePassportFileOptional

Optional. Encrypted file with the front side of the document, provided by the user; available only for "passport", "driver\license", "identity\card" and "internal\_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.

reverse_sidePassportFileOptional

Optional. Encrypted file with the reverse side of the document, provided by the user; available only for "driver\license" and "identity\card". The file can be decrypted and verified using the accompanying EncryptedCredentials.

selfiePassportFileOptional

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for "passport", "driver\license", "identity\card" and "internal\_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.

translationPassportFile[]Optional

Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for "passport", "driver\license", "identity\card", "internal\passport", "utility\bill", "bank\statement", "rental\agreement", "passport\registration" and "temporary\registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

hashStringRequired

Base64-encoded element hash for using in PassportElementErrorUnspecified

GramIO Usage

See Also