Skip to content
Download Beeper

Start device verification

client.App.Setup.Verifications.New(ctx, body) (*AppSetupVerificationNewResponse, error)
POST/v1/app/setup/verifications

Start verifying this device from another signed-in device.

ParametersExpand Collapse
body AppSetupVerificationNewParams
Purpose param.Field[AppSetupVerificationNewParamsPurpose]Optional

Why this verification is being started.

const AppSetupVerificationNewParamsPurposeLogin AppSetupVerificationNewParamsPurpose = "login"
const AppSetupVerificationNewParamsPurposeDevice AppSetupVerificationNewParamsPurpose = "device"
UserID param.Field[string]Optional

Beeper user ID to verify. Defaults to the signed-in user.

ReturnsExpand Collapse
type AppSetupVerificationNewResponse struct{…}
Session AppSetupVerificationNewResponseSession

Current app sign-in and encrypted messaging setup state.

E2EE AppSetupVerificationNewResponseSessionE2EE

Encrypted messaging setup status.

CrossSigning bool

Whether this account can verify trusted devices.

FirstSyncDone bool

Whether the first encrypted message sync is complete.

HasBackedUpRecoveryKey bool

Whether the user confirmed that they saved their recovery key.

Initialized bool

Whether encrypted messaging setup has started.

KeyBackup bool

Whether encrypted message backup is available.

Secrets AppSetupVerificationNewResponseSessionE2EESecrets

Encrypted messaging keys available on this device.

MasterKey bool

Whether the account identity key is available.

MegolmBackupKey bool

Whether the encrypted message backup key is available.

RecoveryKey bool

Whether a recovery key is available.

SelfSigningKey bool

Whether the device trust key is available.

UserSigningKey bool

Whether the user trust key is available.

SecretStorage bool

Whether secure key storage is available.

Verified bool

Whether this device is trusted for encrypted messages.

RecoveryKeyGeneratedAt float64Optional

Unix timestamp for when the recovery key was created.

State string

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:
const AppSetupVerificationNewResponseSessionStateNeedsLogin AppSetupVerificationNewResponseSessionState = "needs-login"
const AppSetupVerificationNewResponseSessionStateInitializing AppSetupVerificationNewResponseSessionState = "initializing"
const AppSetupVerificationNewResponseSessionStateNeedsCrossSigningSetup AppSetupVerificationNewResponseSessionState = "needs-cross-signing-setup"
const AppSetupVerificationNewResponseSessionStateNeedsVerification AppSetupVerificationNewResponseSessionState = "needs-verification"
const AppSetupVerificationNewResponseSessionStateNeedsSecrets AppSetupVerificationNewResponseSessionState = "needs-secrets"
const AppSetupVerificationNewResponseSessionStateNeedsFirstSync AppSetupVerificationNewResponseSessionState = "needs-first-sync"
const AppSetupVerificationNewResponseSessionStateReady AppSetupVerificationNewResponseSessionState = "ready"
Matrix AppSetupVerificationNewResponseSessionMatrixOptional

Signed-in account details. Omitted until sign-in is complete.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Verification AppSetupVerificationNewResponseSessionVerificationOptional

Trusted device verification progress.

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 AppSetupVerificationNewResponseSessionVerificationAvailableActionAccept AppSetupVerificationNewResponseSessionVerificationAvailableAction = "accept"
const AppSetupVerificationNewResponseSessionVerificationAvailableActionCancel AppSetupVerificationNewResponseSessionVerificationAvailableAction = "cancel"
const AppSetupVerificationNewResponseSessionVerificationAvailableActionQRConfirmScanned AppSetupVerificationNewResponseSessionVerificationAvailableAction = "qr.confirmScanned"
const AppSetupVerificationNewResponseSessionVerificationAvailableActionSASStart AppSetupVerificationNewResponseSessionVerificationAvailableAction = "sas.start"
const AppSetupVerificationNewResponseSessionVerificationAvailableActionSASConfirm AppSetupVerificationNewResponseSessionVerificationAvailableAction = "sas.confirm"
Direction string

Whether this device started or received the verification.

One of the following:
const AppSetupVerificationNewResponseSessionVerificationDirectionIncoming AppSetupVerificationNewResponseSessionVerificationDirection = "incoming"
const AppSetupVerificationNewResponseSessionVerificationDirectionOutgoing AppSetupVerificationNewResponseSessionVerificationDirection = "outgoing"
Methods []string

Verification methods supported for this transaction.

One of the following:
const AppSetupVerificationNewResponseSessionVerificationMethodQR AppSetupVerificationNewResponseSessionVerificationMethod = "qr"
const AppSetupVerificationNewResponseSessionVerificationMethodSAS AppSetupVerificationNewResponseSessionVerificationMethod = "sas"
Purpose string

Why this verification exists.

One of the following:
const AppSetupVerificationNewResponseSessionVerificationPurposeLogin AppSetupVerificationNewResponseSessionVerificationPurpose = "login"
const AppSetupVerificationNewResponseSessionVerificationPurposeDevice AppSetupVerificationNewResponseSessionVerificationPurpose = "device"
State string

Current trusted-device verification state.

