Skip to content
Beeper Developer Docs
Download Beeper
API Reference

App

Manage Beeper account setup and encrypted messaging setup

ModelsExpand Collapse
string recoveryKey

New recovery key. Show it once and ask the user to save it.

Session session

Current app sign-in and encrypted messaging setup state after creating the new recovery key.

Matrix matrix

Account credentials for first-party app setup.

Session session

Current app sign-in and encrypted messaging setup state after sign-in.

Copy copy

Copy to display during account creation.

string leadToken

Registration token returned by Beeper.

true registrationRequired

Indicates that the user needs to create a Beeper account.

string setupRequestID

Setup request ID to use when creating the account.

?list<string> usernameSuggestions

Suggested usernames for the new account.

One of the following:
AppSetupCompleteResponse
Matrix matrix

Account credentials for first-party app setup.

Session session

Current app sign-in and encrypted messaging setup state after sign-in.

AppSetupRegistrationRequiredResponse
Copy copy

Copy to display during account creation.

string leadToken

Registration token returned by Beeper.

true registrationRequired

Indicates that the user needs to create a Beeper account.

string setupRequestID

Setup request ID to use when creating the account.

?list<string> usernameSuggestions

Suggested usernames for the new account.

Session session

Current app sign-in and encrypted messaging setup state.

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.

Session session

Current app sign-in and encrypted messaging setup state.

?Verification verification

Trusted device verification progress.

AppSetup

Complete first-party Beeper app setup

Get Beeper app setup state
$client->app->setup->retrieve(): SetupGetResponse
GET/v1/app/setup
Start Beeper app setup
$client->app->setup->start(): SetupStartResponse
POST/v1/app/setup/start
Send setup sign-in code
$client->app->setup->email(string email, string setupRequestID): void
POST/v1/app/setup/email
Complete setup sign-in with code
$client->app->setup->response(string response, string setupRequestID): SetupResponseResponse
POST/v1/app/setup/response
Create account for setup
$client->app->setup->register(true acceptTerms, string leadToken, string setupRequestID, string username): SetupRegisterResponse
POST/v1/app/setup/register

AppSetupRecovery Key

Manage recovery-key setup for encrypted messages

Verify with recovery key
$client->app->setup->recoveryKey->verify(string recoveryKey): RecoveryKeyVerifyResponse
POST/v1/app/setup/verification/recovery-key

AppSetupRecovery KeyReset

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

Create new recovery key
$client->app->setup->recoveryKey->reset->create(?string existingRecoveryKey): ResetNewResponse
POST/v1/app/setup/verification/recovery-key/reset
Confirm new recovery key
$client->app->setup->recoveryKey->reset->confirm(string recoveryKey): ResetConfirmResponse
POST/v1/app/setup/verification/recovery-key/reset/confirm

AppSetupVerifications

Manage device verification transactions

List active verifications
$client->app->setup->verifications->list(): VerificationListResponse
GET/v1/app/setup/verifications
Start device verification
$client->app->setup->verifications->create(?Purpose purpose, ?string userID): VerificationNewResponse
POST/v1/app/setup/verifications
Get verification
$client->app->setup->verifications->retrieve(string verificationID): VerificationGetResponse
GET/v1/app/setup/verifications/{verificationID}
Accept device verification
$client->app->setup->verifications->accept(string verificationID): VerificationAcceptResponse
POST/v1/app/setup/verifications/{verificationID}/accept
Cancel device verification
$client->app->setup->verifications->cancel(string verificationID, ?string code, ?string reason): VerificationCancelResponse
POST/v1/app/setup/verifications/{verificationID}/cancel

AppSetupVerificationsQR

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

Scan verification QR code
$client->app->setup->verifications->qr->scan(string data): QRScanResponse
POST/v1/app/setup/verifications/qr/scan
Confirm QR code scan
$client->app->setup->verifications->qr->confirmScanned(string verificationID): QRConfirmScannedResponse
POST/v1/app/setup/verifications/{verificationID}/qr/confirm-scanned

AppSetupVerificationsSAS

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

Start emoji verification
$client->app->setup->verifications->sas->start(string verificationID): SASStartResponse
POST/v1/app/setup/verifications/{verificationID}/sas/start
Confirm emoji verification
$client->app->setup->verifications->sas->confirm(string verificationID): SASConfirmResponse
POST/v1/app/setup/verifications/{verificationID}/sas/confirm