curl --request POST \
  --url https://api.qbank.cl/platform/v1/aml/screenings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

{
  "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
  }
}

{
  "error": "idempotency_key_required",
  "message": "provide idempotency_key (body or Idempotency-Key header)"
}

{
  "error": "unauthorized",
  "message": "invalid or missing credentials"
}

{
  "error": "insufficient_funds",
  "message": "account balance is not enough for this operation"
}

{
  "error": "account_required",
  "message": "this endpoint requires an account credential"
}

{
  "error": "compliance_unavailable",
  "message": "screening temporarily unavailable"
}

Submit an AML/CFT 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.

POST

aml

screenings

curl --request POST \
  --url https://api.qbank.cl/platform/v1/aml/screenings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

{
  "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
  }
}

{
  "error": "idempotency_key_required",
  "message": "provide idempotency_key (body or Idempotency-Key header)"
}

{
  "error": "unauthorized",
  "message": "invalid or missing credentials"
}

{
  "error": "insufficient_funds",
  "message": "account balance is not enough for this operation"
}

{
  "error": "account_required",
  "message": "this endpoint requires an account credential"
}

{
  "error": "compliance_unavailable",
  "message": "screening temporarily unavailable"
}

Authorizations

Authorization

string

header

required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Body

application/json

idempotency_key

string

required

Required (the screening charges a fee). Also accepted as the Idempotency-Key header.

customer

object

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.

Show child attributes

monitor

boolean

default:false

Enable continuous monitoring from the start.

Response

Screening submitted and stored locally.

Local mirror of the screening plus billing fields. The full result is in result.

screening_id

string

kind

enum<string>

Available options:

screening

service

enum<string>

Available options:

compliance_person,

compliance_company

subject_type

enum<string>

Available options:

person,

company

subject_name

string

risk

string

monitor

boolean

screening_fee

string

fee_asset

string

idempotency_key

string

idempotency_hit

boolean

created_at

string<date-time>

result

object

Provider-neutral screening outcome from the compliance service.