Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
reset-passkey-challenge
Resetar o Challenge
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/reset-passkey-challenge \
  --header 'Client-Token: <api-key>'

​
Conceituação

Em alguns dispositivos, o WhatsApp passou a exigir uma verificação adicional ao tentar conectar ao WhatsApp Web, chamada de Chave de Acesso (Passkey). Devido a isso, esses dispositivos que tentar ler o QR Code via API podem ter o retorno do Challenge.
Este método faz parte do fluxo de conexão da instância via Passkey (WebAuthn). Ele é utilizado quando o cliente deseja gerar um novo QR Code — por exemplo, para escanear com outro dispositivo. Ao chamar este endpoint, o challenge atual é resetado. Na próxima chamada ao endpoint de QR Code, um novo QR Code é gerado.
Este endpoint invalida o fluxo de passkey vigente. Após o sucesso da chamada, é necessário chamar novamente o endpoint de qr-code para obter o novo QR Code.

​
Atributos

​
Obrigatórios

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Response

​
200

Retorna o resultado do processamento da instância. Existem duas variações possíveis: Sucesso — challenge resetado: 
{ "success": true }
Falha — não foi possível reiniciar a instância: 
{ "success": false, "error": "Failed to restart instance after challenge reset" }
Em caso de sucesso, chame novamente o endpoint de qr-code para obter o novo QR Code.

​
400

Retornado nos seguintes casos:
  • Instância não encontrada para o par instanceId + token:
{ "error": "Instance not found", "value": null }

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.