Skip to content
Download Beeper

Login

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

LoginVerification

LoginVerificationRecovery 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

LoginVerificationRecovery 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