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

# Catálogos para formularios de compliance

> Devuelve todos los catálogos (listas de pares value/label) que el front debe usar para construir formularios de compliance y verificación consistentes: géneros, estados de empresa, tipos de dirección, formas jurídicas (lista global más cascada por país), fuentes de ingreso/patrimonio, estándares de industria con su default por país, y las listas ISO-3166 completas de países y subdivisiones. Data estática — seguro cachearla por horas. `value` es lo que envías a la API; `label` lo que muestras.



## OpenAPI

````yaml /openapi.es.yaml get /v1/aml/catalogs
openapi: 3.1.0
info:
  title: CBPay API
  version: '2.211'
  description: >
    CBPay es una plataforma de pagos multimoneda: payouts y cobros fiat

    en toda América Latina, transferencias internas, fondeo y retiros

    on-chain, y screening KYC. Cada cuenta mantiene once saldos virtuales

    independientes — USD (la moneda principal de las cuentas nuevas; las cuentas

    existentes mantienen USDT salvo que cambien su configuración), USDT, USDC,
    BTC y GOLD (gramos de

    oro fino), SILVER, PLATINUM (gramos) y BOB, MXN, ARS y CLP (libro mayor
    fiat; BOB/MXN/ARS usan 2 decimales y CLP 0) —

    convertibles a demanda con swaps entre los siete assets convertibles. Los
    balances fiat (BOB/MXN/ARS/CLP) solo acumulan payins retenidos con el flag
    `fiat_hold_local` y débitos directos en misma moneda; no son intercambiables
    por swap.

    Los payouts y las comisiones de servicios pueden pagarse desde cualquiera

    de los siete saldos de liquidación (`PUT /v1/settlement` u override por
    payout con

    `settlement_asset`), y los payins directos en USD se acreditan en USD; el
    resto de payins puede auto-convertirse al asset que

    elijas (`default_payin_asset`).


    Todos los montos son strings decimales en la precisión de cada moneda (2

    decimales para USD/BOB/MXN/ARS, 0 para CLP, 6 decimales para
    USDT/USDC/GOLD/SILVER/PLATINUM y 8 para BTC). Los errores siempre devuelven

    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (producción, dinero real)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, dinero simulado — keys pk_test_)
security:
  - bearerAuth: []
