Skip to content
Beeper Developer Docs
Download Beeper
API Reference

App

Manage Beeper app login and encrypted messaging setup

Get Beeper app setup state
$ beeper-desktop app session
GET/v1/app/setup
ModelsExpand Collapse
verification: object { id, availableActions, direction, 8 more }

Trusted device verification progress.

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.

"accept"
"cancel"
"qr.confirmScanned"
"sas.start"
"sas.confirm"
direction: "incoming" or "outgoing"

Whether this device started or received the verification.

"incoming"
"outgoing"
methods: array of "qr" or "sas"

Verification methods supported for this transaction.

"qr"
"sas"
purpose: "login" or "device"

Why this verification exists.

"login"
"device"
state: "requested" or "ready" or "sas_ready" or 4 more

Current trusted-device verification state.

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

AppLogin

Complete first-party Beeper app login

Start Beeper app setup
$ beeper-desktop app:login start
POST/v1/app/setup/start
Send setup sign-in code
$ beeper-desktop app:login email
POST/v1/app/setup/email
Complete setup sign-in with code
$ beeper-desktop app:login response
POST/v1/app/setup/response
Create account for setup
$ beeper-desktop app:login register
POST/v1/app/setup/register

AppLoginVerification

AppLoginVerificationRecovery Key

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Verify with recovery key
$ beeper-desktop app:login:verification:recovery-key verify
POST/v1/app/setup/verification/recovery-key

AppLoginVerificationRecovery KeyReset

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Create new recovery key
$ beeper-desktop app:login:verification:recovery-key:reset create
POST/v1/app/setup/verification/recovery-key/reset
Confirm new recovery key
$ beeper-desktop app:login:verification:recovery-key:reset confirm
POST/v1/app/setup/verification/recovery-key/reset/confirm

AppVerifications

Manage device verification transactions

List active verifications
$ beeper-desktop app:verifications list
GET/v1/app/setup/verifications
Start device verification
$ beeper-desktop app:verifications create
POST/v1/app/setup/verifications
Get verification
$ beeper-desktop app:verifications retrieve
GET/v1/app/setup/verifications/{verificationID}
Accept device verification
$ beeper-desktop app:verifications accept
POST/v1/app/setup/verifications/{verificationID}/accept
Cancel device verification
$ beeper-desktop app:verifications cancel
POST/v1/app/setup/verifications/{verificationID}/cancel

AppVerificationsQr

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Scan verification QR code
$ beeper-desktop app:verifications:qr scan
POST/v1/app/setup/verifications/qr/scan
Confirm QR code scan
$ beeper-desktop app:verifications:qr confirm-scanned
POST/v1/app/setup/verifications/{verificationID}/qr/confirm-scanned

AppVerificationsSAS

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Start emoji verification
$ beeper-desktop app:verifications:sas start
POST/v1/app/setup/verifications/{verificationID}/sas/start
Confirm emoji verification
$ beeper-desktop app:verifications:sas confirm
POST/v1/app/setup/verifications/{verificationID}/sas/confirm