API Reference

App

Verifications

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List active verifications

client.App.Verifications.List(ctx) (*AppVerificationListResponse, error)

GET/v1/app/setup/verifications

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

ReturnsExpand Collapse

type AppVerificationListResponse struct{…}

Items []AppVerificationListResponseItem

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 AppVerificationListResponseItemAvailableActionAccept AppVerificationListResponseItemAvailableAction = "accept"

const AppVerificationListResponseItemAvailableActionCancel AppVerificationListResponseItemAvailableAction = "cancel"

const AppVerificationListResponseItemAvailableActionQrConfirmScanned AppVerificationListResponseItemAvailableAction = "qr.confirmScanned"

const AppVerificationListResponseItemAvailableActionSASStart AppVerificationListResponseItemAvailableAction = "sas.start"

const AppVerificationListResponseItemAvailableActionSASConfirm AppVerificationListResponseItemAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const AppVerificationListResponseItemDirectionIncoming AppVerificationListResponseItemDirection = "incoming"

const AppVerificationListResponseItemDirectionOutgoing AppVerificationListResponseItemDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const AppVerificationListResponseItemMethodQr AppVerificationListResponseItemMethod = "qr"

const AppVerificationListResponseItemMethodSAS AppVerificationListResponseItemMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const AppVerificationListResponseItemPurposeLogin AppVerificationListResponseItemPurpose = "login"

const AppVerificationListResponseItemPurposeDevice AppVerificationListResponseItemPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const AppVerificationListResponseItemStateRequested AppVerificationListResponseItemState = "requested"

const AppVerificationListResponseItemStateReady AppVerificationListResponseItemState = "ready"

const AppVerificationListResponseItemStateSASReady AppVerificationListResponseItemState = "sas_ready"

const AppVerificationListResponseItemStateQrScanned AppVerificationListResponseItemState = "qr_scanned"

const AppVerificationListResponseItemStateDone AppVerificationListResponseItemState = "done"

const AppVerificationListResponseItemStateCancelled AppVerificationListResponseItemState = "cancelled"

const AppVerificationListResponseItemStateError AppVerificationListResponseItemState = "error"

Error AppVerificationListResponseItemErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice AppVerificationListResponseItemOtherDeviceOptional

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 AppVerificationListResponseItemQrOptional

QR verification data.

Data string

QR code payload to display for verification.

SAS AppVerificationListResponseItemSASOptional

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

Go

HTTP

TypeScript

Python

Go

CLI Tool

PHP

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.Verifications.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", verifications.Items)
}

200 example

{
  "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

200 example

{
  "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"
      }
    }
  ]
}