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

​
Overview

Method used to confirm the code you received. To use this method, you need to complete the previous registration steps, which involve checking the number’s registration availability and requesting 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

​
code
string
required
Confirmation code

​
Request Body

{
  "code": "123456"
}

​
Response

​
200

​
success
boolean
Returns true if the code was confirmed correctly. Once done, the instance will be connected.
​
confirmSecurityCode
boolean
Returns true if two-step verification code confirmation is required.
Success: 
{
  "success": true
}
Security code confirmation required: 
{
  "success": false,
  "confirmSecurityCode": 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”.