Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
respond-captcha
Respond captcha
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/mobile/respond-captcha \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "captcha": "<string>"
}
'
{
  "success": true
}

​
Overview

Method used to respond to the captcha required for sending the confirmation code.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Body

​
captcha
string
required
Captcha code for confirmation. This captcha is displayed in the image returned when requesting the confirmation code.

​
Request Body

{
  "captcha": "123456"
}

​
Response

​
200

​
success
boolean
Returns true if the captcha was answered correctly. If so, wait to receive the confirmation code and use it in the confirm code API.
{
  "success": true
}

​
400

Invalid request. Check if the data you are sending matches the documentation.

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent 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” header to your request, which in most cases is “application/json”.