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

# Update a broker credential

> Replaces the encrypted broker credential payload in WorkOS Vault and touches the credential metadata timestamp. Only organization admins can update credentials. Paper credentials are allowed for admins; live credentials additionally require the Trading Live entitlement. The trading-account id must match the credential's trading account.



## OpenAPI

````yaml /api-reference/credentials.openapi.json patch /v1/trading-accounts/{trading_account_id}/credentials/{credential_id}
openapi: 3.1.0
info:
  title: credentials
  description: ''
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://api.anthid.com
    description: Production
security: []
tags:
  - name: Credentials
    description: Trading-account metadata and lifecycle operations
  - name: Credentials
    description: >-
      Broker credential creation, metadata, secret access, and lifecycle
      operations
paths:
  /v1/trading-accounts/{trading_account_id}/credentials/{credential_id}:
    patch:
      tags:
        - Credentials
      summary: Update a broker credential
      description: >-
        Replaces the encrypted broker credential payload in WorkOS Vault and
        touches the credential metadata timestamp. Only organization admins can
        update credentials. Paper credentials are allowed for admins; live
        credentials additionally require the Trading Live entitlement. The
        trading-account id must match the credential's trading account.
      operationId: updateCredential
      parameters:
        - name: trading_account_id
          in: path
          description: Trading account id that owns the credential
          required: true
          schema:
            type: string
            format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        - name: credential_id
          in: path
          description: Broker credential id to update
          required: true
          schema:
            type: string
            format: uuid
          example: 550e8400-e29b-41d4-a716-446655440111
      requestBody:
        description: >-
          Replacement broker-specific credential payload. Lightspeed and Alpaca
          credentials are currently supported.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrokerCredentialVariant'
            example:
              Lightspeed:
                account_id: LS-123456
                api_key: lightspeed-api-key
                environment: paper
        required: true
      responses:
        '204':
          description: Credential updated
        '400':
          description: >-
            Credential payload is invalid, broker type is unsupported, or
            trading account id does not match the credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Caller is not an organization admin or lacks the required
            live-trading entitlement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No credential exists for the provided ids
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Caller exceeded the request rate limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error while updating the credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    BrokerCredentialVariant:
      oneOf:
        - type: object
          required:
            - Lightspeed
          properties:
            Lightspeed:
              $ref: '#/components/schemas/LightspeedCredential'
        - type: object
          required:
            - Alpaca
          properties:
            Alpaca:
              $ref: '#/components/schemas/AlpacaCredential'
        - type: string
          enum:
            - Unspecified
    Error:
      oneOf:
        - type: object
          required:
            - EncryptionError
          properties:
            EncryptionError:
              type: string
        - type: object
          required:
            - WorkOsError
          properties:
            WorkOsError:
              type: string
        - type: object
          required:
            - KvError
          properties:
            KvError:
              type: string
        - type: object
          required:
            - StreamError
          properties:
            StreamError:
              type: string
        - type: object
          required:
            - InternalError
          properties:
            InternalError:
              type: string
        - type: object
          required:
            - ThirdPartyError
          properties:
            ThirdPartyError:
              type: string
        - type: object
          required:
            - ParseError
          properties:
            ParseError:
              type: string
        - type: object
          required:
            - NotFound
          properties:
            NotFound:
              type: string
        - type: object
          required:
            - AlreadyExists
          properties:
            AlreadyExists:
              type: string
        - type: object
          required:
            - BadRequest
          properties:
            BadRequest:
              type: string
        - type: object
          required:
            - Forbidden
          properties:
            Forbidden:
              type: string
        - type: object
          required:
            - Unauthorized
          properties:
            Unauthorized:
              type: string
        - type: object
          required:
            - Database
          properties:
            Database:
              type: string
        - type: object
          required:
            - TooManyRequests
          properties:
            TooManyRequests:
              type: string
        - type: object
          required:
            - BrokerError
          properties:
            BrokerError:
              type: string
        - type: object
          required:
            - AuthError
          properties:
            AuthError:
              type: string
        - type: object
          required:
            - InvalidInput
          properties:
            InvalidInput:
              type: string
        - type: object
          required:
            - ConnectionLimitExceeded
          properties:
            ConnectionLimitExceeded:
              type: string
    LightspeedCredential:
      type: object
      required:
        - account_id
        - environment
        - api_key
      properties:
        account_id:
          type: string
        api_key:
          type: string
        environment:
          $ref: '#/components/schemas/BrokerEnvironment'
    AlpacaCredential:
      type: object
      required:
        - environment
        - api_key_id
        - api_key_secret
      properties:
        api_key_id:
          type: string
        api_key_secret:
          type: string
        environment:
          $ref: '#/components/schemas/BrokerEnvironment'
    BrokerEnvironment:
      type: string
      enum:
        - paper
        - live
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````