Skip to content
Download Beeper

List active verifications

client.App.Setup.Verifications.List(ctx) (*AppSetupVerificationListResponse, error)
GET/v1/app/setup/verifications

List pending and active device verifications. Use this to recover state without a WebSocket connection.

ReturnsExpand Collapse
type AppSetupVerificationListResponse struct{…}
Items []AppSetupVerificationListResponseItem
ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:
const AppSetupVerificationListResponseItemAvailableActionAccept AppSetupVerificationListResponseItemAvailableAction = "accept"
const AppSetupVerificationListResponseItemAvailableActionCancel AppSetupVerificationListResponseItemAvailableAction = "cancel"
const AppSetupVerificationListResponseItemAvailableActionQRConfirmScanned AppSetupVerificationListResponseItemAvailableAction = "qr.confirmScanned"
const AppSetupVerificationListResponseItemAvailableActionSASStart AppSetupVerificationListResponseItemAvailableAction = "sas.start"
const AppSetupVerificationListResponseItemAvailableActionSASConfirm AppSetupVerificationListResponseItemAvailableAction = "sas.confirm"
Direction string

Whether this device started or received the verification.

One of the following:
const AppSetupVerificationListResponseItemDirectionIncoming AppSetupVerificationListResponseItemDirection = "incoming"
const AppSetupVerificationListResponseItemDirectionOutgoing AppSetupVerificationListResponseItemDirection = "outgoing"
Methods []string

Verification methods supported for this transaction.

One of the following:
const AppSetupVerificationListResponseItemMethodQR AppSetupVerificationListResponseItemMethod = "qr"
const AppSetupVerificationListResponseItemMethodSAS AppSetupVerificationListResponseItemMethod = "sas"
Purpose string

Why this verification exists.

One of the following:
const AppSetupVerificationListResponseItemPurposeLogin AppSetupVerificationListResponseItemPurpose = "login"
const AppSetupVerificationListResponseItemPurposeDevice AppSetupVerificationListResponseItemPurpose = "device"
State string

Current trusted-device verification state.

One of the following:
const AppSetupVerificationListResponseItemStateRequested AppSetupVerificationListResponseItemState = "requested"
const AppSetupVerificationListResponseItemStateReady AppSetupVerificationListResponseItemState = "ready"
const AppSetupVerificationListResponseItemStateSASReady AppSetupVerificationListResponseItemState = "sas_ready"
const AppSetupVerificationListResponseItemStateQRScanned AppSetupVerificationListResponseItemState = "qr_scanned"
const AppSetupVerificationListResponseItemStateDone AppSetupVerificationListResponseItemState = "done"
const AppSetupVerificationListResponseItemStateCancelled AppSetupVerificationListResponseItemState = "cancelled"
const AppSetupVerificationListResponseItemStateError AppSetupVerificationListResponseItemState = "error"
Error AppSetupVerificationListResponseItemErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice AppSetupVerificationListResponseItemOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR AppSetupVerificationListResponseItemQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS AppSetupVerificationListResponseItemSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

List active verifications

package main

import (
  "context"
  "fmt"

  "github.com/beeper/desktop-api-go"
  "github.com/beeper/desktop-api-go/option"
)

func main() {
  client := beeperdesktopapi.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  verifications, err := client.App.Setup.Verifications.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", verifications.Items)
}
{
  "items": [
    {
      "id": "id",
      "availableActions": [
        "accept"
      ],
      "direction": "incoming",
      "methods": [
        "qr"
      ],
      "purpose": "login",
      "state": "requested",
      "error": {
        "code": "code",
        "reason": "reason"
      },
      "otherDevice": {
        "id": "id",
        "name": "name"
      },
      "otherUserID": "otherUserID",
      "qr": {
        "data": "data"
      },
      "sas": {
        "emojis": "emojis",
        "decimals": "decimals"
      }
    }
  ]
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "availableActions": [
        "accept"
      ],
      "direction": "incoming",
      "methods": [
        "qr"
      ],
      "purpose": "login",
      "state": "requested",
      "error": {
        "code": "code",
        "reason": "reason"
      },
      "otherDevice": {
        "id": "id",
        "name": "name"
      },
      "otherUserID": "otherUserID",
      "qr": {
        "data": "data"
      },
      "sas": {
        "emojis": "emojis",
        "decimals": "decimals"
      }
    }
  ]
}