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,
  "deviceConfirm": 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 has been confirmed correctly. Once done, the instance will be connected.
​
confirmSecurityCode
boolean
Returns true if two-step verification code confirmation is required.
​
deviceConfirm
boolean
Returns true if it is necessary to confirm the WhatsApp transfer on the phone where it is registered. Until the confirmation is made on the device, the connection will not be transferred to the instance.
Success: 
{
  "success": true
}
Security code confirmation required: 
{
  "success": false,
  "confirmSecurityCode": true
}
Device transfer confirmation required: 
{
  "success": false,
  "deviceConfirm": true
}

​
400

Invalid request. Check that the data you are sending is in accordance with the documentation.

​
405

In this case, make sure you are correctly sending the method specification, i.e. 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” of the object you are sending in the request headers, in most cases “application/json”.