> ## 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. # Submit an AML screening > Screens a person or company (detected from the payload) against sanctions, PEP and adverse-media lists via the compliance service. This is list screening only — identity verification with documents and liveness lives under /v1/kyc and /v1/kyb. All identity fields are optional and forwarded whole to the screening engine; the more identity data you send (date of birth, countries, strong identifiers, aliases), the more precise the analysis. If a compliance fee is configured, it is debited before the call and refunded if the screening fails. The result is stored locally for audit history (`GET /v1/aml/screenings`). `idempotency_key` is required — replaying with the same key returns the original screening with `idempotency_hit` true and never charges twice. ## OpenAPI ````yaml /openapi.yaml post /v1/aml/screenings 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": "", "message": ""}`. 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/screenings: post: tags: - AML screening summary: Submit an AML screening description: >- Screens a person or company (detected from the payload) against sanctions, PEP and adverse-media lists via the compliance service. This is list screening only — identity verification with documents and liveness lives under /v1/kyc and /v1/kyb. All identity fields are optional and forwarded whole to the screening engine; the more identity data you send (date of birth, countries, strong identifiers, aliases), the more precise the analysis. If a compliance fee is configured, it is debited before the call and refunded if the screening fails. The result is stored locally for audit history (`GET /v1/aml/screenings`). `idempotency_key` is required — replaying with the same key returns the original screening with `idempotency_hit` true and never charges twice. operationId: submitAmlScreening requestBody: required: true content: application/json: schema: type: object required: - idempotency_key properties: idempotency_key: type: string description: >- Required (the screening charges a fee). Also accepted as the Idempotency-Key header. 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: >- Company registry identifier (e.g. tax/registry number). place_of_registration: type: string description: Country of registration/incorporation (ISO-3166). incorporation_date: type: object description: >- Incorporation date as an object: {year, month, day} (integers). 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-8 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-8 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 submitted and stored locally. content: application/json: schema: type: object description: >- Local mirror of the screening plus billing fields. The full result is in `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: >- Provider-neutral screening outcome from the compliance service. 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: Missing 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: 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 InsufficientFunds: description: Account balance is not enough for this operation (`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: 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: ` is accepted as an alternative header. ````