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

# Get the customer-account requirement

> Requires a user API key and access to the selected AI and transaction.



## OpenAPI

````yaml /openapi-v2.json get /act/transactions/{transactionId}/account-requirement
openapi: 3.1.0
info:
  title: Darwin API v2
  version: 2.0.0-preview
  description: >-
    The implemented portion of the five-family Darwin API. Operations are added
    only after runtime and contract verification.
servers:
  - url: https://api.darwin.so/api/v2
    description: Production — use live `darwin_…` keys.
  - url: https://api.dev.darwin.so/api/v2
    description: Sandbox — use isolated `darwin_test_…` keys.
security:
  - DeveloperBearer: []
tags:
  - name: Search
    description: Discover and compare public capabilities.
  - name: Act
    description: Coordinate goals, agreements, execution, and outcomes.
  - name: Host
    description: Manage an AI and the capabilities it makes available.
  - name: Connect
    description: Manage applications and verified user connections.
  - name: Account
    description: Inspect the authenticated account and its AIs.
paths:
  /act/transactions/{transactionId}/account-requirement:
    get:
      tags:
        - Act
      summary: Get the customer-account requirement
      description: Requires a user API key and access to the selected AI and transaction.
      operationId: getActTransactionAccountRequirement
      parameters:
        - name: transactionId
          in: path
          required: true
          schema:
            type: string
        - name: aiId
          in: query
          description: >-
            Optional explicit AI scope. When omitted, Darwin uses the caller’s
            selected AI.
          schema:
            type: string
      responses:
        '200':
          description: The post-funding external-account requirement.
          content:
            application/json:
              schema:
                type: object
                required:
                  - accountRequirement
                properties:
                  accountRequirement:
                    $ref: '#/components/schemas/TransactionAccountRequirement'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The bearer key is missing, invalid, expired, or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The principal does not have the required scope or resource access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The resource was not found for this principal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    TransactionAccountRequirement:
      type: object
      additionalProperties: false
      required:
        - transactionId
        - transactionStatus
        - requirement
        - providerKey
        - requiredScopes
        - allowedRetention
        - status
        - missingScopes
      properties:
        transactionId:
          type: string
        transactionStatus:
          type: string
        requirement:
          type: string
          enum:
            - NONE
            - OPTIONAL
            - REQUIRED
        providerKey:
          type:
            - string
            - 'null'
        requiredScopes:
          type: array
          items:
            type: string
        allowedRetention:
          type: array
          items:
            type: string
            enum:
              - REQUEST_ONLY
              - SAVED_WITH_CONSENT
        status:
          type: string
          enum:
            - NOT_REQUIRED
            - OPTIONAL_MISSING
            - REQUIRED
            - AUTHORIZED
        missingScopes:
          type: array
          items:
            type: string
    Error:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        error:
          type: string
  securitySchemes:
    DeveloperBearer:
      type: http
      scheme: bearer
      bearerFormat: Darwin API key
      description: >-
        Production keys begin with `darwin_`. Isolated sandbox keys begin with
        `darwin_test_`. Create keys in Developer settings.

````