---
title: "Describe the current credential"
method: GET
path: "/v1/whoami"
tags: ["Workspace"]
---

# Describe the current credential

`GET /v1/whoami`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/whoami`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Returns the workspace, auth method, scopes, and plan for the authenticated credential. On the Firebase web-session path the workspace comes from the `X-Workspace-ID` header and membership is verified; API keys and OAuth tokens are bound to a single workspace. Answers on every plan (metered at the Standard rate), so a connection can be tested on Free and Starter.

## Response `200`

The calling credential and its bound workspace.

- object
  - `success` true, required
  - `data` object, required: Identity of the calling credential and its bound workspace. Powers `banksync whoami`, `banksync status`, and the CLI deep-link connect flow.
    - `workspaceId` string, nullable, required: The workspace this credential is bound to. Null on a session with no workspace selected.
    - `workspaceName` string, nullable, required: Display name of the workspace.
    - `authMethod` 'apiKey' | 'oauth' | 'firebase', required: How the request authenticated: `apiKey` (X-API-Key), `oauth` (Bearer JWT), or `firebase` (web session).
    - `scopes` string[], required: Scopes granted to this credential (`resource:action`). Firebase sessions receive all scopes.
    - `planTier` string, nullable, required: Subscription plan of the workspace (e.g. `free`, `starter`, `professional`, `business`, `enterprise`).
    - `appId` string, nullable, required: The OAuth app this token was issued to. Null for API keys, Firebase sessions, and OAuth clients that are not a listed app (e.g. a dynamically registered AI tool).
    - `installId` string, nullable, required: The app install this token acts under. Null when the credential is not an app token.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden — the caller is not a member of the requested workspace

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)