MadelineProtoDocs/old_docs/API_docs_v91/methods/users.setSecureValueErrors.md

57 lines
2.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
title: users.setSecureValueErrors
2019-12-27 17:48:04 +01:00
description: Notify the user that the sent [passport](https://core.telegram.org/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).
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.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
# Method: users.setSecureValueErrors
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Notify the user that the sent [passport](https://core.telegram.org/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).
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.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional|
2019-06-24 15:45:02 +02:00
|errors|Array of [SecureValueError](../types/SecureValueError.md) | The errors | Yes|
2018-04-01 13:19:25 +02:00
2019-06-24 15:45:02 +02:00
### Return type: [Bool](../types/Bool.md)
2018-04-01 13:19:25 +02:00
2019-06-24 15:45:02 +02:00
### Can bots use this method: **YES**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2019-06-24 15:45:02 +02:00
$Bool = $MadelineProto->users->setSecureValueErrors(['id' => InputUser, 'errors' => [SecureValueError, SecureValueError], ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-06-24 15:45:02 +02:00
Bool = users.setSecureValueErrors({id=InputUser, errors={SecureValueError}, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2019-08-15 20:25:16 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|USER_ID_INVALID|The provided user ID is invalid|
2019-08-15 20:25:16 +02:00