Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
device-transfer-confirmed
Confirm device transfer
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/mobile/device-transfer-confirmed \
  --header 'Client-Token: <api-key>'
{
  "success": 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.

​
Overview

Method used to finalize the WhatsApp transfer from the phone to the instance. It should be used after the Confirm code endpoint returns deviceConfirm: true in the response.
Confirm the transfer on the device before making the request.When receiving deviceConfirm: true, WhatsApp will display a notification on the phone where it is registered asking to confirm the transfer. Only after accepting this confirmation on the device should you call this endpoint. Otherwise, the connection will not be transferred to the instance.

​
Expected flow

  1. The Confirm code endpoint returns "deviceConfirm": true
  2. The user confirms the transfer on the phone where WhatsApp is registered
  3. After confirming on the device, call this endpoint
  4. The WhatsApp connection is transferred from the phone to the instance

​
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 transfer has been successfully confirmed and the instance is connected.
{
  "success": true
}

​
400

Invalid request. Check that the confirmation on the device was completed before calling this endpoint.

​
405

In this case, make sure you are correctly sending the method specification, i.e. 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” of the object you are sending in the request headers, in most cases “application/json”.