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

Overview

Method used to confirm your account’s PIN code. This method is only required if you have set up two-step verification on WhatsApp.
Without this confirmation, the number cannot be connected to a mobile instance.

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
Two-step verification PIN code

Request Body

{
  "code": "123456"
}

Response

200

success
boolean
Returns true if the PIN code was confirmed correctly
{
  "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”.