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

# Merchant Connect

> Initiate merchant onboarding. Called by e-commerce platform plugins (WooCommerce, Medusa, etc.) to start the connect flow. Creates a session in Redis and redirects the merchant to the BKey approval page where they prove their identity with biometric approval. No authentication required — this endpoint is part of the onboarding handshake.



## OpenAPI

````yaml get /v1/merchants/connect
openapi: 3.1.0
info:
  title: BKey API
  description: Biometric approval infrastructure for AI agents — OAuth 2.1 + CIBA
  version: 1.0.0
  contact:
    name: BKey
    url: https://bkey.id
    email: dev@bkey.id
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: https://api.bkey.id
    description: Production
security:
  - bearerAuth: []
tags:
  - name: OAuth
    description: OAuth 2.1 token, device auth, CIBA, revocation
  - name: Checkout
    description: Agent-initiated checkout with biometric approval
  - name: Vault
    description: Encrypted secret storage with biometric access
  - name: Payments
    description: Payment methods and shared payment tokens
  - name: Identity
    description: DID and identity management
paths:
  /v1/merchants/connect:
    get:
      tags:
        - Payments
      summary: Merchant Connect
      description: >-
        Initiate merchant onboarding. Called by e-commerce platform plugins
        (WooCommerce, Medusa, etc.) to start the connect flow. Creates a session
        in Redis and redirects the merchant to the BKey approval page where they
        prove their identity with biometric approval. No authentication required
        — this endpoint is part of the onboarding handshake.
      parameters:
        - schema:
            type: string
            format: uri
          in: query
          name: store_url
          required: true
        - schema:
            type: string
            enum:
              - woocommerce
              - shopify
              - medusa
              - bigcommerce
            default: woocommerce
          in: query
          name: platform
          required: false
        - schema:
            type: string
          in: query
          name: return_url
          required: false
      responses:
        '302':
          description: >-
            Redirect to the BKey approval page. The client must follow the
            Location header to complete the merchant onboarding handshake.
          headers:
            Location:
              description: URL to redirect the client to.
              schema:
                type: string
                format: uri
        '400':
          description: Invalid store_url, unsupported platform, or SSRF rejection
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code
                      message:
                        type: string
                        description: Human-readable error message
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - success
                  - error
                additionalProperties: false
                description: Invalid store_url, unsupported platform, or SSRF rejection
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: EdDSA-signed JWT obtained via OAuth 2.1 client_credentials or CIBA

````