Get capabilities

The workspace’s KYB state (workspace.kybStatus) and, for each capability, whether it is allowed now or blocked, with each blocker’s code and the step that clears it. The quote and order routes enforce the same decision. An API key needs the compliance_read scope and reads only the workspace it is bound to.

GET /api/v1/workspaces/{workspaceId}/capabilities

Read the workspace's verification state and the capabilities it allows

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/capabilities \
  --header 'Authorization: Bearer <token>'

200

{
  "account": {
    "kycStatus": "not_registered",
    "sanctionsScreening": "unscreened",
    "walletVerifiedCount": 1
  },
  "capabilities": {},
  "platformStatus": "onboarding",
  "screening": {
    "geoSource": "edgeHeader",
    "walletScreeningProvider": "chainalysis"
  },
  "workspace": {
    "kybStatus": "not_started",
    "nameScreening": "unscreened",
    "kybRecord": {
      "state": "notApplicable"
    }
  },
  "workspaceId": "<string>",
  "workspaceType": "direct_user",
  "bookAccountsEnabled": true,
  "informationNeeded": [
    {
      "items": [
        "<string>"
      ],
      "lpEntityId": "<string>"
    }
  ],
  "lifecycle": "onboarding"
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

compliance_read · bearer_auth

compliance_read · api_key

Headers

X-Workspace-Id · string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId · string · required

Workspace ID

Response

200

application/json

Capability snapshot with blockers per capability and permission-filtered KYB record facts; failed review reads report unavailable while preserving HTTP 200

What the workspace can do now, as the API enforces it. capabilities holds one decision per capability: allowed, or blocked with each blocker's code, the step that clears it (unlockStep), an estimate and the items still due. The quote and order routes apply the same decision and refuse with CAPABILITY_BLOCKED and the same blockers in details.capabilityBlockers.

account · object · required

The acting member's own verification: identity verification (kycStatus), verified wallet count and name screening. For an API key, the member who owns the key.

Show child attributes

capabilities · object · required

Show child attributes

platformStatus · enum<string> · required

The workspace's platform status: onboarding, active, suspended or deactivated. lifecycle tells a KYB lapse apart from a suspension.

New values may be added; treat unknown values as other.

Available options: onboarding, active, suspended, deactivated

screening · object · required

The environment's screening sources, so a client can tell whether a screened claim is a real sanctions check.

Show child attributes

workspace · object · required

The workspace's own verification. No workspace type needs TetraFi KYB to trade, and KYB blocks no capability. kybStatus is its effective KYB state, kept as profile information: not_started, pending, in_review, approved, rejected, expired, or unavailable when it could not be read; new values may be added.

Show child attributes

workspaceId · string · required

workspaceType · enum<string> · required

The workspace type: direct_user, company, broker or lp.

New values may be added; treat unknown values as other.

Available options: direct_user, company, broker, lp

bookAccountsEnabled · boolean

Whether the platform exposes desk books. This is presentation availability, not permission to read another holder's book or to move funds.

informationNeeded · object[] | null

The LPs this workspace has a relationship with whose enforced serving requirements find a fact it has not recorded, with the onboarding items that supply it. Advisory, never a blocker. null when the requirements could not be read; an empty list when nothing is needed.

Show child attributes

lifecycle · null | enum<string>

Where the workspace stands, as the gates read it: onboarding, active, suspended, deactivated or archived.

Available options: onboarding, active, suspended, deactivated, archived