Respond captcha
Method#
/mobile/respond-captcha#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/mobile/respond-captcha
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
Method used to respond to the captcha necessary for sending the confirmation code. This method is only necessary if the request code API responds with the "captcha" attribute, which in turn contains the base64 of the image with the captcha.
Attributes#
Required#
| Attributes | Type | Description |
|---|---|---|
| captcha | string | Captcha code for confirmation. This captcha is displayed in the image returned in the request for the confirmation code. |
Request Body#
Response#
200#
| Attributes | Type | Description |
|---|---|---|
| success | boolean | Returns true if the captcha was answered correctly. Therefore, wait for the confirmation code to be received and use it in the confirm code API |
Example#
400#
Invalid request. Check if the data you are sending is in accordance with the documentation above.
405#
In this case, make sure you are correctly sending the method specification, i.e., check if you sent the POST or GET as specified at the beginning of this topic.
415#
If you receive a 415 error, make sure to add the "Content-Type" of the object you are sending to the headers of the request, mostly "application/json"