Get a QR code to connect
Instances
Get a QR code
GET /v1/instances//qr — a fresh pairing QR for a number.
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: trueandqrcode: null. That is a success, not an error. qrcode.base64is a ready-to-renderdata:image/png;base64,...string — put it straight into an<img src="...">.qrcode.codeis the raw QR payload if you would rather draw the code yourself.- If no QR is ready yet you get
503 qr_unavailablewith aRetry-After: 3header. 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
Authorizations
Your API key, sent in an apikey request header. Never in the URL, never as a Bearer token.
Path Parameters
The instance_id of one of your numbers.

