Class EncryptedPassportElement

Contains information about documents or other Telegram Passport elements shared with the bot by the user.

Inheritance

System.Object

EncryptedPassportElement

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TelegramBotApi.Types.TelegramPassport

Assembly: TelegramBotApi.dll

Syntax

[JsonObject(MemberSerialization = MemberSerialization.OptIn, ItemNullValueHandling = NullValueHandling.Ignore)]
public class EncryptedPassportElement

Properties

| Improve this Doc View Source

Data

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “identity_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

Declaration

[JsonProperty(PropertyName = "data")]
public string Data { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Email

Optional. User's verified email address, available only for “email” type

Declaration

[JsonProperty(PropertyName = "email")]
public string Email { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Files

Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

Declaration

[JsonProperty(PropertyName = "files")]
public PassportFile[] Files { get; set; }

Property Value

Type	Description
PassportFile[]

| Improve this Doc View Source

FrontSide

Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

Declaration

[JsonProperty(PropertyName = "front_side")]
public PassportFile FrontSide { get; set; }

Property Value

Type	Description
PassportFile

| Improve this Doc View Source

Hash

Base64-encoded element hash for using in PassportElementErrorUnspecified

Declaration

[JsonProperty(PropertyName = "hash")]
public string Hash { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PhoneNumber

Optional. User's verified phone number, available only for “phone_number” type

Declaration

[JsonProperty(PropertyName = "phone_number")]
public string PhoneNumber { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ReverseSide

Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

Declaration

[JsonProperty(PropertyName = "reverse_side")]
public PassportFile ReverseSide { get; set; }

Property Value

Type	Description
PassportFile

| Improve this Doc View Source

Selfie

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

Declaration

[JsonProperty(PropertyName = "selfie")]
public PassportFile Selfie { get; set; }

Property Value

Type	Description
PassportFile

| Improve this Doc View Source

Translation

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.

Declaration

[JsonProperty(PropertyName = "translation")]
public PassportFile[] Translation { get; set; }

Property Value

Type	Description
PassportFile[]

| Improve this Doc View Source

Type

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

Declaration

public EncryptedPassportElementType Type { get; set; }

Property Value

Type	Description
EncryptedPassportElementType