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

​
Overview

Method used to register a security PIN code on your WhatsApp account.
This API is only available for mobile instances.

​
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
PIN code to be registered

​
Request Body

{
  "code": "123456"
}

​
Response

​
200

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