botapi

Informs a user that some of the Telegram Passport elements they provided contains errors

POST /setPassportDataErrors

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.

Body Required

  • user_id integer Required

    User identifier

  • errors array[object] Required

    Any of:
    PassportElementErrorDataField array[object] PassportElementErrorFrontSide array[object] PassportElementErrorReverseSide array[object] PassportElementErrorSelfie array[object] PassportElementErrorFile array[object] PassportElementErrorFiles array[object] PassportElementErrorTranslationFile array[object] PassportElementErrorTranslationFiles array[object] PassportElementErrorUnspecified array[object]

Responses

  • default
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is false.

    • error_code integer Required
    • description string Required
    • parameters object

      Contains information about why a request was unsuccessful.

      Hide parameters attributes Show parameters attributes object
      • migrate_to_chat_id integer

        Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

      • retry_after integer

        Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
  • 200
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is true.

    • result boolean Required

      Default value is true.
POST /setPassportDataErrors 
curl \
 -X POST https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/setPassportDataErrors \
 -H "Content-Type: application/json" \
 -d '{"user_id":42,"errors":[{"source":"string","type":"personal_details","field_name":"string","data_hash":"string","message":"string"}]}'
Request example 
{
  "user_id": 42,
  "errors": [
    {
      "source": "string",
      "type": "personal_details",
      "field_name": "string",
      "data_hash": "string",
      "message": "string"
    }
  ]
}
Request examples 
{
  "user_id": 42,
  "errors": [
    {
      "source": "string",
      "type": "personal_details",
      "field_name": "string",
      "data_hash": "string",
      "message": "string"
    }
  ]
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (200) 
{
  "ok": true,
  "result": true
}
Response examples (200) 
{
  "ok": true,
  "result": true
}