Skip to content
Beeper Developer Docs
Download Beeper
API Reference
App
Verifications

List active verifications

GET/v1/app/setup/verifications

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

ReturnsExpand Collapse
items: array of object { id, availableActions, direction, 8 more }
id: string

Verification ID to pass in verification action paths.

availableActions: array of "accept" or "cancel" or "qr.confirmScanned" or 2 more

Verification actions that are valid for the current state.

One of the following:
"accept"
"cancel"
"qr.confirmScanned"
"sas.start"
"sas.confirm"
direction: "incoming" or "outgoing"

Whether this device started or received the verification.

One of the following:
"incoming"
"outgoing"
methods: array of "qr" or "sas"

Verification methods supported for this transaction.

One of the following:
"qr"
"sas"
purpose: "login" or "device"

Why this verification exists.

One of the following:
"login"
"device"
state: "requested" or "ready" or "sas_ready" or 4 more

Current trusted-device verification state.

One of the following:
"requested"
"ready"
"sas_ready"
"qr_scanned"
"done"
"cancelled"
"error"
error: optional object { code, reason }

Verification error details, if verification stopped.

code: string

Verification error code.

reason: string

User-facing verification error message.

otherDevice: optional object { id, name }

Other device participating in verification.

id: string

Other device ID.

name: optional string

Other device display name, if known.

otherUserID: optional string

Other Beeper user participating in verification.

qr: optional object { data }

QR verification data.

data: string

QR code payload to display for verification.

sas: optional object { emojis, decimals }

Emoji or number comparison data for verification.

emojis: string

Emoji sequence to compare on both devices.

decimals: optional string

Number sequence to compare on both devices.

List active verifications

curl http://localhost:23373/v1/app/setup/verifications \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN"
{
  "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"
      }
    }
  ]
}