Setup
Complete first-party Beeper app setup
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
SetupRecovery 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
SetupRecovery 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
SetupVerifications
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
SetupVerificationsQR
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
SetupVerificationsSAS
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