GramJS

⚠️ This project is archived and no longer maintained. Development continues in teleproto, an actively maintained fork. It's largely compatible with GramJS for most projects, migration means little more than swapping the package:
npm install teleproto
See the migration guide for details.

users.SetSecureValueErrors

Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change).

Example

const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.users.SetSecureValueErrors({
      id: "username",
      errors: [
        new Api.SecureValueErrorData({
          type: new Api.SecureValueTypePersonalDetails({}),
          dataHash: Buffer.from("arbitrary data here"),
          field: "some string here",
          text: "some string here",
        }),
      ],
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.Bool = await client.invoke(
    new Api.users.SetSecureValueErrors({
      id: "username",
      errors: [
        new Api.SecureValueErrorData({
          type: new Api.SecureValueTypePersonalDetails({}),
          dataHash: Buffer.from("arbitrary data here"),
          field: "some string here",
          text: "some string here",
        }),
      ],
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
idInputUserThe user
errorsVector<SecureValueError>Errors

Result

Bool

Possible errors

CodeTypeDescription
400USER_ID_INVALIDThe provided user ID is invalid.

Can bots use this method?

Yes

Telegram Passport Manual