> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stableyard.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# List regulated capability readiness

> Read the readiness of each regulated capability activated on a UPA.

Returns the latest readiness for each regulated capability previously activated on the UPA. Act on `ready` and `nextAction`; do not infer provider state, and do not keep an expired hosted-action URL. An empty `capabilities` array means no regulated capability has been activated for the account.


## OpenAPI

````yaml openapi.json GET /v2/accounts/{accountId}/capabilities
openapi: 3.1.0
info:
  title: Stableyard Partner API
  version: 2.0.0-staging
  x-stableyard-api-version: '2026-09-09'
  x-stableyard-supported-api-versions:
    - '2026-09-09'
  summary: Backend API for UPAs, Payments, activity, and optional financial products.
  description: >

    Use this API from a trusted partner backend with an app ID and app secret.


    ## Recommended integration


    1. Call `GET /v2/partners/config` to verify credentials and discover enabled
    capabilities.

    2. Create a UPA only when your product needs a persistent Stableyard
    account.

    3. Create a receive or send Payment with `POST /v2/payments`.

    4. Redirect a payer to the returned `paymentUrl` or pass the Payment
    credentials to an official Stableyard interface SDK.

    5. Process signed webhooks and fetch the Payment by ID for reconciliation.


    Checkout execution and account-bound browser endpoints are intentionally
    documented in the separate Interfaces & SDKs reference. Console endpoints
    are dashboard implementation details and are not part of the partner
    integration contract.
  x-stableyard-documentation-surface: partner
servers:
  - url: https://prod-api.stableyard.fi
    description: Production
  - url: https://staging-api-v2.stableyard.fi
    description: Staging
  - url: http://localhost:3001
    description: Local
security: []
tags:
  - name: Authentication
    x-displayName: API authentication
    description: Verify your app ID and app secret before calling UPA APIs.
  - name: Accounts
    x-displayName: UPA Accounts
    description: Create Universal Payment Accounts and manage account settings.
  - name: Deposit Addresses
    description: Create reusable receive addresses and verify inbound deposits.
  - name: Identity & KYC
    description: >-
      Verify the UPA email and run provider-neutral identity verification.
      Managed vaults and fiat payment rails use this same verified UPA identity.
  - name: Vaults
    description: >-
      Create Safe/Zodiac controlled stablecoin vaults and manage policy updates
      for accounts.
  - name: Payments
    description: >-
      Create escrow-first payments, issue partner-authenticated send
      instructions or executions, power public checkout, and reconcile
      collection through final account settlement.
  - name: Balances & Transactions
    description: >-
      Read Stableyard-posted financial activity. Balances are ledger projections
      of activity Stableyard processed; they are not live balances of externally
      controlled wallets.
paths:
  /v2/accounts/{accountId}/capabilities:
    get:
      tags:
        - Identity & KYC
      summary: List regulated capability readiness
      description: >-
        Returns the latest provider-neutral readiness projection for each
        regulated capability previously activated on this UPA. Use `ready` and
        `nextAction`; do not infer provider state or retain an expired
        hosted-action URL. An empty `capabilities` array means no regulated
        capability has been activated for this account.
      operationId: listAccountComplianceCapabilities
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            type: string
            example: acct_123
          description: Canonical account id returned by the Accounts API.
        - name: Stableyard-Version
          in: header
          required: false
          schema:
            type: string
            enum:
              - '2026-09-09'
          description: >-
            Optional contract-version assertion. Omit it to use the app
            environment's pinned version. A different supported version is
            accepted only after that environment is explicitly migrated.
      responses:
        '200':
          description: Regulated capability readiness
          headers:
            Stableyard-Version:
              description: >-
                Effective date-based Stableyard API contract version for this
                response.
              schema:
                type: string
                enum:
                  - '2026-09-09'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceCapabilitiesResponse'
              examples:
                capabilities:
                  summary: One capability is ready and another is under review
                  value:
                    accountId: acct_123
                    capabilities:
                      - name: linked_bank
                        status: active
                        ready: true
                        nextAction:
                          type: none
                        updatedAt: '2026-09-10T12:00:00.000Z'
                      - name: bank_payout
                        status: provider_review
                        ready: false
                        nextAction:
                          type: wait_for_compliance_review
                        updatedAt: '2026-09-10T12:05:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '424':
          $ref: '#/components/responses/FailedDependency'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - partnerBasicAuth: []
