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

# Create a KYB link for a customer

> Company accounts only: generates a hosted KYB link for one of YOUR end customers (businesses). Bills the fixed `kyb_verification` fee when configured (refunded if creation fails); `idempotency_key` is required. `country` picks the wizard corridor: us, cl, ve, br, mx, co, pe, bo, py, ar or generic (send `generic_country` ISO alpha-2, optional `currency`).



## OpenAPI

````yaml /openapi.yaml post /v1/kyb/links
openapi: 3.1.0
info:
  title: CBPay API
  version: '1.89'
  description: |
    CBPay is a multi-currency payment platform: fiat payouts and collections
    across Latin America, internal transfers, on-chain funding and
    withdrawals, and KYC screening. Every account holds four independent
    virtual balances — USDT (the operating currency), USDC, BTC and GOLD
    (grams of fine gold) — that never mix or convert automatically.
    Payouts and service fees can be paid from any of the four balances:
    set a default with `PUT /v1/settlement` or override per payout with
    `settlement_asset`.

    All amounts are decimal strings in each currency's precision (6 decimals
    for USDT/USDC/GOLD, 8 for BTC). Errors always return
    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (production, real money)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, simulated money — pk_test_ keys)
security:
  - bearerAuth: []
tags:
  - name: Receipts
    description: >-
      Branded PDF receipt per operation, with a public signed-QR authenticity
      check, receipt_url on every response/webhook and automatic email delivery
      on final states.
  - name: Authentication
    description: Register and log in account members. Sessions last 24 hours.
  - name: Account
    description: Profile, members and API keys of the calling account.
  - name: Balances
    description: Balances, movement history and FX rates.
  - name: Payouts
    description: >-
      Fiat dispersals debited from the settlement balance of your choice (USDT
      by default).
  - name: Payins
    description: Fiat top-ups credited to the USDT balance.
  - name: Transfers
  - name: Contacts
  - name: Swaps
    description: >-
      Free internal transfers between CBPay accounts (person or company, any
      combination).
  - name: Crypto
    description: On-chain funding and withdrawals (TRON, Ethereum and Bitcoin).
  - name: Segregated wallets
    description: >-
      On-chain wallets with their own balance (companies unlimited; persons 1
      per network+asset pair) — create, import, send, export the private key and
      auto-forward. The balance lives on-chain, never in the ledger.
  - name: QR Crypto POS
    description: >-
      Amount-bearing crypto QR charges for processors with physical POS
      terminals (company accounts): verified merchants, exclusive address + QR
      per charge, early payment detection, per-merchant reconciliation and
      refunds over the crypto withdrawal rail.
  - name: KYC / KYB
  - name: AML screening
    description: >-
      Identity verification: KYC for persons, KYB for companies, with AML
      screening, rescreening and continuous monitoring.
  - name: Wallet screening
    description: >-
      AML risk assessment of blockchain addresses (sanctions, illicit-fund
      exposure) with a per-scan fee, plus free automatic protection on
      withdrawals and deposits.
  - name: Analytics
  - name: Webhooks
    description: Subscriptions to receive signed event notifications.
  - name: Status
    description: Service availability.
  - name: Banking
    description: >-
      Real bank accounts: receive, hold and send money over international
      banking rails.
  - name: Cards
    description: >-
      Virtual and physical cards that spend Just-In-Time from the account's USDT
      balance, with per-card spending limits.
  - name: Security (OTP)
    description: >-
      One-time verification codes over SMS/WhatsApp/email protecting sensitive
      actions, plus self-service 2FA preferences. Applies to user sessions only
      — API keys are exempt.
  - name: Passkeys
    description: >-
      Passwordless sign-in with the device's biometrics (Face ID, Touch ID,
      Windows Hello, security keys) via WebAuthn, authenticator apps (TOTP) with
      backup codes, and session/device management.
  - name: Social login
    description: >-
      Passwordless sign up and sign in with Google, Apple, Microsoft and
      Facebook via token exchange. The front end obtains the provider
      credential; the API verifies it and issues the CBPay session.
paths:
  /v1/kyb/links:
    post:
      tags:
        - KYC / KYB
      summary: Create a KYB link for a customer
      description: >-
        Company accounts only: generates a hosted KYB link for one of YOUR end
        customers (businesses). Bills the fixed `kyb_verification` fee when
        configured (refunded if creation fails); `idempotency_key` is required.
        `country` picks the wizard corridor: us, cl, ve, br, mx, co, pe, bo, py,
        ar or generic (send `generic_country` ISO alpha-2, optional `currency`).
      operationId: createKybLink
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerificationLinkRequest'
            example:
              external_customer_id: cust_456
              country: cl
              label: Comercial Andina SpA
              expires_in_days: 14
              idempotency_key: kyb-link-cust-456-1
      responses:
        '201':
          description: KYB link created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationLink'
              example:
                link_id: d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f80
                kind: kyb
                external_customer_id: cust_456
                url: https://verify.example.com/on/cl/business/new?invite=ghi789
                status: pending
                country: cl
                label: Comercial Andina SpA
                expires_at: 1721209600
                verification_fee: '2.000000'
                idempotency_key: kyb-link-cust-456-1
                created_at: '2026-07-10T12:00:00Z'
                updated_at: '2026-07-10T12:00:00Z'
        '400':
          description: idempotency_key_required / invalid_payload / invalid_country
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: idempotency_key_required
                message: provide idempotency_key (body or Idempotency-Key header)
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientFunds'
        '403':
          description: verification_required / company_account_required / service_disabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: company_account_required
                message: >-
                  third-party KYC/KYB verification is available to company
                  accounts only
components:
  schemas:
    VerificationLinkRequest:
      type: object
      required:
        - external_customer_id
        - idempotency_key
      properties:
        external_customer_id:
          type: string
          description: >-
            Your reference for the customer being verified (echoed on every
            webhook).
        idempotency_key:
          type: string
        country:
          type: string
          description: >-
            KYB only. Wizard corridor (us, cl, ve, br, mx, co, pe, bo, py, ar,
            generic).
        generic_country:
          type: string
          description: ISO alpha-2 when country=generic.
        currency:
          type: string
        label:
          type: string
        expires_in_days:
          type: integer
        metadata:
          type: object
    VerificationLink:
      type: object
      properties:
        link_id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
            - kyc
            - kyb
        external_customer_id:
          type: string
        url:
          type: string
          description: Hosted wizard URL to share with the verified person/business.
        status:
          type: string
          enum:
            - pending
            - opened
            - completed
            - expired
        country:
          type: string
        label:
          type: string
        expires_at:
          type: integer
        submission_id:
          type: string
          description: Present once the link is completed.
        verification_fee:
          type: string
        idempotency_key:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code (snake_case).
          example: insufficient_funds
        message:
          type: string
          description: Human-readable explanation.
  responses:
    Unauthorized:
      description: Missing or invalid credential (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
    InsufficientFunds:
      description: Account balance is not enough for this operation (`insufficient_funds`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: insufficient_funds
            message: account balance is not enough for this operation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Session JWT (from register/login) or API key (`pk_...`).
        `X-API-Key: <token>` is accepted as an alternative header.

````