Skip to main content
GET
/
api
/
{session}
/
auth
/
qr?server_id=1
Get QR code for WhatsApp API pairing.
curl --request GET \
  --url 'https://{host}/api/{session}/auth/qr?server_id=1' \
  --header 'apikey: <api-key>'
{
    "value": "2@At0KZLwyMrvGXeKc5AWN6..."
}

​
Description

This endpoint returns the QR Code needed to authenticate a new session of WhatsApp. The QR Code must be scanned by the WhatsApp app on the user’s phone to establish the connection.

​
URL Parameters

​
session
string
required
Unique ID of the session to be authenticated

​
Response

​
value
string
required
Encoded string of the QR Code for authentication. This value must be converted to an image QR Code for display to the user.
{
    "value": "2@At0KZLwyMrvGXeKc5AWN6..."
}

​
Status Codes

  • 200 - QR Code generated successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/auth/qr

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

The session name (instanceName) you want to authenticate

Response

The response is of type file.