> ## Documentation Index > Fetch the complete documentation index at: https://tetrafi.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Read the workspace's verification state and the capabilities it allows > 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 `dashboard_read` scope and reads only the workspace it is bound to. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/workspaces/{workspaceId}/capabilities openapi: 3.1.0 info: description: >- TetraFi is an API for institutional trading across on-chain and off-chain venues: discover assets, request quotes, place an order by quote id and read its status. API keys sign every request. Asset-pair quotes: every tagged union is tagged by `kind`; only the outcome of `/prices` rows and `sources[]` entries is tagged by `status`. title: TetraFi API version: 1.0.0-beta.1 servers: - url: https://api.tetrafi.io security: - api_key: [] tags: - description: Request price quotes from multiple solvers for cross-chain transactions name: quotes - description: Submit, track, and manage cross-chain orders name: orders - description: Canonical trading pairs and aggregator metadata name: trading - description: >- Authentication — registration, login, SIWE, OAuth, sessions, login activity name: auth - description: Workspace CRUD, settings, members, and team management name: workspaces - description: >- Webhook management — CRUD, secret rotation, test delivery, delivery history name: webhooks paths: /api/v1/workspaces/{workspaceId}/capabilities: get: tags: - workspaces summary: Read the workspace's verification state and the capabilities it allows description: >- 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 `dashboard_read` scope and reads only the workspace it is bound to. operationId: get_workspace_capabilities parameters: - $ref: '#/components/parameters/WorkspaceId' - description: Workspace ID in: path name: workspaceId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspaceCapabilitiesResponse' description: >- Capability snapshot with blockers per capability and permission-filtered KYB record facts; failed review reads report unavailable while preserving HTTP 200 headers: x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '400': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: >- The request could not be read or failed validation; `error` names the cause. headers: x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '401': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: Authentication required headers: WWW-Authenticate: description: >- Sent when the request presented a bearer token and it was refused: `Bearer error="invalid_token"` (RFC 6750 section 3). Exchange a new token. A refused API key carries no challenge. schema: type: string x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '403': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: >- An API key without `dashboard_read` (`INSUFFICIENT_SCOPE`), or an inaccessible header workspace (`WORKSPACE_SCOPE_MISMATCH`) headers: x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '404': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: >- `WORKSPACE_NOT_FOUND` - the path workspace is unknown or differs from the authenticated workspace; the response is identical headers: x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '408': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: The request timed out before a response was ready. headers: x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '429': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: >- Too many requests. Wait the number of seconds in `Retry-After` before retrying. headers: Retry-After: description: >- Whole seconds to wait before retrying. Always sent on 429; sent on 503 when the wait is known. `details.retryAfter` carries the same wait as an ISO 8601 duration. schema: minimum: 0 type: integer x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '500': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: Something went wrong on our side. headers: x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string '503': content: application/json: schema: $ref: '#/components/schemas/ApiError' description: >- Current business profile or observation authority is unavailable; no capability snapshot is released. A profile that was never readable is not this case: its snapshot is released and names `KYB_UNAVAILABLE` headers: Retry-After: description: >- Whole seconds to wait before retrying. Always sent on 429; sent on 503 when the wait is known. `details.retryAfter` carries the same wait as an ISO 8601 duration. schema: minimum: 0 type: integer x-ratelimit-limit: description: >- Sent only when the request's API key has its own requests-per-minute limit: that limit. Sessions, and keys without their own limit, never receive it. schema: minimum: 0 type: integer x-ratelimit-remaining: description: >- Requests left before this caller is limited: the per-address limit's when that limit counted the request, otherwise the API key's own remaining allowance. Absent when no finite limit counted the request. schema: minimum: 0 type: integer x-ratelimit-reset: description: >- Sent with x-ratelimit-limit, only when the request's API key has its own limit: whole seconds until that allowance is full again. schema: minimum: 0 type: integer x-request-id: description: >- The request's id: the caller's valid `X-Request-Id`, or a generated UUID v4. Quote it when asking for support. schema: type: string security: - bearer_auth: [] components: parameters: WorkspaceId: description: >- 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). in: header name: X-Workspace-Id required: false schema: format: uuid type: string schemas: WorkspaceCapabilitiesResponse: description: >- 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. properties: account: $ref: '#/components/schemas/AccountReadiness' capabilities: additionalProperties: $ref: '#/components/schemas/CapabilityDecision' propertyNames: description: >- A capability: view_indicative_quotes, request_quotes (firm quotes), submit_order, establish_counterparty_relationship, onboard_direct_users, execute_value_movement, create_signing_authority, provision_wallet or activate_solver. Viewing never blocks on verification; acting does. New values may be added; treat unknown values as other. enum: - view_indicative_quotes - request_quotes - submit_order - establish_counterparty_relationship - onboard_direct_users - execute_value_movement - create_signing_authority - provision_wallet - activate_solver type: string x-extensible-enum: true type: object informationNeeded: description: >- 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. items: $ref: '#/components/schemas/LpInformationNeeded' type: - array - 'null' lifecycle: oneOf: - type: 'null' - $ref: '#/components/schemas/WorkspaceLifecycleState' description: >- Where the workspace stands, as the gates read it: onboarding, active, suspended, deactivated or archived. platformStatus: $ref: '#/components/schemas/PlatformStatus' screening: $ref: '#/components/schemas/ScreeningReadiness' description: >- The environment's screening sources, so a client can tell whether a screened claim is a real sanctions check. workspace: $ref: '#/components/schemas/WorkspaceReadiness' workspaceId: type: string workspaceType: $ref: '#/components/schemas/WorkspaceType' required: - workspaceId - workspaceType - platformStatus - account - workspace - screening - capabilities type: object ApiError: description: >- A refusal of an integrator operation. Codes are an open set: a client handles the codes it knows and falls back on the HTTP status for any other. properties: details: oneOf: - type: 'null' - $ref: '#/components/schemas/ApiErrorDetails' docUrl: description: Stable documentation for this refusal code. type: string error: description: The machine-readable code, for example `QUOTE_EXPIRED`. type: string message: description: What happened, in words a person can read. Not for matching. type: string next: oneOf: - type: 'null' - $ref: '#/components/schemas/QuoteNextAction' description: >- The way forward, when there is one (for example `requote` on an expired quote). requestId: description: >- The request's id, the value the `X-Request-Id` response header carries. Quote it when asking for support. type: - string - 'null' retryable: description: >- Whether an unchanged request may succeed later, from the error catalogue. type: boolean timestamp: description: When the refusal was made, in Unix seconds. format: int64 type: integer required: - error - docUrl - retryable - message - timestamp type: object AccountReadiness: description: >- 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. properties: kycStatus: type: string sanctionsScreening: $ref: '#/components/schemas/SanctionsScreeningState' walletVerifiedCount: minimum: 0 type: integer required: - kycStatus - walletVerifiedCount - sanctionsScreening type: object CapabilityDecision: description: Evaluation result for one capability. properties: allowed: type: boolean blockers: items: $ref: '#/components/schemas/CapabilityBlocker' type: array required: - allowed type: object LpInformationNeeded: description: >- One LP whose enforced serving requirement finds a fact the workspace has not recorded, and the onboarding catalogue items that supply it. Advisory: it blocks nothing by itself; the trading path refuses with `LP_REQUIREMENT_INFORMATION_NEEDED` and the same items. properties: items: description: >- Catalogue item ids (`std.*`), in catalogue-map order, without repeats. items: type: string type: array lpEntityId: type: string required: - lpEntityId - items type: object WorkspaceLifecycleState: description: >- The workspace lifecycle, derived from its platform status and any suspension cause. New values may be added; treat unknown values as other. enum: - onboarding - active - suspended - deactivated - archived type: string x-extensible-enum: true PlatformStatus: description: >- 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. enum: - onboarding - active - suspended - deactivated type: string x-extensible-enum: true ScreeningReadiness: description: |- The screening sources configured for this zone. Platform facts, not a subject's verdict. properties: geoSource: $ref: '#/components/schemas/GeoSourceKind' walletScreeningProvider: $ref: '#/components/schemas/ScreeningProviderKind' required: - walletScreeningProvider - geoSource type: object WorkspaceReadiness: description: >- 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. properties: kybRecord: oneOf: - type: 'null' - $ref: '#/components/schemas/KybRecordObservation' description: >- Permission-filtered KYB record facts; absent only from an older server. kybStatus: type: string nameScreening: $ref: '#/components/schemas/SanctionsScreeningState' required: - nameScreening - kybStatus type: object WorkspaceType: description: |- The workspace type: direct_user, company, broker or lp. New values may be added; treat unknown values as other. enum: - direct_user - company - broker - lp type: string x-extensible-enum: true ApiErrorDetails: additionalProperties: description: >- Any further detail the code carries (for example `stepUpSubject`, `balanceShortfall`, `minimumAmount`), each named in camelCase. description: >- The code's detail. Each field is present only on the codes named beside it; other codes may carry further fields, named in camelCase, which a client may ignore. properties: capabilityBlockers: description: >- `CAPABILITY_BLOCKED` and the other capability refusals: what blocks the workspace. items: $ref: '#/components/schemas/CapabilityBlocker' type: - array - 'null' conflicts: description: '`REQUOTE_FIELDS_CONFLICT`: the fields that cannot go with `requote`.' items: type: string type: - array - 'null' field: description: '`INVALID_REQUEST` (out of range): the field.' type: - string - 'null' reason: description: >- A machine-readable reason token the refusing step gave. Known source reason tokens (not all apply to every status): `adapterPayloadSerializationFailed`, `basicVenueAccountsUnavailable`, `billingPaymentOverdue`, `walletNotOnChain`, `ccxtVenueRequiresCexLane`, `executionStageDisabled`, `jurisdictionUnproven`, `onboardedVenuesUnavailable`, `onchainAccountDefaultWalletRequired`, `onchainAccountDefaultWalletUnavailable`, `onchainAccountWalletRequired`, `onchainAssetDecimalsMismatch`, `onchainAssetIdentityMismatch`, `onchainAssetUnmapped`, `onchainAssetVariantFiltered`, `onchainWalletUnavailable`, `onchainCatalogueUnavailable`, `onchainDeliverToNotReceivingWallet`, `onchainDeliverToUnverified`, `onchainMarketsUnavailable`, `onchainMarketCatalogUnreadable`, `onchainMarketChainRequired`, `onchainMarketVariantRequired`, `onchainMarketTokenRequired`, `onchainSiteChainUnreadable`, `onchainWalletChainUnreadable`, `onchainWalletInactive`, `onchainWalletNotLinked`, `onchainWalletNotUsable`, `onchainWalletPickAmbiguous`, `onchainWalletWrongNetwork`, `signerLacksRight`, `signerUnavailable`, `signingGrantAmbiguous`, `signingGrantExpired`, `signingGrantRequired`, `signingGrantTokenNotKept`, `signingGrantTokenNotPayable`, `solverChainUnready`, `walletChainMismatch`, `walletNotUsableByYou`, `walletNotVerifiedForAce`, `walletNotWhitelisted`, `withdrawalChainUnsupported`, `accountFeeUnavailable`, `comparisonCostsUnavailable`, `connectionListingUnavailable`, `feeUnverified`, `noPool`, `noPrice`, `noSize`, `notFilled`, `notYetPublished`, `priceArithmetic`, `priceSourceNone`, `referenceMidUnavailable`, `settlementPrecisionUnavailable`, `accountSetupIncomplete`, `admissionUnavailable`, `advancedAccountEligibilityUnavailable`, `advancedAccountStateInconsistent`, `advancedConnectionDisabled`, `advancedConnectionNotConfigured`, `advancedConnectionPaused`, `advancedSettlementNeedsVerification`, `advancedModeDisabled`, `advancedNotAvailableForAccount`, `advancedNotEnabledForAccount`, `allowanceUnavailable`, `acrossCapacityExceeded`, `relayCapacityExceeded`, `acrossChainNotCarried`, `cctpChainNotCarried`, `relayChainNotCarried`, `apiKeyAdvancedWalletUnsupported`, `apiKeyOrganisationWalletScopeRequired`, `grantCapExceeded`, `amountAboveMaximum`, `amountBelowMinimum`, `amountUnreadable`, `amountsUnreadable`, `askFirst`, `authorityUnavailable`, `automationNeverAsks`, `availabilityUnreadable`, `backgroundNeverAsks`, `balanceUnreadable`, `defaultsUnavailable`, `walletHasNoAddress`, `walletUnavailable`, `bondAmountUnreadable`, `bondAssetUnreadable`, `catalogueUnavailable`, `chainFamilyUnknown`, `chainUnrecorded`, `clientSessionRequired`, `clockUnreadable`, `comingSoon`, `connectionChanged`, `connectionRevoked`, `corridorInvalid`, `credential`, `deadlineExceeded`, `defaultsLoading`, `deliverToCalldataUnsupported`, `deliverToTagUnsupported`, `deliverToNotPermitted`, `deliverToUnreadable`, `tradingPermissionRequired`, `directPatienceHarvest`, `economicallyInferior`, `exactAmountConflictsWithCard`, `exactAmountConflictsWithQuote`, `exactOutputDeliveryUnsupported`, `exactOutputEstimateUnavailable`, `exactRouteHypothesisUnavailable`, `expiredOnArrival`, `expiryUnknown`, `feeUnreadable`, `filteredOut`, `firmAskRefused`, `freshnessUnknown`, `fundingWindow`, `insufficientLiquidity`, `venueRelationship`, `venueRelationshipUnavailable`, `lpUnknown`, `mfaEnrolmentRequired`, `mfaRequired`, `minimumUnverified`, `mixedNetworks`, `netReceivedUnavailable`, `networkUnrecorded`, `noAddress`, `noCard`, `noFetcher`, `noInventory`, `noLaneForPair`, `noLegs`, `noOnChainCorridor`, `noPlannedVenue`, `noQuote`, `noRpc`, `notConnected`, `notEligible`, `notExecutable`, `orderPayloadMissing`, `outsideTopComposites`, `pairUnmapped`, `sellChainInvalid`, `permissionsUnreadable`, `placeOrderNotPermitted`, `prefundingMarkerUnreadable`, `prefundingRequired`, `indicative`, `priceOnRequest`, `priceOutOfRange`, `priceProtectionInvalid`, `pricingBookOnly`, `productNotQuoted`, `protocolChainMissing`, `providerFeeTreatmentUnknown`, `providerSiteUnrecorded`, `quoteIdUnissuable`, `quoteNotHeld`, `buyChainInvalid`, `buyAmountUnsupported`, `exactOutputDebitUnavailable`, `pairNotServed`, `receiveWalletNotServed`, `referenceMidUnreadable`, `referencePriceUnavailable`, `registryUnavailable`, `releaseRecheckUnavailable`, `requestUnbuildable`, `routeLegChainUnknown`, `routeLegUnnamed`, `routeLegUnplanned`, `routeUnavailable`, `secondFactorUnreadable`, `shortfallUnmeasured`, `shortfallUnreadable`, `singleChainVenue`, `siteChainUnreadable`, `sizeNotEligible`, `submitOrderBlocked`, `takerOnboardingIncomplete`, `tierNotQuoted`, `tradePaused`, `unsupportedNative`, `venueConnectionStorageUnavailable`, `venueDataStale`, `venueDeclined`, `venueNotConnected`, `venueNotEnabledForWorkspace`, `venueNotListed`, `venueTradeKeyUnavailable`, `venueTradeScopeRequired`, `venueTradeUnreadable`, `venueUnavailable`, `walletRefused`, `withdrawalFeeUnread`, `acrossRoutedViaCctp`, `apiKeyOrganisationWalletNotAllowlisted`, `balanceAvailabilityUnconfirmed`, `bankDestinationUnavailable`, `bebopJamKeyNotEnabled`, `bebopJamQuoteDeclined`, `bebopTokenUnavailable`, `relayCurrencyUnsupported`, `relaySwapImpactTooHigh`, `tetrafiSolverCallbackNotAuthorized`, `tradingLinkSnapshotChanged`, `tradingLinkSnapshotUnavailable`, `uniswapChainReadUnavailable`, `uniswapInsufficientDepth`, `uniswapQuoteUnreadable`, `uniswapUnwrapAboveDailyCap`, `uniswapUnwrapAboveTradeCap`, `uniswapRouteNotGranted`, `venueNotEnabled`, `askLimitReached`, `balanceMeaningUnconfirmed`, `bebopJamWalletUnsupported`, `bebopQuorumWalletTooSlow`, `bebopWalletQuorumUnreadable`, `connectionNotConfigured`, `deliveryAccountNetworkUnavailable`, `deliveryAccountUnavailable`, `destinationCannotSendOnChain`, `dexReferencePriceUnavailable`, `firmQuoteLimited`, `fundingAccountNetworkUnavailable`, `fundingAccountUnavailable`, `insufficientDepth`, `missingPermission`, `needsNativeGas`, `needsWallet`, `notPriced`, `payInTermsUnavailable`, `pilotTradeCapExceeded`, `platformFeeRateUnavailable`, `pricingBookPairUnserved`, `settlementDeclarationUnavailable`, `settlementNotAvailable`, `timedOut`, `timedOutBeforeSend`, `tradingSourceNetworkUnavailable`, `tradingSourceNotLinked`, `venueEnablementRechecking`, `venueEnablementUnavailable`, `venueListingTimedOut`, `venuePoliciesUnavailable`. New values may be added; treat unknown values as other. type: - string - 'null' remediation: description: A machine-readable recovery hint the refusing step gave. type: - string - 'null' retryAfter: oneOf: - type: 'null' - $ref: '#/components/schemas/IsoDuration' description: >- Every `429`, and a `503` that knows: when to try again, as an ISO 8601 duration. The `Retry-After` header carries the same wait in whole seconds. value: description: >- `UNKNOWN_ASSET`, `UNKNOWN_CHAIN`, `UNKNOWN_VENUE`, `INVALID_AMOUNT`: the value refused; `ASSET_NOT_ON_CHAIN`: the pinned chain the Asset is not on. type: - string - 'null' type: object QuoteNextAction: description: |- The one action the caller takes next; later legs run under the order. New values may be added; treat unknown values as other. discriminator: propertyName: kind oneOf: - description: '`POST /orders {quoteId}`.' properties: kind: description: New values may be added; treat unknown values as other. enum: - order type: string x-extensible-enum: true required: - kind type: object - description: >- `POST /orders/preflight`: the held terms may need an approval, allowance or receipt the server cannot confirm from memory. Its response carries the next step. properties: kind: description: New values may be added; treat unknown values as other. enum: - preflight type: string x-extensible-enum: true required: - kind type: object - description: Send these transactions, then order. properties: kind: description: New values may be added; treat unknown values as other. enum: - transact type: string x-extensible-enum: true transactions: items: $ref: '#/components/schemas/TakerTransaction' type: array required: - transactions - kind type: object - description: Sign this EIP-712 document, then order. properties: kind: description: New values may be added; treat unknown values as other. enum: - sign type: string x-extensible-enum: true typedData: {} required: - typedData - kind type: object - description: >- Fund, then requote. `null` instructions when they could not be read; no order is accepted while short either way. properties: instructions: oneOf: - type: 'null' - $ref: '#/components/schemas/FundInstructions' kind: description: New values may be added; treat unknown values as other. enum: - fund type: string x-extensible-enum: true required: - kind type: object - description: Ask the venue again, with these Binding slots filled. properties: kind: description: New values may be added; treat unknown values as other. enum: - requote type: string x-extensible-enum: true needs: items: $ref: '#/components/schemas/RequoteNeed' type: array required: - needs - kind type: object - description: >- Search again: `POST /quotes` with a pair body. The quote is past its requote window, so `{requote: quoteId}` can no longer refresh it. properties: kind: description: New values may be added; treat unknown values as other. enum: - search type: string x-extensible-enum: true required: - kind type: object - description: >- The venue outcome is being reconciled. Read this same order again after the given ISO 8601 duration; never submit a replacement order. properties: kind: description: New values may be added; treat unknown values as other. enum: - wait type: string x-extensible-enum: true retryAfter: $ref: '#/components/schemas/IsoDuration' required: - retryAfter - kind type: object - description: Contact support with this non-secret order reference. properties: kind: description: New values may be added; treat unknown values as other. enum: - contact type: string x-extensible-enum: true reference: type: string required: - reference - kind type: object x-extensible-enum: true SanctionsScreeningState: description: >- A name and jurisdiction screening state. Only clear is clear: unscreened (no verdict recorded) and pending (no current verdict, for example after a name change) both block value movement. New values may be added; treat unknown values as other. enum: - unscreened - pending - clear - flagged type: string x-extensible-enum: true CapabilityBlocker: description: One reason a capability is blocked, plus the step that unlocks it. properties: code: $ref: '#/components/schemas/CapabilityBlockerCode' currentlyDue: description: |- Requirement keys still due, such as `kyb_review`, `actor_kyc` or `permission:place_order`. Empty when nothing specific is due. items: type: string type: array estimate: $ref: '#/components/schemas/CapabilityUnlockEstimate' message: type: string unlockStep: $ref: '#/components/schemas/CapabilityUnlockStep' description: >- Stable key of the step that unlocks this blocker. The UI maps it to a route or dialog. required: - code - message - unlockStep - estimate type: object GeoSourceKind: description: |- Where the request-geo fact comes from. `none` means no trusted source is configured in this zone, so no geo restriction is enforced (and nothing may claim it is). New values may be added; treat unknown values as other. enum: - edge_header - none type: string x-extensible-enum: true ScreeningProviderKind: description: >- The wallet-address screening provider this environment runs. unconfigured means none, and value-moving capabilities refuse with SCREENING_UNAVAILABLE. New values may be added; treat unknown values as other. enum: - chainalysis - sanctions_lists - mock - unconfigured type: string x-extensible-enum: true KybRecordObservation: description: |- Permission-filtered observation of the workspace's KYB record. New values may be added; treat unknown values as other. oneOf: - description: This workspace type carries no KYB record, such as a direct user. properties: state: description: New values may be added; treat unknown values as other. enum: - not_applicable type: string x-extensible-enum: true required: - state type: object - description: >- Withheld from this reader. KYB dates and review facts are released only to a signed-in member with compliance view permission; an API key always reads withheld. workspace.kybStatus still carries the KYB state. properties: state: description: New values may be added; treat unknown values as other. enum: - withheld type: string x-extensible-enum: true required: - state type: object - description: >- A KYB-bearing workspace has no business profile; KYB has not started. properties: state: description: New values may be added; treat unknown values as other. enum: - absent type: string x-extensible-enum: true required: - state type: object - description: >- The workspace's business profile could not be read, so its KYB facts are unknown; never read as absent. Retry shortly. properties: state: description: New values may be added; treat unknown values as other. enum: - unavailable type: string x-extensible-enum: true required: - state type: object - allOf: - $ref: '#/components/schemas/KybRecordFacts' description: The business profile's recorded KYB facts. - properties: state: description: New values may be added; treat unknown values as other. enum: - recorded type: string x-extensible-enum: true required: - state type: object description: The business profile's recorded KYB facts. x-extensible-enum: true IsoDuration: description: An ISO 8601 duration, e.g. PT3S or PT2M. examples: - PT120S format: duration pattern: >- ^PT(?:[0-9]+H(?:[0-9]+M)?(?:[0-9]+(?:\.[0-9]{1,3})?S)?|[0-9]+M(?:[0-9]+(?:\.[0-9]{1,3})?S)?|[0-9]+(?:\.[0-9]{1,3})?S)$ type: string TakerTransaction: description: One transaction the Taker sends itself (an approval included). properties: chain: $ref: '#/components/schemas/Caip2Chain' data: description: Hex calldata (`0x…`). type: string to: type: string value: description: Native value in base units, as a decimal string. type: string required: - chain - data - to - value type: object FundInstructions: description: >- What to fund and how. Bank funding carries only a privacy-safe summary and a non-bearer reference to the separately authorized reveal read. New values may be added; treat unknown values as other. discriminator: propertyName: kind oneOf: - properties: address: type: string asset: type: string chainRef: type: string expiresAt: format: date-time type: string kind: description: New values may be added; treat unknown values as other. enum: - venueDeposit type: string x-extensible-enum: true memo: type: - string - 'null' networkCode: type: string networkConfirmed: description: >- False when the venue reports no network for this address: `networkCode` is empty and `chainRef` is the caller's selection, which the customer must confirm with the venue before sending. type: boolean observedAt: format: date-time type: string tokenContract: type: string required: - asset - chainRef - networkCode - networkConfirmed - address - tokenContract - observedAt - expiresAt - kind type: object - description: >- The only bank-deposit payload allowed in an asset-pair quote, request readback or copied durable/evidence body. It carries no receiving coordinates or payment memo. Fund, then explicitly requote; this summary never authorizes a transfer or order. properties: accountLast4: oneOf: - type: 'null' - $ref: '#/components/schemas/BankAccountSuffix' description: >- An already-qualified masked suffix, not external account ownership proof. amount: $ref: '#/components/schemas/DecimalAmount' bankDisplayName: type: - string - 'null' expiresAt: description: >- UTC ISO instant, or null when expiry is UNKNOWN. Null never means no expiry. format: date-time type: - string - 'null' kind: description: New values may be added; treat unknown values as other. enum: - bankDeposit type: string x-extensible-enum: true revealRef: $ref: '#/components/schemas/BankFundingRevealRef' required: - accountLast4 - amount - bankDisplayName - expiresAt - kind - revealRef type: object - description: >- The quote's own bound pay wallet (an organisation wallet on a Basic on-chain venue account) holds less than the trade debits: send `amount` of `asset` to `address` on `chain`, then get a new price. `walletId` is the binding target the source's `topUp` fix names; `tokenContract` is the registry's deployment address of `asset` on `chain` (the zero address for the chain's native coin). properties: address: type: string amount: $ref: '#/components/schemas/DecimalAmount' asset: $ref: '#/components/schemas/AssetId' chain: $ref: '#/components/schemas/Caip2Chain' kind: description: New values may be added; treat unknown values as other. enum: - walletTopUp type: string x-extensible-enum: true tokenContract: type: string walletId: type: string required: - walletId - address - chain - asset - tokenContract - amount - kind type: object - description: Native gas for a transaction the Taker sends itself. properties: amount: $ref: '#/components/schemas/DecimalAmount' asset: $ref: '#/components/schemas/AssetId' chain: $ref: '#/components/schemas/Caip2Chain' kind: description: New values may be added; treat unknown values as other. enum: - nativeGas type: string x-extensible-enum: true required: - chain - amount - asset - kind type: object - description: >- A bank-funded venue account is short and deposit first isn't offered on it: its bank side declares no deposit instructions, or nothing that credits a declared deposit. The account is funded from its own funding details, then the quote is asked again. `amount` is the shortfall in `currency`; `connectionId` is the venue account to fund; `reason` is the venue's declared sentence for why ("Keyrock gives no deposit reference for bank transfers, so TetraFi can't tell your deposit apart"), product copy without a final period. properties: amount: $ref: '#/components/schemas/DecimalAmount' connectionId: type: string currency: type: string kind: description: New values may be added; treat unknown values as other. enum: - depositFirstNotOffered type: string x-extensible-enum: true reason: type: string required: - connectionId - amount - currency - reason - kind type: object x-extensible-enum: true RequoteNeed: description: >- A Binding slot a requote needs filled. An empty `needs` means requote as is. New values may be added; treat unknown values as other. enum: - wallet:evm - wallet:solana - wallet:tron - account - bankAccount - deliverTo type: string x-extensible-enum: true CapabilityBlockerCode: description: |- Stable machine-readable blocker codes returned by the capability gate. New values may be added; treat unknown values as other. enum: - WORKSPACE_NOT_FOUND - WORKSPACE_NOT_ACTIVE - WORKSPACE_SUSPENDED - PARENT_WORKSPACE_INACTIVE - INSUFFICIENT_PERMISSION - WORKSPACE_TYPE_UNSUPPORTED - BASE_PROFILE_INCOMPLETE - BASE_PROFILE_UNREADABLE - KYB_NOT_VERIFIED - KYC_NOT_VERIFIED - SANCTIONS_FLAGGED - MEMBER_COMPLIANCE_FROZEN - MEMBER_COMPLIANCE_DENIED - SCREENING_PENDING - SCREENING_UNAVAILABLE - GEO_RESTRICTED - WALLET_NOT_VERIFIED - DIRECT_USER_NOT_FOUND - DIRECT_USER_SUSPENDED - DIRECT_USER_KYC_NOT_VERIFIED - INSUFFICIENT_SCOPE - TREASURY_DISABLED - NO_USABLE_CREDENTIAL - CROSS_OWNER_WRITE_DENIED - AGGREGATE_SCOPE_READ_ONLY - OWNER_SCOPE_REQUIRED - VENUE_OPERATION_UNSUPPORTED - TAKER_ONBOARDING_INCOMPLETE - TAKER_ADMISSION_UNAVAILABLE type: string x-extensible-enum: true CapabilityUnlockEstimate: description: >- Coarse time-to-unlock class. The UI owns the copy; figures are engineering estimates until the KYB queue and Sumsub webhooks supply measured values. New values may be added; treat unknown values as other. enum: - minutes - forms_then_review - admin_action - other_party - unknown - not_unlockable type: string x-extensible-enum: true CapabilityUnlockStep: description: |- Stable key for the step that unlocks a blocked capability. The backend names the step; the UI owns the step-to-route map. Never a UI route. New values may be added; treat unknown values as other. enum: - finish_onboarding - company_details - kyb_profile - kyc_dialog - link_wallet - ask_admin - contact_broker - manage_direct_users - manage_api_key - connect_custodian - switch_account_scope - contact_support - await_screening - none type: string x-extensible-enum: true KybRecordFacts: description: >- Recorded KYB approval dates and the independently observed active review. properties: expiresAt: format: date-time type: - string - 'null' review: oneOf: - type: 'null' - $ref: '#/components/schemas/KybReviewObservation' description: The workspace's active KYB review, when there is one. verifiedAt: format: date-time type: - string - 'null' type: object Caip2Chain: description: >- A CAIP-2 chain id (`eip155:8453`, `solana:`, `tron:shasta`), syntax-checked: a namespace of 3 to 8 lowercase letters, digits or `-`, and a reference of 1 to 32 letters, digits, `-` or `_`. Compared exactly, as CAIP-2 references are case-sensitive. example: eip155:8453 type: string BankAccountSuffix: description: >- An already-qualified masked account suffix of 1 to 4 ASCII letters/digits, not external account ownership proof. Never truncate a full account number. examples: - A1b2 maxLength: 4 minLength: 1 pattern: ^[A-Za-z0-9]{1,4}$ type: string DecimalAmount: description: >- A non-negative decimal string in Asset units (`"10000"`, `"9994.0"`): digits with an optional fraction, no sign, exponent or leading zero. Never a float and never base units. A request amount must also be positive (`INVALID_AMOUNT`); a fee or a known balance may be zero. example: '10000' type: string BankFundingRevealRef: description: >- Non-bearer lookup metadata for deposit instructions. Possession grants no authority. Each reveal requires current wallet-view authority and exact account membership; an API key additionally needs treasury_read. Missing and foreign accounts share a refusal. Quotes never fetch these instructions. properties: connectionId: description: >- The native held leg's exact connection id, never a first/sole-connection guess. type: string currency: type: string providerBankId: description: >- The provider's linked-bank id when required by that venue; otherwise unknown/null. type: - string - 'null' required: - connectionId - currency - providerBankId type: object AssetId: description: >- A registry Asset id (`USDC`, `USDe`). Matched case-insensitively against the catalogue, which answers it in the registry's own spelling. example: USDC type: string KybReviewObservation: description: |- Whether the active KYB review read found a record or was unavailable. New values may be added; treat unknown values as other. oneOf: - description: The read succeeded with no review in flight or on record as active. properties: state: description: New values may be added; treat unknown values as other. enum: - none type: string x-extensible-enum: true required: - state type: object - allOf: - $ref: '#/components/schemas/KybReviewFacts' description: The active review's recorded queue facts. - properties: state: description: New values may be added; treat unknown values as other. enum: - recorded type: string x-extensible-enum: true required: - state type: object description: The active review's recorded queue facts. - description: The read failed; never interpreted as no review. properties: state: description: New values may be added; treat unknown values as other. enum: - unavailable type: string x-extensible-enum: true required: - state type: object x-extensible-enum: true KybReviewFacts: description: >- An active KYB review's queue facts. Reviewer notes, reviewer identity and provider references are never included. properties: decidedAt: format: date-time type: - string - 'null' queueId: format: uuid type: string reason: $ref: '#/components/schemas/RenewalReason' status: $ref: '#/components/schemas/ApprovalStatus' submittedAt: format: date-time type: string required: - queueId - status - reason - submittedAt type: object RenewalReason: description: >- Why a KYB review was opened: the initial review, an expiry, an operator request or a compliance review. New values may be added; treat unknown values as other. enum: - expiry - operator_requested - compliance_review - initial type: string x-extensible-enum: true ApprovalStatus: description: >- Status of a KYB review: pending, under_review, approved, rejected or expired. New values may be added; treat unknown values as other. enum: - pending - under_review - approved - rejected - expired type: string x-extensible-enum: true securitySchemes: api_key: description: >- Send the API key in `X-API-Key`. **Request signing.** A key with signing enabled (`POST /api/v1/workspaces/{workspaceId}/users/me/api-keys/{keyId}/signing`, which returns the signing secret once) must also sign every request: - `X-Timestamp`: the current Unix time in seconds, within 300 seconds of the server clock. - `X-Signature`: lower-case hex HMAC-SHA256 of the canonical string, keyed with the signing secret's 32 bytes (the secret is 64 hex characters; decode it first). The canonical string is four lines joined by `\n`, with no trailing newline: the `X-Timestamp` value, the upper-case method, the path with its query exactly as sent (`/api/v1/orders?limit=1`), and the lower-case hex SHA-256 of the exact body bytes (the SHA-256 of an empty body when there is none). A write's signature (POST, PUT, PATCH, DELETE) is accepted once: sending the same signed write again is refused, so a retry signs again. A read (GET, HEAD) changes nothing, so an identical signed read inside the window is admitted again and polling needs no nonce. A signing refusal is a 401 `AUTH_REQUIRED` whose `details.reason` names the cause: `SIGNATURE_REQUIRED` (a header is missing), `SIGNATURE_INVALID` (a malformed header or a wrong signature), `TIMESTAMP_OUT_OF_RANGE` or `SIGNATURE_REPLAYED`. in: header name: X-API-Key type: apiKey x-request-signing: algorithm: HMAC-SHA256 canonicalRequest: - timestamp - method - pathWithQuery - bodySha256Hex canonicalSeparator: |+ oneTimeMethods: - POST - PUT - PATCH - DELETE refusal: error: AUTH_REQUIRED reasons: - SIGNATURE_REQUIRED - SIGNATURE_INVALID - TIMESTAMP_OUT_OF_RANGE - SIGNATURE_REPLAYED status: 401 secretEncoding: hex signatureEncoding: hex-lower signatureHeader: X-Signature timestampHeader: X-Timestamp timestampWindowSeconds: 300 bearer_auth: bearerFormat: JWT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.