Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
security
/
two-fa-code
Check PIN code
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/security/two-fa-code \
  --header 'Client-Token: <api-key>'
{
  "success": true,
  "hasCode": true
}

Overview

Method used to check if the account has a security PIN code registered.
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.

Response

200

success
boolean
Returns true if the execution was successful
hasCode
boolean
Whether the account has a PIN code registered
{
  "success": true,
  "hasCode": 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”.