> ## 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 credit report

> Issues a new credit report for a subject (a person or a company),
billed as a standalone fee (`risk_report_person` / `risk_report_company`)
at the moment of issuance. Idempotency is mandatory: retrying with the
same `idempotency_key` returns the original report with `idempotency_hit:
true` and never charges twice. The report is computed synchronously: the
response is usually the finished report (status `ready`) or a failed one
(status `failed` with `error_code`/`error_message`). The `purpose` field
is mandatory (data protection law) and `doc_id` is validated and
normalized per country (e.g. Chilean RUT with check digit).



## OpenAPI

````yaml /openapi.yaml post /v1/qscore/reports
openapi: 3.1.0
info:
  title: CBPay API
  version: '2.62'
  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) — convertible on demand with swaps.
    Payouts and service fees can be paid from any of the four balances
    (`PUT /v1/settlement` or per-payout `settlement_asset`), and payins
    can auto-convert to the asset of your choice (`default_payin_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 (QR, transfers, dedicated accounts, pull collections, cards,
      checkout links) credited automatically — in USDT by default, or
      auto-converted to the settlement asset of your choice.
  - name: Checkout
    description: >-
      Universal checkout links (`POST /v1/payins` with `method: "checkout"`) and
      the public payment-page endpoints — multi-country fiat, crypto with an
      ephemeral wallet per link and direct CBPay payment, settled in the asset
      of your choice.
  - name: Stored cards
    description: >-
      Cards saved with the payer's explicit consent during a 3-D Secure payment
      (COF). List, revoke and charge them on demand (MIT) without asking for the
      card again.
  - name: Subscriptions
    description: >-
      Recurring charges on a stored card managed by the platform scheduler —
      daily, weekly, monthly or yearly, with pause/resume/cancel and automatic
      dunning.
  - name: Transfers
    description: >-
      Free internal transfers between CBPay accounts (person or company, any
      combination).
  - name: Contacts
    description: >-
      Per-account address book of beneficiaries (CBPay, bank and crypto
      destinations) with phone matching and auto-save on every send.
  - name: Swaps
    description: >-
      Instant conversion between the account's USDT, USDC, BTC and GOLD balances
      at the account's quoted rate.
  - 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: Signature proofs
    description: >-
      Cryptographic message signing with wallets (EIP-191 ETH/EVM, TIP-191 TRON)
      — create, list, get and revoke signature proofs with public verification.
  - name: Wallet links
    description: >-
      Link external wallets (custody=client) to your account by signing a nonce
      challenge — create challenges, verify signatures, list and revoke links.
  - 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
    description: >-
      Identity verification: KYC for persons, KYB for companies — your own
      onboarding and third-party verifications for company accounts.
  - name: AML screening
    description: >-
      Standalone AML screening of persons and companies against sanctions, PEP
      and adverse media lists, with rescreening, continuous monitoring and a
      downloadable PDF report.
  - 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: Qscore
    description: >-
      API-first credit bureau. Issues complete credit reports with a 1-999 score
      (bands A-E, or SC when there is no data), reads the latest score of a
      subject and manages ARCO disputes. Chile first, with a country-agnostic
      design. Every issued report carries a public verification code.
  - 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 balance of
      your choice (USDT, USDC, BTC or GOLD), 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.
  - name: Real-time events
    description: >-
      Server-Sent Events stream with everything that happens in the account (or
      across the organization for admins), replay with `Last-Event-ID`, optional
      initial snapshot and a 90-day queryable history.
paths:
  /v1/qscore/reports:
    post:
      tags:
        - Qscore
      summary: Create a credit report
      description: >-
        Issues a new credit report for a subject (a person or a company),

        billed as a standalone fee (`risk_report_person` /
        `risk_report_company`)

        at the moment of issuance. Idempotency is mandatory: retrying with the

        same `idempotency_key` returns the original report with
        `idempotency_hit:

        true` and never charges twice. The report is computed synchronously: the

        response is usually the finished report (status `ready`) or a failed one

        (status `failed` with `error_code`/`error_message`). The `purpose` field

        is mandatory (data protection law) and `doc_id` is validated and

        normalized per country (e.g. Chilean RUT with check digit).
      operationId: createQscoreReport
      requestBody:
        required: true
        content:
          application/json:
            examples:
              person:
                summary: Person report (Chilean RUT)
                value:
                  doc_id: 12.345.678-5
                  country: CL
                  subject_type: person
                  purpose: credit_evaluation
                  lang: es
                  idempotency_key: qscore-9f2b8d11
              company:
                summary: Company report (Chilean company RUT)
                value:
                  doc_id: 76.543.210-3
                  country: CL
                  subject_type: company
                  purpose: supplier_onboarding
                  lang: en
                  idempotency_key: qscore-7a31c4e5
      responses:
        '201':
          description: |-
            Report created and computed. `model_version` identifies the
            scoring model version. When status is `ready`, the full normalized
            `report` object is embedded; when status is `failed`,
            `error_code`/`error_message` explain why and the idempotency key is
            released so it can be retried.
          content:
            application/json:
              examples:
                ready:
                  summary: Report ready (score computed)
                  value:
                    report_id: 3f5c9f2d-7d21-4b8c-9a2d-2d5f6a1b8c01
                    subject_id: 8f5fb0d2-1d45-4a0e-9d5c-2d39f2b7a112
                    status: ready
                    purpose: credit_evaluation
                    lang: es
                    score: 742
                    band: B
                    model_version: v1
                    reason_codes:
                      - code: CREDIT_HISTORY_DEPTH
                        direction: positive
                        weight: medium
                      - code: ACTIVE_TRADELINES
                        direction: positive
                        weight: low
                    verify_code: Q3f5c9f2d7d214b8c9a2d2d5f6a1b8c01a1b2c3d4e5f60718293a
                    created_at: '2026-08-08T15:04:22Z'
                    completed_at: '2026-08-08T15:04:24Z'
                    report:
                      meta:
                        report_id: QSR-3F5C9F2D7D21
                        lang: es
                        purpose: credit_evaluation
                        generated_at: '2026-08-08T15:04:24Z'
                        verification_code: Q3f5c9f2d7d214b8c9a2d2d5f6a1b8c01a1b2c3d4e5f60718293a
                        verification_url: >-
                          /verify/qscore/Q3f5c9f2d7d214b8c9a2d2d5f6a1b8c01a1b2c3d4e5f60718293a
                      identity:
                        subject_type: person
                        doc_id: 12.345.678-5
                        name: Example Name
                        country: CL
                      score:
                        score: 742
                        band: B
                        model_version: v1
                        reason_codes:
                          - code: CREDIT_HISTORY_DEPTH
                            direction: positive
                            weight: medium
                          - code: ACTIVE_TRADELINES
                            direction: positive
                            weight: low
                        computed_at: '2026-08-08T15:04:24Z'
                      summary:
                        - No delinquencies or adverse events on record.
                        - Active credit history with reported tradelines.
                      tradelines:
                        - source: res_chile
                          creditor: Commercial creditor
                          kind: loan
                          status: current
                          currency: CLP
                          balance: '1250000'
                          opened_at: '2025-03-14'
                          reported_at: '2026-08-01'
                      delinquencies: []
                      sources:
                        - source: res_chile
                          label: Commercial bulletin
                          records: 1
                          fetched_at: '2026-08-08T15:04:23Z'
                ready_company:
                  summary: Company report with industry peer benchmark
                  value:
                    report_id: 7c9a1f3d-2e44-4b8a-9d51-0a1b2c3d4e5f
                    subject_id: 5b7d0e2a-2c34-4f6a-8b11-7d8e9f0a1b2c
                    status: ready
                    purpose: credit_evaluation
                    lang: es
                    score: 712
                    band: B
                    model_version: qscore-v2
                    reason_codes:
                      - code: ACTIVE_TRADELINES
                        direction: positive
                        weight: medium
                    verify_code: Q7c9a1f3d2e444b8a9d510a1b2c3d4e5fa1b2c3d4e5f60718293a
                    created_at: '2026-08-08T14:52:03Z'
                    completed_at: '2026-08-08T14:52:05Z'
                    report:
                      meta:
                        report_id: QSR-7C9A1F3D2E44
                        lang: es
                        purpose: credit_evaluation
                        generated_at: '2026-08-08T14:52:05Z'
                        verification_code: Q7c9a1f3d2e444b8a9d510a1b2c3d4e5fa1b2c3d4e5f60718293a
                        verification_url: >-
                          /verify/qscore/Q7c9a1f3d2e444b8a9d510a1b2c3d4e5fa1b2c3d4e5f60718293a
                      identity:
                        subject_type: company
                        doc_id: 76.123.456-0
                        name: Example Company SpA
                        country: CL
                      score:
                        score: 712
                        band: B
                        model_version: qscore-v2
                        reason_codes:
                          - code: ACTIVE_TRADELINES
                            direction: positive
                            weight: medium
                        computed_at: '2026-08-08T14:52:05Z'
                      peer_benchmark:
                        available: true
                        segment_code: '6499'
                        segment_label: Other financial service activities
                        peers: 12
                        percentile: 75
                        median_score: 640
                      summary:
                        - No delinquencies or adverse events on record.
                        - Active credit history with reported tradelines.
                      tradelines:
                        - source: res_chile
                          creditor: Commercial creditor
                          kind: loan
                          status: current
                          currency: CLP
                          balance: '1250000'
                          opened_at: '2025-03-14'
                          reported_at: '2026-08-01'
                      delinquencies: []
                      sources:
                        - source: res_chile
                          label: Commercial bulletin
                          records: 1
                          fetched_at: '2026-08-08T14:52:04Z'
                no_data:
                  summary: Subject with no bureau data (SC band)
                  value:
                    report_id: 9b2e7a41-3c10-4e7b-8f25-9d31a2b7c5e2
                    subject_id: 5c31a9d4-6b20-4f18-9a71-3e7b2d90c4aa
                    status: ready
                    purpose: hiring
                    lang: en
                    band: SC
                    model_version: v1
                    reason_codes:
                      - code: NO_DATA
                        direction: negative
                        weight: high
                    verify_code: Q9b2e7a413c104e7b8f259d31a2b7c5e2b2c3d4e5f60718293a4
                    created_at: '2026-08-08T15:10:02Z'
                    completed_at: '2026-08-08T15:10:03Z'
                replay:
                  summary: Idempotent replay (200 with idempotency_hit)
                  value:
                    report_id: 3f5c9f2d-7d21-4b8c-9a2d-2d5f6a1b8c01
                    subject_id: 8f5fb0d2-1d45-4a0e-9d5c-2d39f2b7a112
                    status: ready
                    purpose: credit_evaluation
                    lang: es
                    score: 742
                    band: B
                    model_version: v1
                    reason_codes:
                      - code: CREDIT_HISTORY_DEPTH
                        direction: positive
                        weight: medium
                    verify_code: Q3f5c9f2d7d214b8c9a2d2d5f6a1b8c01a1b2c3d4e5f60718293a
                    created_at: '2026-08-08T15:04:22Z'
                    completed_at: '2026-08-08T15:04:24Z'
                    idempotency_hit: true
        '400':
          description: >-
            invalid_payload | purpose_required | invalid_purpose |
            invalid_doc_id | invalid_subject_type | idempotency_key_required
          content:
            application/json:
              examples:
                purpose:
                  summary: Missing purpose
                  value:
                    error: purpose_required
                    message: purpose is required (data protection law)
                doc_id:
                  summary: Invalid document id
                  value:
                    error: invalid_doc_id
                    message: doc_id is not valid for the given country
        '401':
          description: unauthorized
        '403':
          description: forbidden (service disabled or unverified account)
        '404':
          description: not_found (a parent resource of the account was not found)
        '409':
          description: >-
            idempotency_conflict (same key with a different payload or still
            processing)
components:
  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.

````