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

# Enviar un screening AML/CFT

> Screenea una persona o empresa (detectado desde el payload) contra listas de sanciones, PEP y prensa adversa vía el servicio de compliance. Es solo screening de listas — la verificación de identidad con documentos y prueba de vida vive en /v1/kyc y /v1/kyb. Todos los campos de identidad son opcionales y se reenvían íntegros al motor; mientras más datos envíes, más preciso es el análisis. Si hay comisión de compliance, se debita antes de la llamada y se reembolsa si falla. El resultado queda guardado localmente para historial (`GET /v1/aml/screenings`). `idempotency_key` es obligatoria — repetir con la misma clave devuelve el screening original con `idempotency_hit` true sin cobrar dos veces.



## OpenAPI

````yaml /openapi.es.yaml post /v1/aml/screenings
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/screenings:
    post:
      tags:
        - AML/CFT screening
      summary: Enviar un screening AML/CFT
      description: >-
        Screenea una persona o empresa (detectado desde el payload) contra
        listas de sanciones, PEP y prensa adversa vía el servicio de compliance.
        Es solo screening de listas — la verificación de identidad con
        documentos y prueba de vida vive en /v1/kyc y /v1/kyb. Todos los campos
        de identidad son opcionales y se reenvían íntegros al motor; mientras
        más datos envíes, más preciso es el análisis. Si hay comisión de
        compliance, se debita antes de la llamada y se reembolsa si falla. El
        resultado queda guardado localmente para historial (`GET
        /v1/aml/screenings`). `idempotency_key` es obligatoria — repetir con la
        misma clave devuelve el screening original con `idempotency_hit` true
        sin cobrar dos veces.
      operationId: submitAmlScreening
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - idempotency_key
              properties:
                idempotency_key:
                  type: string
                  description: >-
                    Obligatoria (el screening cobra comisión). También aceptada
                    en el header Idempotency-Key.
                customer:
                  type: object
                  description: >
                    Identity data. Provide `person` or `company`; when omitted

                    it is filled from the account profile. Additional fields are
                    accepted

                    and forwarded to the screening engine.
                  properties:
                    person:
                      type: object
                      description: >-
                        Person identity. Every field is optional; more identity
                        data yields a more precise screening.
                      properties:
                        full_name:
                          type: string
                        first_name:
                          type: string
                        middle_name:
                          type: string
                        last_name:
                          type: string
                        date_of_birth:
                          type: object
                          description: >-
                            Date of birth as an object: {year, month, day}
                            (integers). A plain "YYYY-MM-DD" string is rejected
                            by the screening engine.
                          properties:
                            year:
                              type: integer
                            month:
                              type: integer
                            day:
                              type: integer
                        nationality:
                          type: array
                          items:
                            type: string
                          description: >-
                            Nationalities as an ARRAY of ISO-3166 codes (a plain
                            string is rejected by the screening engine).
                        country_of_birth:
                          type: string
                        residential_information:
                          type: array
                          items:
                            type: object
                            properties:
                              country_of_residence:
                                type: string
                        personal_identification:
                          type: array
                          description: >-
                            Strong identity documents (national ID, passport,
                            ...) as {number, issuing_country}. Do not send a
                            `type` field: the screening engine rejects it.
                          items:
                            type: object
                            properties:
                              issuing_country:
                                type: string
                              number:
                                type: string
                        alias:
                          type: array
                          items:
                            type: string
                          description: Other known names.
                    company:
                      type: object
                      description: >-
                        Company identity. Every field is optional; more identity
                        data yields a more precise screening.
                      properties:
                        legal_name:
                          type: string
                        alias:
                          type: array
                          items:
                            type: string
                          description: Trade / brand names.
                        registration_authority_identification:
                          type: string
                          description: >-
                            Identificador ante el registro mercantil (ej.
                            RUT/número de registro).
                        place_of_registration:
                          type: string
                          description: País de registro/constitución (ISO-3166).
                        incorporation_date:
                          type: object
                          description: >-
                            Fecha de constitución como objeto: {year, month,
                            day} (enteros).
                          properties:
                            year:
                              type: integer
                            month:
                              type: integer
                            day:
                              type: integer
                        address:
                          type: array
                          items:
                            type: object
                            properties:
                              country:
                                type: string
                    email:
                      type: string
                    country:
                      type: string
                monitor:
                  type: boolean
                  default: false
                  description: Enable continuous monitoring from the start.
            examples:
              person:
                summary: Person (KYC)
                value:
                  customer:
                    person:
                      full_name: Ana Perez Rojas
                      date_of_birth:
                        year: 1990
                        month: 4
                        day: 12
                      personal_identification:
                        - issuing_country: CL
                          number: 12.345.678-5
                    email: ana@example.com
                    country: CL
                  monitor: false
              personFull:
                summary: Person (KYC) — full identity for the most precise screening
                value:
                  customer:
                    person:
                      full_name: Ana Perez Rojas
                      date_of_birth:
                        year: 1990
                        month: 4
                        day: 12
                      nationality:
                        - CL
                      country_of_birth: CL
                      residential_information:
                        - country_of_residence: CL
                      personal_identification:
                        - issuing_country: CL
                          number: 12.345.678-5
                        - issuing_country: CL
                          number: P0123456
                    email: ana@example.com
                    country: CL
                  monitor: false
              company:
                summary: Company (KYB)
                value:
                  customer:
                    company:
                      legal_name: Comercial Andina SpA
                      registration_authority_identification: 76.543.210-3
                    email: legal@andina.cl
                    country: CL
                  monitor: true
              companyFull:
                summary: Company (KYB) — full identity for the most precise screening
                value:
                  customer:
                    company:
                      legal_name: Comercial Andina SpA
                      alias:
                        - Andina Market
                      registration_authority_identification: 76.543.210-3
                      place_of_registration: CL
                      incorporation_date:
                        year: 2015
                        month: 8
                        day: 1
                      address:
                        - country: CL
                    email: legal@andina.cl
                    country: CL
                  monitor: true
              minimal:
                summary: Minimal — autofilled from the account
                value:
                  customer: {}
                  monitor: false
      responses:
        '201':
          description: Screening enviado y guardado localmente.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Espejo local del screening más campos de cobro. El resultado
                  completo está en `result`.
                properties:
                  screening_id:
                    type: string
                  kind:
                    type: string
                    enum:
                      - screening
                  service:
                    type: string
                    enum:
                      - compliance_person
                      - compliance_company
                  subject_type:
                    type: string
                    enum:
                      - person
                      - company
                  subject_name:
                    type: string
                  risk:
                    type: string
                  monitor:
                    type: boolean
                  screening_fee:
                    type: string
                  fee_asset:
                    type: string
                  idempotency_key:
                    type: string
                  idempotency_hit:
                    type: boolean
                  created_at:
                    type: string
                    format: date-time
                  result:
                    type: object
                    description: Resultado neutro del servicio de compliance.
              example:
                screening_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                kind: screening
                service: compliance_person
                subject_type: person
                subject_name: Ana Perez Rojas
                risk: low
                monitor: false
                screening_fee: '2.000000'
                fee_asset: USDT
                idempotency_key: aml-screen-ana-1
                created_at: '2026-07-12T18:00:00Z'
                result:
                  customer_id: e1d2c3b4-a596-8778-695a-4b3c2d1e0f9a
                  status: completed
                  risk_level: low
                  screening_result: no_hits
                  monitored: false
        '400':
          description: Falta idempotency_key (`idempotency_key_required`).
          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':
          $ref: '#/components/responses/AccountRequired'
        '502':
          description: Screening temporarily unavailable (`compliance_unavailable`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: compliance_unavailable
                message: screening temporarily unavailable
components:
  schemas:
    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
    InsufficientFunds:
      description: >-
        El saldo de la cuenta no alcanza para esta operación
        (`insufficient_funds`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: insufficient_funds
            message: account balance is not enough for this operation
    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.