Get QR Image
Returns a base64-encoded PNG image of the WhatsApp QR code for easy rendering in web and mobile applications.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Embed directly in your frontend without saving to disk for better security.
Refresh the image every 30 seconds to avoid showing expired codes.
Do not cache this response; always fetch a fresh image.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Request Body
Sent as a JSON objectstring | The 12-character ID of the instance Example: | ||
string | Your API Access Token Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"qr": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA..."
}Command Palette
Search for a command to run...