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

# Start KYC

> Returns `needs_otp` until the email is verified. Does not reveal whether the email already has an approved customer.



## OpenAPI

````yaml /openapi.yaml post /api/integrations/breb/kyc
openapi: 3.1.0
info:
  title: COP By Integrations API
  version: 0.1.0
  description: |
    Non-custodial Celo API for partners. Prepare swaps and BRE-B COP payouts;
    the user signs from their wallet. Confirm with the transaction hash.
servers:
  - url: http://localhost:3000
    description: Local Next.js app
  - url: https://app.copby.co
    description: Production (replace if your origin differs)
security:
  - bearerAuth: []
tags:
  - name: BRE-B
    description: Quote, KYC, and COP payouts via Bridge Bre-B
  - name: Swaps
    description: Prepare and confirm onchain COPm swaps
  - name: Webhooks
    description: Bridge callbacks. Not authenticated with a partner key.
paths:
  /api/integrations/breb/kyc:
    post:
      tags:
        - BRE-B
      summary: Start KYC
      description: >-
        Returns `needs_otp` until the email is verified. Does not reveal whether
        the email already has an approved customer.
      operationId: startBrebKyc
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartKycRequest'
            example:
              userAddress: '0x2222222222222222222222222222222222222222'
              fullName: Ana Pérez
              email: ana@example.com
              redirectUri: https://partner.app/kyc-done
      responses:
        '200':
          description: Next KYC step
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycStatus'
        '400':
          $ref: '#/components/responses/BrebError'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    StartKycRequest:
      type: object
      required:
        - userAddress
        - fullName
        - email
      properties:
        userAddress:
          $ref: '#/components/schemas/Address'
        fullName:
          type: string
        email:
          type: string
          format: email
        redirectUri:
          type: string
          format: uri
    KycStatus:
      type: object
      properties:
        status:
          type: string
          enum:
            - needs_otp
            - needs_kyc
            - approved
        kycLink:
          type: string
        tosLink:
          type: string
    Address:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x2222222222222222222222222222222222222222'
    ErrorBody:
      type: object
      properties:
        error:
          type: string
        errorCode:
          type: string
          enum:
            - below_minimum
            - needs_kyc
            - destination_mismatch
            - requote
            - tx_hash_reused
            - otp_invalid
            - mercado_cerrado
            - invalid_webhook_signature
  responses:
    BrebError:
      description: API error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    Unauthorized:
      description: Missing or invalid integration API key
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Integration API key. Send as `Bearer copby_live_pk_…`.

````