> ## 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.

# Get KYC status



## OpenAPI

````yaml /openapi.yaml get /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:
    get:
      tags:
        - BRE-B
      summary: Get KYC status
      operationId: getBrebKyc
      parameters:
        - $ref: '#/components/parameters/userAddressRequired'
      responses:
        '200':
          description: KYC status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    userAddressRequired:
      name: userAddress
      in: query
      required: true
      schema:
        $ref: '#/components/schemas/Address'
  schemas:
    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'
  responses:
    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_…`.

````