Skip to content
Beeper Developer Docs
Download Beeper
API Reference

App

Manage Beeper app login and encrypted messaging setup

Get Beeper app setup state
client.App.Session(ctx) (*AppSessionResponse, error)
GET/v1/app/setup
ModelsExpand Collapse
type Verification struct{…}

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 VerificationAvailableActionAccept VerificationAvailableAction = "accept"
const VerificationAvailableActionCancel VerificationAvailableAction = "cancel"
const VerificationAvailableActionQrConfirmScanned VerificationAvailableAction = "qr.confirmScanned"
const VerificationAvailableActionSASStart VerificationAvailableAction = "sas.start"
const VerificationAvailableActionSASConfirm VerificationAvailableAction = "sas.confirm"
Direction VerificationDirection

Whether this device started or received the verification.

One of the following:
const VerificationDirectionIncoming VerificationDirection = "incoming"
const VerificationDirectionOutgoing VerificationDirection = "outgoing"
Methods []string

Verification methods supported for this transaction.

One of the following:
const VerificationMethodQr VerificationMethod = "qr"
const VerificationMethodSAS VerificationMethod = "sas"
Purpose VerificationPurpose

Why this verification exists.

One of the following:
const VerificationPurposeLogin VerificationPurpose = "login"
const VerificationPurposeDevice VerificationPurpose = "device"
State VerificationState

Current trusted-device verification state.

One of the following:
const VerificationStateRequested VerificationState = "requested"
const VerificationStateReady VerificationState = "ready"
const VerificationStateSASReady VerificationState = "sas_ready"
const VerificationStateQrScanned VerificationState = "qr_scanned"
const VerificationStateDone VerificationState = "done"
const VerificationStateCancelled VerificationState = "cancelled"
const VerificationStateError VerificationState = "error"
Error VerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice VerificationOtherDeviceOptional

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 VerificationQrOptional

QR verification data.

Data string

QR code payload to display for verification.

SAS VerificationSASOptional

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.

AppLogin

Complete first-party Beeper app login

Start Beeper app setup
client.App.Login.Start(ctx) (*AppLoginStartResponse, error)
POST/v1/app/setup/start
Send setup sign-in code
client.App.Login.Email(ctx, body) error
POST/v1/app/setup/email
Complete setup sign-in with code
client.App.Login.Response(ctx, body) (*AppLoginResponseResponseUnion, error)
POST/v1/app/setup/response
Create account for setup
client.App.Login.Register(ctx, body) (*AppLoginRegisterResponse, error)
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
client.App.Login.Verification.RecoveryKey.Verify(ctx, body) (*AppLoginVerificationRecoveryKeyVerifyResponse, error)
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
client.App.Login.Verification.RecoveryKey.Reset.New(ctx, body) (*AppLoginVerificationRecoveryKeyResetNewResponse, error)
POST/v1/app/setup/verification/recovery-key/reset
Confirm new recovery key
client.App.Login.Verification.RecoveryKey.Reset.Confirm(ctx, body) (*AppLoginVerificationRecoveryKeyResetConfirmResponse, error)
POST/v1/app/setup/verification/recovery-key/reset/confirm

AppVerifications

Manage device verification transactions

List active verifications
client.App.Verifications.List(ctx) (*AppVerificationListResponse, error)
GET/v1/app/setup/verifications
Start device verification
client.App.Verifications.New(ctx, body) (*AppVerificationNewResponse, error)
POST/v1/app/setup/verifications
Get verification
client.App.Verifications.Get(ctx, verificationID) (*AppVerificationGetResponse, error)
GET/v1/app/setup/verifications/{verificationID}
Accept device verification
client.App.Verifications.Accept(ctx, verificationID) (*AppVerificationAcceptResponse, error)
POST/v1/app/setup/verifications/{verificationID}/accept
Cancel device verification
client.App.Verifications.Cancel(ctx, verificationID, body) (*AppVerificationCancelResponse, error)
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
client.App.Verifications.Qr.Scan(ctx, body) (*AppVerificationQrScanResponse, error)
POST/v1/app/setup/verifications/qr/scan
Confirm QR code scan
client.App.Verifications.Qr.ConfirmScanned(ctx, verificationID) (*AppVerificationQrConfirmScannedResponse, error)
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
client.App.Verifications.SAS.Start(ctx, verificationID) (*AppVerificationSASStartResponse, error)
POST/v1/app/setup/verifications/{verificationID}/sas/start
Confirm emoji verification
client.App.Verifications.SAS.Confirm(ctx, verificationID) (*AppVerificationSASConfirmResponse, error)
POST/v1/app/setup/verifications/{verificationID}/sas/confirm