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

# Compliance form catalogs

> Returns every catalog (list of value/label pairs) the front should use to build consistent compliance and verification forms: genders, company status, address types, company legal forms (global list plus per-country cascade), income/wealth sources, industry standards with their per-country default, and the full ISO-3166 country and subdivision lists. Static data — safe to cache for hours. `value` is what you send to the API; `label` is what you display.



## OpenAPI

````yaml /openapi.yaml get /v1/aml/catalogs
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/aml/catalogs:
    get:
      tags:
        - AML screening
      summary: Compliance form catalogs
      description: >-
        Returns every catalog (list of value/label pairs) the front should use
        to build consistent compliance and verification forms: genders, company
        status, address types, company legal forms (global list plus per-country
        cascade), income/wealth sources, industry standards with their
        per-country default, and the full ISO-3166 country and subdivision
        lists. Static data — safe to cache for hours. `value` is what you send
        to the API; `label` is what you display.
      operationId: getAmlCatalogs
      responses:
        '200':
          description: All catalogs plus a `meta` block describing the cascades.
          content:
            application/json:
              schema:
                type: object
                properties:
                  genders:
                    type: array
                    description: Exact enum values required when screening persons.
                    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: >-
                      Flat fallback list of legal entity forms (official local
                      language).
                    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: >-
                      Legal entity forms per ISO country (GLEIF ELF); fall back
                      to `company_types` when the country is missing.
                  industries_by_code_type:
                    type: object
                    description: >-
                      Industry codes per standard (`value` = code, `label` =
                      description).
                  industry_code_type_by_country:
                    type: object
                    description: Industry standard fixed per country (default ISIC).
                  countries:
                    type: array
                    description: ISO-3166-1 countries.
                    items:
                      $ref: '#/components/schemas/CatalogItem'
                  country_subdivisions:
                    type: object
                    description: ISO-3166-2 subdivisions per country.
                  meta:
                    type: object
                    description: >-
                      Counts plus a note describing how the cascades chain
                      together.
              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: >-
        One catalog entry — `value` is what you send to the API, `label` what
        you display.
      properties:
        value:
          type: string
          example: CL
        label:
          type: string
          example: Chile
    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
    AccountRequired:
      description: This endpoint requires an account credential (`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: |
        Session JWT (from register/login) or API key (`pk_...`).
        `X-API-Key: <token>` is accepted as an alternative header.

````