tags:
  - name: Support
    description: Support tickets and organization queue
  - name: Comprobantes
    description: >-
      Comprobante PDF brandeado por operacion, con verificacion publica de
      autenticidad (QR firmado), receipt_url en respuestas/webhooks de estado
      final y envio automatico por email en estados finales. Un payout pendiente
      antes del debito no expone receipt_url.
  - name: Autenticación
    description: >-
      Registra e inicia sesión de los miembros de la cuenta. Las sesiones duran
      24 horas.
  - name: Cuenta
    description: Perfil, miembros y llaves de API de la cuenta que llama.
  - name: Saldos
    description: Saldos, historial de movimientos y tasas de cambio.
  - name: Payouts
    description: >-
      Dispersiones fiat que se debitan del saldo de settlement que elijas (USD
      es el saldo principal).
  - name: Payins
    description: >-
      Recargas fiat (QR, transferencias, cuentas dedicadas, cobros pull,
      tarjetas, links de checkout) que se acreditan automáticamente — en USD, o
      convertidas al settlement asset que elijas.
  - name: Checkout
    description: >-
      Links de checkout universal (`POST /v1/payins` con `method: "checkout"`) y
      los endpoints públicos de la página de pago — fiat multi-país, crypto con
      wallet efímera por link y pago directo CBPay, liquidado en el asset que
      elijas.
  - name: Tarjetas guardadas
    description: >-
      Tarjetas guardadas con el consentimiento explícito del pagador durante un
      pago 3-D Secure (COF). Listarlas, revocarlas y cobrarlas bajo demanda
      (MIT) sin pedir la tarjeta de nuevo.
  - name: Suscripciones
    description: >-
      Cobros recurrentes sobre una tarjeta guardada gestionados por el scheduler
      de la plataforma — diarios, semanales, mensuales o anuales, con
      pausa/reanudación/cancelación y dunning automático.
  - name: Transferencias
    description: >-
      Transferencias internas gratuitas entre cuentas CBPay (persona o empresa,
      cualquier combinación).
  - name: Contacts
    description: >-
      Libreta de beneficiarios por cuenta (destinos CBPay, bancarios y crypto)
      con match por teléfono y auto-guardado en cada envío.
  - name: Swaps
    description: >-
      Conversión instantánea entre los saldos USDT, USDC, BTC, GOLD, SILVER y
      PLATINUM de la cuenta a la tasa cotizada de la cuenta.
  - name: Crypto
    description: Fondeo y retiros on-chain (TRON, Ethereum y Bitcoin).
  - name: Wallets segregadas
    description: >-
      Wallets on-chain con saldo propio (empresas ilimitadas; personas 1 por
      combinación red+activo) — crear, importar, enviar, exportar la llave
      privada y auto-forward. El saldo vive on-chain, nunca en el ledger.
  - name: Pruebas de firma
    description: >-
      Firma criptográfica de mensajes con wallets (EIP-191 ETH/EVM, TIP-191
      TRON) — crear, listar, consultar y revocar pruebas de firma con
      verificación pública.
  - name: Vínculos de wallets
    description: >-
      Vincula wallets externas (custody=client) a tu cuenta firmando un desafío
      nonce — crear desafíos, verificar firmas, listar y revocar vínculos.
  - name: QR Crypto POS
    description: >-
      Cobros QR crypto con monto para procesadores con POS físicos (cuentas
      empresa): merchants verificados, dirección exclusiva + QR por cobro,
      detección temprana del pago, conciliación por merchant y devoluciones por
      el riel de retiro crypto.
  - name: KYC / KYB
    description: >-
      Verificación de identidad: KYC para personas, KYB para empresas — tu
      propio onboarding y verificaciones de terceros para cuentas empresa.
  - name: Screening de wallets
    description: >-
      Evaluación de riesgo AML/CFT de direcciones blockchain (sanciones,
      exposición a fondos ilícitos) con comisión por scan, más protección
      automática gratuita en retiros y depósitos.
  - name: AML/CFT screening
    description: >-
      Screening AML/CFT standalone de personas y empresas contra listas de
      sanciones, PEP y medios adversos, con re-screening, monitoreo continuo e
      informe PDF descargable.
  - name: Qscore
    description: >-
      Buró de crédito API-first. Emite informes crediticios completos con score
      1-999 (bandas A-E, o SC cuando no hay datos), consulta el último score de
      un sujeto y gestiona disputas ARCO. Chile primero, con diseño agnóstico al
      país. Cada informe emitido lleva un código de verificación pública.
  - name: Analytics
  - name: Webhooks
    description: Suscripciones para recibir notificaciones de eventos firmadas.
  - name: Estado
    description: Disponibilidad del servicio.
  - name: Banking
    description: >-
      Cuentas bancarias reales: recibe, mantén y envía dinero por rieles
      bancarios internacionales.
  - name: Cards
    description: >-
      Tarjetas virtuales y físicas que gastan Just-In-Time desde cualquiera de
      los siete activos de gasto (USD, USDT, USDC, BTC, GOLD, SILVER o
      PLATINUM), con límites de gasto por tarjeta.
  - name: Seguridad (OTP)
    description: >-
      Códigos de verificación de un solo uso por SMS/WhatsApp/email que protegen
      acciones sensibles, más las preferencias de 2FA self-service. Aplican solo
      a sesiones de usuario — las API keys quedan exentas.
  - name: Passkeys
    description: >-
      Inicio de sesión sin contraseña con la biometría del dispositivo (Face ID,
      Touch ID, Windows Hello, llaves de seguridad) vía WebAuthn, apps
      autenticadoras (TOTP) con códigos de respaldo, y gestión de
      sesiones/dispositivos.
  - name: Login social
    description: >-
      Registro e inicio de sesión sin contraseña con Google, Apple, Microsoft y
      Facebook vía token exchange. El front obtiene la credencial del proveedor;
      la API la verifica y emite la sesión CBPay.
  - name: Eventos en tiempo real
    description: >-
      Stream Server-Sent Events con todo lo que pasa en la cuenta (o en toda la
      organización para administradores), replay con `Last-Event-ID`, snapshot
      inicial opcional e historial consultable de 90 días.
  - name: Contratos
    description: Contratos Marco Grupo CB prellenados para cuentas empresa verificadas.
  - name: Portal del referidor
    description: >-
      Portal de solo lectura para referidores (credencial de la cuenta payout):
      perfil, clientes referidos, comisiones devengadas e informe trilingüe
      (JSON/PDF/XLSX).
