Skip to main content
GET
QRCode as image

Overview

Returns the QRCode in base64 image format, so you can display it in an image component.

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

The QR Code image may be returned in Base64, or, on devices that require the Passkey, the Challenge object to continue the authentication process.
Example response for devices that require the Passkey
In cases where this response is returned, it is necessary to complete the authentication requested via the Challenge. For this, we have the Complete the Challenge endpoint.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.