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(): AppSessionResponse
GET/v1/app/setup
ModelsExpand Collapse
string id

Verification ID to pass in verification action paths.

list<AvailableAction> availableActions

Verification actions that are valid for the current state.

Direction direction

Whether this device started or received the verification.

list<Method> methods

Verification methods supported for this transaction.

Purpose purpose

Why this verification exists.

State state

Current trusted-device verification state.

?Error error

Verification error details, if verification stopped.

?OtherDevice otherDevice

Other device participating in verification.

?string otherUserID

Other Beeper user participating in verification.

?Qr qr

QR verification data.

?SAS sas

Emoji or number comparison data for verification.

AppLogin

Complete first-party Beeper app login

Start Beeper app setup
$client->app->login->start(): LoginStartResponse
POST/v1/app/setup/start
Send setup sign-in code
$client->app->login->email(string email, string setupRequestID): void
POST/v1/app/setup/email
Complete setup sign-in with code
$client->app->login->response(string response, string setupRequestID): LoginResponseResponse
POST/v1/app/setup/response
Create account for setup
$client->app->login->register(true acceptTerms, string leadToken, string setupRequestID, string username): LoginRegisterResponse
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(string recoveryKey): RecoveryKeyVerifyResponse
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->create(?string existingRecoveryKey): ResetNewResponse
POST/v1/app/setup/verification/recovery-key/reset
Confirm new recovery key
$client->app->login->verification->recoveryKey->reset->confirm(string recoveryKey): ResetConfirmResponse
POST/v1/app/setup/verification/recovery-key/reset/confirm

AppVerifications

Manage device verification transactions

List active verifications
$client->app->verifications->list(): VerificationListResponse
GET/v1/app/setup/verifications
Start device verification
$client->app->verifications->create(?Purpose purpose, ?string userID): VerificationNewResponse
POST/v1/app/setup/verifications
Get verification
$client->app->verifications->retrieve(string verificationID): VerificationGetResponse
GET/v1/app/setup/verifications/{verificationID}
Accept device verification
$client->app->verifications->accept(string verificationID): VerificationAcceptResponse
POST/v1/app/setup/verifications/{verificationID}/accept
Cancel device verification
$client->app->verifications->cancel(string verificationID, ?string code, ?string reason): VerificationCancelResponse
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(string data): QrScanResponse
POST/v1/app/setup/verifications/qr/scan
Confirm QR code scan
$client->app->verifications->qr->confirmScanned(string verificationID): QrConfirmScannedResponse
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(string verificationID): SASStartResponse
POST/v1/app/setup/verifications/{verificationID}/sas/start
Confirm emoji verification
$client->app->verifications->sas->confirm(string verificationID): SASConfirmResponse
POST/v1/app/setup/verifications/{verificationID}/sas/confirm