paths:
  /v1/aml/catalogs:
    get:
      tags:
        - AML/CFT screening
      summary: Catálogos para formularios de compliance
      description: >-
        Devuelve todos los catálogos (listas de pares value/label) que el front
        debe usar para construir formularios de compliance y verificación
        consistentes: géneros, estados de empresa, tipos de dirección, formas
        jurídicas (lista global más cascada por país), fuentes de
        ingreso/patrimonio, estándares de industria con su default por país, y
        las listas ISO-3166 completas de países y subdivisiones. Data estática —
        seguro cachearla por horas. `value` es lo que envías a la API; `label`
        lo que muestras.
      operationId: getAmlCatalogs
      responses:
        '200':
          description: Todos los catálogos más un bloque `meta` que describe las cascadas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  genders:
                    type: array
                    description: Valores exactos requeridos al screenear personas.
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  company_status:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  address_types:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  company_types:
                    type: array
                    description: >-
                      Lista plana de formas jurídicas (idioma local oficial)
                      como fallback.
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  source_of_income:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  source_of_wealth:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  industries:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  industry_code_types:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  company_types_by_country:
                    type: object
                    description: >-
                      Formas jurídicas por país ISO (GLEIF ELF); si el país
                      falta, usar `company_types`.
                  industries_by_code_type:
                    type: object
                    description: >-
                      Códigos de industria por estándar (`value` = código,
                      `label` = descripción).
                  industry_code_type_by_country:
                    type: object
                    description: Estándar de industria fijado por país (default ISIC).
                  countries:
                    type: array
                    description: Países ISO-3166-1.
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  country_subdivisions:
                    type: object
                    description: Subdivisiones ISO-3166-2 por país.
                  meta:
                    type: object
                    description: >-
                      Conteos más una nota que describe cómo se encadenan las
                      cascadas.
              example:
                genders:
                  - value: male
                    label: Male
                  - value: female
                    label: Female
                company_status:
                  - value: active
                    label: Active
                address_types:
                  - value: residential
                    label: Residential
                company_types:
                  - value: Sociedad Anónima
                    label: Sociedad Anónima
                source_of_income:
                  - value: salary
                    label: Salary
                source_of_wealth:
                  - value: business_ownership
                    label: Business ownership
                industries:
                  - value: financial_services
                    label: Financial services
                industry_code_types:
                  - value: ISIC
                    label: ISIC Rev.4
                company_types_by_country:
                  CL:
                    - value: Sociedad por Acciones
                      label: Sociedad por Acciones
                industries_by_code_type:
                  ISIC:
                    - value: '6419'
                      label: Other monetary intermediation
                industry_code_type_by_country:
                  CL: ISIC
                countries:
                  - value: CL
                    label: Chile
                country_subdivisions:
                  CL:
                    - value: CL-RM
                      label: Región Metropolitana de Santiago
                meta:
                  country_count: 249
                  note: value = send to the API; label = display in the UI.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountRequired'
components:
  schemas:
    CatalogItem:
      type: object
      description: >-
        Una entrada de catálogo — `value` es lo que envías a la API, `label` lo
        que muestras.
      properties:
        value:
          type: string
          example: CL
        label:
          type: string
          example: Chile
    Error:
      type: object
      properties:
        error:
          type: string
          description: Código de error legible por máquina (snake_case).
          example: insufficient_funds
        message:
          type: string
          description: Explicación legible por humanos.
  responses:
    Unauthorized:
      description: Credencial faltante o inválida (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
    AccountRequired:
      description: Este endpoint requiere una credencial de cuenta (`account_required`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: account_required
            message: this endpoint requires an account credential
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        JWT de sesión (de register/login) o llave de API (`pk_...`).
        `X-API-Key: <token>` se acepta como header alternativo.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.