components:
  schemas:
    ComplianceCapabilitiesResponse:
      type: object
      additionalProperties: false
      required:
        - accountId
        - capabilities
      properties:
        accountId:
          type: string
          pattern: ^acct_[A-Za-z0-9_-]+$
          example: acct_123
        capabilities:
          type: array
          maxItems: 3
          items:
            $ref: '#/components/schemas/ComplianceCapability'
    ComplianceCapability:
      type: object
      additionalProperties: false
      required:
        - name
        - status
        - ready
        - nextAction
        - updatedAt
      properties:
        name:
          type: string
          enum:
            - linked_bank
            - bank_payout
            - bank_onramp
        status:
          type: string
          enum:
            - action_required
            - submission_pending
            - provider_review
            - active
            - restricted
            - rejected
            - closed
            - requires_intervention
        ready:
          type: boolean
        nextAction:
          $ref: '#/components/schemas/ComplianceCapabilityNextAction'
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
          properties:
            code:
              type: string
              minLength: 1
              maxLength: 128
              example: bad_request
            message:
              type: string
              minLength: 1
              maxLength: 1000
              example: The request is invalid
            details: {}
    ComplianceCapabilityNextAction:
      description: The next provider-neutral action for this capability.
      oneOf:
        - title: Resume hosted business verification
          type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              const: continue_business_verification
          description: >-
            POST the original capability activation to obtain the current hosted
            link. Do not treat this action as approval.
        - title: Complete hosted compliance
          type: object
          additionalProperties: false
          required:
            - type
            - url
            - expiresAt
          properties:
            type:
              type: string
              const: complete_compliance
            url:
              type: string
              format: uri
              description: >-
                Secure verification URL for the account holder. Individual flows
                use a one-time Stableyard link; business flows use the
                provider-hosted KYB link. Do not log, cache or share this
                credential-bearing URL.
            expiresAt:
              type: string
              format: date-time
        - title: Wait for compliance review
          type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              const: wait_for_compliance_review
        - title: Compliance action already in progress
          type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              const: compliance_in_progress
        - title: Contact support
          type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              const: contact_support
        - title: No action required
          type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              const: none
  responses:
    BadRequest:
      description: Bad request
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: BadRequest response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    Unauthorized:
      description: Unauthorized
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: Unauthorized response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    Forbidden:
      description: The app secret does not include the required scope
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: Forbidden response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    NotFound:
      description: Not found
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: NotFound response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    Conflict:
      description: Conflict
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: Conflict response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    FailedDependency:
      description: Required chain, network, or provider configuration is missing
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: FailedDependency response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    TooManyRequests:
      description: >-
        Rate limit, payment-option limit, selection cooldown, or temporary abuse
        block
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
        Retry-After:
          description: Seconds until the caller should retry.
          schema:
            type: integer
            minimum: 1
        RateLimit-Limit:
          description: Quota for the most constrained policy.
          schema:
            type: integer
            minimum: 1
        RateLimit-Remaining:
          description: Requests remaining in that policy window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Seconds until that policy window resets.
          schema:
            type: integer
            minimum: 0
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: TooManyRequests response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
  securitySchemes:
    partnerBasicAuth:
      type: http
      scheme: basic
      description: >-
        HTTP Basic auth. Username is the Stableyard app ID. Password is the app
        secret. The optional Stableyard-Version request header must match the
        environment pin.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.