Skip to content

PassportMethods

module Tourmaline::Client::PassportMethods #

Included modules#

Tourmaline::Logger

Direct including types#

Tourmaline::Client

Constants#

Log = ::Log.for("tourmaline.client.passport_methods") #

Methods#

#set_passport_data_errors(user_id : Int32, errors : Array(PassportElementError)) #

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change).

Returns True on success.

Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.