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

# Request an OTP code

> Sends a one-time code to the account's phone over the channel configured for the action. Requires a user session (JWT) — API keys receive `403 session_required`. Hourly send limits apply.



## OpenAPI

````yaml /openapi.yaml post /v1/otp/challenges
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/otp/challenges:
    post:
      tags:
        - Security (OTP)
      summary: Request an OTP code
      description: >-
        Sends a one-time code to the account's phone over the channel configured
        for the action. Requires a user session (JWT) — API keys receive `403
        session_required`. Hourly send limits apply.
      operationId: createOTPChallenge
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - action
              properties:
                action:
                  type: string
                  enum:
                    - login
                    - payout
                    - crypto_withdrawal
                    - transfer
                    - banking_operation
                    - card_reveal
                    - api_key_create
                    - member_add
                    - phone_change
            example:
              action: payout
      responses:
        '201':
          description: Challenge created; the code is on its way.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTPChallenge'
              example:
                challenge_id: 6f1c02aa-93a1-4f0e-a7d1-1f2e3c4b5a69
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                action: payout
                channel: whatsapp
                phone: '********5678'
                status: pending
                created_at: '2026-07-08T21:00:00Z'
                expires_at: '2026-07-08T21:10:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            API key credential (`session_required`) or recently linked,
            unverified phone with no alternative factor
            (`phone_binding_cooldown`). With the phone in cooldown, the
            challenge automatically falls back to the authenticator app (if
            enrolled) or the verified login email; the effective channel comes
            back in the challenge response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: session_required
                message: OTP verification requires a user session (JWT), not an API key
        '409':
          description: The account has no phone number (`phone_required`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: phone_required
                message: >-
                  the account has no phone number; set it with PATCH /v1/me
                  before requesting OTP codes
        '429':
          description: Send quota reached (`too_many_attempts`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: too_many_attempts
                message: too many verification attempts; wait before retrying
components:
  schemas:
    OTPChallenge:
      type: object
      properties:
        challenge_id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
        action:
          type: string
          enum:
            - login
            - payout
            - crypto_withdrawal
            - transfer
            - banking_operation
            - card_reveal
            - api_key_create
            - member_add
            - phone_change
        channel:
          type: string
          enum:
            - sms
            - whatsapp
        phone:
          type: string
          description: Masked phone the code was sent to.
        status:
          type: string
          enum:
            - pending
            - verified
            - consumed
            - expired
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        verified_at:
          type: string
          format: date-time
        consumed_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
  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.

````