One of the following:
const AppSetupVerificationNewResponseSessionVerificationStateRequested AppSetupVerificationNewResponseSessionVerificationState = "requested"
const AppSetupVerificationNewResponseSessionVerificationStateReady AppSetupVerificationNewResponseSessionVerificationState = "ready"
const AppSetupVerificationNewResponseSessionVerificationStateSASReady AppSetupVerificationNewResponseSessionVerificationState = "sas_ready"
const AppSetupVerificationNewResponseSessionVerificationStateQRScanned AppSetupVerificationNewResponseSessionVerificationState = "qr_scanned"
const AppSetupVerificationNewResponseSessionVerificationStateDone AppSetupVerificationNewResponseSessionVerificationState = "done"
const AppSetupVerificationNewResponseSessionVerificationStateCancelled AppSetupVerificationNewResponseSessionVerificationState = "cancelled"
const AppSetupVerificationNewResponseSessionVerificationStateError AppSetupVerificationNewResponseSessionVerificationState = "error"
Error AppSetupVerificationNewResponseSessionVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice AppSetupVerificationNewResponseSessionVerificationOtherDeviceOptional

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 AppSetupVerificationNewResponseSessionVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS AppSetupVerificationNewResponseSessionVerificationSASOptional

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.

Verification AppSetupVerificationNewResponseVerificationOptional

Trusted device verification progress.

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 AppSetupVerificationNewResponseVerificationAvailableActionAccept AppSetupVerificationNewResponseVerificationAvailableAction = "accept"
const AppSetupVerificationNewResponseVerificationAvailableActionCancel AppSetupVerificationNewResponseVerificationAvailableAction = "cancel"
const AppSetupVerificationNewResponseVerificationAvailableActionQRConfirmScanned AppSetupVerificationNewResponseVerificationAvailableAction = "qr.confirmScanned"
const AppSetupVerificationNewResponseVerificationAvailableActionSASStart AppSetupVerificationNewResponseVerificationAvailableAction = "sas.start"
const AppSetupVerificationNewResponseVerificationAvailableActionSASConfirm AppSetupVerificationNewResponseVerificationAvailableAction = "sas.confirm"
Direction string

Whether this device started or received the verification.

One of the following:
const AppSetupVerificationNewResponseVerificationDirectionIncoming AppSetupVerificationNewResponseVerificationDirection = "incoming"
const AppSetupVerificationNewResponseVerificationDirectionOutgoing AppSetupVerificationNewResponseVerificationDirection = "outgoing"
Methods []string

Verification methods supported for this transaction.

One of the following:
const AppSetupVerificationNewResponseVerificationMethodQR AppSetupVerificationNewResponseVerificationMethod = "qr"
const AppSetupVerificationNewResponseVerificationMethodSAS AppSetupVerificationNewResponseVerificationMethod = "sas"
Purpose string

Why this verification exists.

One of the following:
const AppSetupVerificationNewResponseVerificationPurposeLogin AppSetupVerificationNewResponseVerificationPurpose = "login"
const AppSetupVerificationNewResponseVerificationPurposeDevice AppSetupVerificationNewResponseVerificationPurpose = "device"
State string

Current trusted-device verification state.

One of the following:
const AppSetupVerificationNewResponseVerificationStateRequested AppSetupVerificationNewResponseVerificationState = "requested"
const AppSetupVerificationNewResponseVerificationStateReady AppSetupVerificationNewResponseVerificationState = "ready"
const AppSetupVerificationNewResponseVerificationStateSASReady AppSetupVerificationNewResponseVerificationState = "sas_ready"
const AppSetupVerificationNewResponseVerificationStateQRScanned AppSetupVerificationNewResponseVerificationState = "qr_scanned"
const AppSetupVerificationNewResponseVerificationStateDone AppSetupVerificationNewResponseVerificationState = "done"
const AppSetupVerificationNewResponseVerificationStateCancelled AppSetupVerificationNewResponseVerificationState = "cancelled"
const AppSetupVerificationNewResponseVerificationStateError AppSetupVerificationNewResponseVerificationState = "error"
Error AppSetupVerificationNewResponseVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice AppSetupVerificationNewResponseVerificationOtherDeviceOptional

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 AppSetupVerificationNewResponseVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS AppSetupVerificationNewResponseVerificationSASOptional

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.

Start device verification

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"),
  )
  verification, err := client.App.Setup.Verifications.New(context.TODO(), beeperdesktopapi.AppSetupVerificationNewParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", verification.Session)
}
{
  "session": {
    "e2ee": {
      "crossSigning": true,
      "firstSyncDone": true,
      "hasBackedUpRecoveryKey": true,
      "initialized": true,
      "keyBackup": true,
      "secrets": {
        "masterKey": true,
        "megolmBackupKey": true,
        "recoveryKey": true,
        "selfSigningKey": true,
        "userSigningKey": true
      },
      "secretStorage": true,
      "verified": true,
      "recoveryKeyGeneratedAt": 0
    },
    "state": "needs-login",
    "matrix": {
      "deviceID": "deviceID",
      "homeserver": "homeserver",
      "userID": "userID"
    },
    "verification": {
      "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"
      }
    }
  },
  "verification": {
    "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
{
  "session": {
    "e2ee": {
      "crossSigning": true,
      "firstSyncDone": true,
      "hasBackedUpRecoveryKey": true,
      "initialized": true,
      "keyBackup": true,
      "secrets": {
        "masterKey": true,
        "megolmBackupKey": true,
        "recoveryKey": true,
        "selfSigningKey": true,
        "userSigningKey": true
      },
      "secretStorage": true,
      "verified": true,
      "recoveryKeyGeneratedAt": 0
    },
    "state": "needs-login",
    "matrix": {
      "deviceID": "deviceID",
      "homeserver": "homeserver",
      "userID": "userID"
    },
    "verification": {
      "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"
      }
    }
  },
  "verification": {
    "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"
    }
  }
}