GET /api/v1/forward/qr_sessions/{session_key}
Returns the current status of a QR authorization session.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
session_key | string | Yes | Opaque QR session key returned by Create Channel QR Session. |
Example request
Example response
HTTP 200 OKStatus values
| Status | Description |
|---|---|
waiting | Waiting for scan, authorization, installation, or configuration. |
scanned | QR code was scanned and is waiting for mobile confirmation. |
confirmed | Activation succeeded. Channel binding_status becomes bound. |
expired | QR session expired. Create a new QR session. |
denied | User denied authorization or cancelled installation. |
error | The third-party channel returned an unrecoverable error. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT invalid or expired. |
| 404 | not_found_error | channel_qr_session_not_found | QR session does not exist, is expired, or is not visible to the caller. |
Notes
session_keyis a short-lived opaque polling credential.- Poll at the returned
poll_interval_secondsfrom the create response. - After
confirmed, refresh Channel details.