Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
confirm-registration-code
Confirmar código
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
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método utilizado para confirmar o código que você recebeu. Para utilizar esse método, você precisa concluir as etapas de registro anteriores, que envolvem verificar a disponibilidade de registro do número e solicitar o código de confirmação.

​
Atributos

​
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.

​
Body

​
code
string
obrigatório
Código de confirmação

​
Request Body

{
  "code": "123456"
}

​
Response

​
200

​
success
boolean
Retorna true caso o código tenha sido confirmado corretamente. Feito isso, a instância estará conectada.
​
confirmSecurityCode
boolean
Retorna true se for necessário a confirmação do código de verificação em duas etapas.
​
deviceConfirm
boolean
Retorna true se for necessário confirmar a transferência do WhatsApp no celular onde ele está registrado. Enquanto a confirmação não for feita no aparelho, a conexão não será transferida para a instância.
Sucesso: 
{
  "success": true
}
Necessário confirmar código de segurança: 
{
  "success": false,
  "confirmSecurityCode": true
}
Necessário confirmar transferência no celular: 
{
  "success": false,
  "deviceConfirm": true
}

​
400

Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado.

​
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”.