Skip to main content
GET
Get a QR code to connect
Returns a pairing QR for this instance. Whoever holds the phone scans it from WhatsApp → Settings → Linked devices → Link a device.

Notes

  • If the number is already connected, no QR is issued: you get already_connected: true, connected: true and qrcode: null. That is a success, not an error.
  • qrcode.base64 is a ready-to-render data:image/png;base64,... string — put it straight into an <img src="...">.
  • qrcode.code is the raw QR payload if you would rather draw the code yourself.
  • If no QR is ready yet you get 503 qr_unavailable with a Retry-After: 3 header. Wait and try again.
  • After showing the QR, poll GET /v1/instances/{id}/qr-status — it returns the refreshed QR and tells you when the scan has succeeded.

Example

cURL
Rendering it
A pairing QR links a real WhatsApp account to your instance. Show it only to the person who owns the number, and never post one in a shared channel or a screenshot.

Authorizations

apikey
string
header
required

Your API key, sent in an apikey request header. Never in the URL, never as a Bearer token.

Path Parameters

id
string<uuid>
required

The instance_id of one of your numbers.

Response

A QR to scan, or confirmation that the number is already connected.

success
boolean
data
object
request_id
string<uuid>