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

# Create a CEX account connection

> Requires `account:write` and `Idempotency-Key`. Credentials are encrypted and are never returned. `requested_permissions` is the user's declaration and execution switch; `withdraw` must be false. A declared permission that the connector cannot inspect remains unknown rather than denied, and the provider makes the final check when that capability is used.



## OpenAPI

````yaml /openapi/portfobit-openapi.yaml post /accounts
openapi: 3.1.0
info:
  title: Portfobit Open API
  version: 0.1.0
  description: >
    Public REST API for direct API clients, CI, scripts, service accounts,
    third-party agents, and developer integrations.

    Public REST requests use scoped Portfobit Open API keys. OAuth access tokens
    issued for the Portfobit MCP resource are not accepted by `/api/v1/*`
    endpoints.

    Portfobit is crypto-CEX-only. Financial values are decimal strings and
    timestamps are RFC 3339 UTC strings.

    The API never supports withdrawals, external-address transfers,
    cross-exchange transfers, or P2P transfers.
servers:
  - url: https://api.portfobit.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Context
  - name: Accounts
  - name: Portfolios
  - name: Valuation
  - name: Activity
  - name: Trading
  - name: Market data
  - name: Support
paths:
  /accounts:
    post:
      tags:
        - Accounts
      summary: Create a CEX account connection
      description: >-
        Requires `account:write` and `Idempotency-Key`. Credentials are
        encrypted and are never returned. `requested_permissions` is the user's
        declaration and execution switch; `withdraw` must be false. A declared
        permission that the connector cannot inspect remains unknown rather than
        denied, and the provider makes the final check when that capability is
        used.
      operationId: createAccountConnection
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        $ref: '#/components/requestBodies/CreateAccountRequest'
      responses:
        '201':
          $ref: '#/components/responses/AccountResponse'
        '400':
          $ref: '#/components/responses/InvalidConnectorIdResponse'
        '404':
          $ref: '#/components/responses/ConnectorNotFoundResponse'
        '409':
          $ref: '#/components/responses/AccountCreationConflictResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 255
      description: Opaque retry key, unique to the same user, method, and path.
  requestBodies:
    CreateAccountRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateAccountRequest'
  responses:
    AccountResponse:
      description: Account response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountResponseSchema'
    InvalidConnectorIdResponse:
      description: The connector ID is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InvalidConnectorIdResponseSchema'
    ConnectorNotFoundResponse:
      description: The referenced connector does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConnectorNotFoundResponseSchema'
    AccountCreationConflictResponse:
      description: >-
        Account creation conflict: connector unavailable, duplicate name or
        connection, idempotency conflict, or plan capacity reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountCreationConflictResponseSchema'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    CreateAccountRequest:
      type: object
      required:
        - name
        - connector_id
        - credentials
      properties:
        name:
          type: string
        connector_id:
          type: string
        requested_permissions:
          $ref: '#/components/schemas/Permissions'
        tags:
          type: array
          items:
            type: string
        credentials:
          type: object
          additionalProperties:
            type: string
          writeOnly: true
      additionalProperties: false
    AccountResponseSchema:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          required:
            - id
            - connector_id
            - name
            - venue
            - market_type
            - tags
            - portfolio_ids
            - api_key_masked
            - requested_permissions
            - inspectable_permissions
            - permission_status
            - permission_issue_code
            - status
            - subscription_access
            - last_synced_at
            - created_at
            - updated_at
          properties:
            id:
              type: string
            connector_id:
              type: string
            name:
              type: string
            venue:
              type: string
            market_type:
              type: string
            tags:
              type: array
              items:
                type: string
            portfolio_ids:
              type: array
              items:
                type: string
            api_key_masked:
              type: string
            requested_permissions:
              type: object
              required:
                - read
                - trade
                - transfer
                - withdraw
              properties:
                read:
                  type: boolean
                trade:
                  type: boolean
                transfer:
                  type: boolean
                withdraw:
                  type: boolean
            permission_status:
              type: string
              enum:
                - unknown
                - checking
                - verified
                - partially_verified
                - unverified
                - mismatch
                - invalid
                - check_failed
              description: >-
                Aggregate permission verification result. `partially_verified`
                means every inspectable capability is known and matches the
                user's declaration, while the connector cannot inspect all four
                capabilities; it is an informational coverage limitation, not a
                credential failure.
            permission_issue_code:
              type:
                - string
                - 'null'
            inspectable_permissions:
              type: array
              description: >-
                Capabilities covered by the latest permission check. This is
                verification coverage and does not reveal which permissions the
                API key has.
              items:
                type: string
                enum:
                  - read
                  - trade
                  - transfer
                  - withdraw
            status:
              type: string
            subscription_access:
              type: string
            last_synced_at:
              type: string
              format: date-time
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
        meta:
          type: object
          required:
            - request_id
            - generated_at
          properties:
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        data:
          id: acc_01H8XFK9A
          connector_id: con_binance
          name: Binance_Main
          venue: binance
          market_type: crypto
          tags:
            - Long_Term
          portfolio_ids:
            - pf_01J2K7M9N3
          api_key_masked: VMx8_ellipsis_9Lp2
          requested_permissions:
            read: true
            trade: false
            transfer: false
            withdraw: false
          permission_status: verified
          permission_issue_code: null
          inspectable_permissions:
            - read
            - trade
            - transfer
            - withdraw
          status: active
          subscription_access: available
          last_synced_at: '2026-08-07T08:00:00Z'
          created_at: '2026-08-01T00:00:00Z'
          updated_at: '2026-08-07T08:00:00Z'
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-07T08:00:01Z'
    InvalidConnectorIdResponseSchema:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              required: []
              properties: {}
        meta:
          type: object
          required:
            - request_id
            - generated_at
          properties:
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        error:
          code: invalid_connector_id
          message: Connector ID is invalid.
          details: {}
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-08T08:00:00Z'
    ConnectorNotFoundResponseSchema:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              required:
                - connector_id
              properties:
                connector_id:
                  type: string
        meta:
          type: object
          required:
            - request_id
            - generated_at
          properties:
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        error:
          code: connector_not_found
          message: Connector not found.
          details:
            connector_id: con_unknown
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-08T08:00:00Z'
    AccountCreationConflictResponseSchema:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - connector_unavailable
                - duplicate_account_name
                - duplicate_account_connection
                - idempotency_conflict
                - plan_limit_reached
            message:
              type: string
            details:
              type: object
              required: []
              properties:
                resource_type:
                  type: string
                used:
                  type: integer
                limit:
                  type: integer
                current_plan:
                  type: string
                required_plan:
                  type: string
                upgrade_available:
                  type: boolean
        meta:
          type: object
          required:
            - request_id
            - generated_at
          properties:
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        error:
          code: duplicate_account_connection
          message: This CEX credential is already connected.
          details: {}
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-08T08:00:00Z'
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Permissions:
      type: object
      description: >-
        User-declared CEX credential capabilities and execution switches. A
        capability outside a connector's `inspectable_permissions` remains
        unknown rather than denied; an explicit denial requires reliable
        provider evidence.
      required:
        - read
        - trade
        - transfer
        - withdraw
      properties:
        read:
          type: boolean
        trade:
          type: boolean
        transfer:
          type: boolean
        withdraw:
          type: boolean
          const: false
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
    Meta:
      type: object
      required:
        - request_id
        - generated_at
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Portfobit Open API key

````

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