## Get Beeper app setup state

`client.app.session(RequestOptionsoptions?): AppSessionResponse`

**get** `/v1/app/setup`

Return the current Beeper Desktop or Beeper Server sign-in and encrypted messaging setup state. This endpoint is public before sign-in so apps can discover that sign-in is needed; after sign-in, pass a read token.

### Returns

- `AppSessionResponse`

  - `e2ee: E2EE`

    Encrypted messaging setup status.

    - `crossSigning: boolean`

      Whether this account can verify trusted devices.

    - `firstSyncDone: boolean`

      Whether the first encrypted message sync is complete.

    - `hasBackedUpRecoveryKey: boolean`

      Whether the user confirmed that they saved their recovery key.

    - `initialized: boolean`

      Whether encrypted messaging setup has started.

    - `keyBackup: boolean`

      Whether encrypted message backup is available.

    - `secrets: Secrets`

      Encrypted messaging keys available on this device.

      - `masterKey: boolean`

        Whether the account identity key is available.

      - `megolmBackupKey: boolean`

        Whether the encrypted message backup key is available.

      - `recoveryKey: boolean`

        Whether a recovery key is available.

      - `selfSigningKey: boolean`

        Whether the device trust key is available.

      - `userSigningKey: boolean`

        Whether the user trust key is available.

    - `secretStorage: boolean`

      Whether secure key storage is available.

    - `verified: boolean`

      Whether this device is trusted for encrypted messages.

    - `recoveryKeyGeneratedAt?: number`

      Unix timestamp for when the recovery key was created.

  - `state: "needs-login" | "initializing" | "needs-cross-signing-setup" | 4 more`

    Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

    - `"needs-login"`

    - `"initializing"`

    - `"needs-cross-signing-setup"`

    - `"needs-verification"`

    - `"needs-secrets"`

    - `"needs-first-sync"`

    - `"ready"`

  - `matrix?: Matrix`

    Signed-in account details. Omitted until sign-in is complete.

    - `deviceID: string`

      Current device ID.

    - `homeserver: string`

      Beeper homeserver URL for this account.

    - `userID: string`

      Signed-in Beeper user ID.

  - `verification?: Verification`

    Trusted device verification progress.

    - `id: string`

      Verification ID to pass in verification action paths.

    - `availableActions: Array<"accept" | "cancel" | "qr.confirmScanned" | 2 more>`

      Verification actions that are valid for the current state.

      - `"accept"`

      - `"cancel"`

      - `"qr.confirmScanned"`

      - `"sas.start"`

      - `"sas.confirm"`

    - `direction: "incoming" | "outgoing"`

      Whether this device started or received the verification.

      - `"incoming"`

      - `"outgoing"`

    - `methods: Array<"qr" | "sas">`

      Verification methods supported for this transaction.

      - `"qr"`

      - `"sas"`

    - `purpose: "login" | "device"`

      Why this verification exists.

      - `"login"`

      - `"device"`

    - `state: "requested" | "ready" | "sas_ready" | 4 more`

      Current trusted-device verification state.

      - `"requested"`

      - `"ready"`

      - `"sas_ready"`

      - `"qr_scanned"`

      - `"done"`

      - `"cancelled"`

      - `"error"`

    - `error?: Error`

      Verification error details, if verification stopped.

      - `code: string`

        Verification error code.

      - `reason: string`

        User-facing verification error message.

    - `otherDevice?: OtherDevice`

      Other device participating in verification.

      - `id: string`

        Other device ID.

      - `name?: string`

        Other device display name, if known.

    - `otherUserID?: string`

      Other Beeper user participating in verification.

    - `qr?: Qr`

      QR verification data.

      - `data: string`

        QR code payload to display for verification.

    - `sas?: SAS`

      Emoji or number comparison data for verification.

      - `emojis: string`

        Emoji sequence to compare on both devices.

      - `decimals?: string`

        Number sequence to compare on both devices.

### Example

```typescript
import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

const response = await client.app.session();

console.log(response.e2ee);
```

#### Response

```json
{
  "e2ee": {
    "crossSigning": true,
    "firstSyncDone": true,
    "hasBackedUpRecoveryKey": true,
    "initialized": true,
    "keyBackup": true,
    "secrets": {
      "masterKey": true,
      "megolmBackupKey": true,
      "recoveryKey": true,
      "selfSigningKey": true,
      "userSigningKey": true
    },
    "secretStorage": true,
    "verified": true,
    "recoveryKeyGeneratedAt": 0
  },
  "state": "needs-login",
  "matrix": {
    "deviceID": "deviceID",
    "homeserver": "homeserver",
    "userID": "userID"
  },
  "verification": {
    "id": "id",
    "availableActions": [
      "accept"
    ],
    "direction": "incoming",
    "methods": [
      "qr"
    ],
    "purpose": "login",
    "state": "requested",
    "error": {
      "code": "code",
      "reason": "reason"
    },
    "otherDevice": {
      "id": "id",
      "name": "name"
    },
    "otherUserID": "otherUserID",
    "qr": {
      "data": "data"
    },
    "sas": {
      "emojis": "emojis",
      "decimals": "decimals"
    }
  }
}
```