OZozav
Screenings

Report how a screened transaction ended

Tells OZAV how the transaction ended: the risk was real, the flag was wrong, or the transaction completed, was reversed or charged back. An outcome is recorded once: sending the same outcome and note again returns the screening (safe to retry), a different one returns 409 OUTCOME_ALREADY_RECORDED. Outcomes are how OZAV measures and improves its rules. Free.

post/transaction-screenings/{transaction_screening_id}/outcome

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

transaction_screening_idstring required

The transaction screening id (ozav_txs_...).

Request body

outcome'confirmed_risk' | 'false_positive' | 'completed' | 'reversed' | 'chargeback' required
  • confirmed_risk - the risk was real.
  • false_positive - the flag was wrong.
  • completed - the operation went ahead and completed normally.
  • reversed - the operation was reversed or refunded.
  • chargeback - the operation ended in a chargeback.
notestring

Optional free text.

Response

The screened transaction with its outcome.

object'transaction_screening' required
idstring required

The transaction screening id (ozav_txs_...).

livemodeboolean required
external_idstring nullable
direction'inbound' | 'outbound' required
amount_usdstring required
currencystring nullable
amountstring nullable
counterparty_countrystring nullable
occurred_atstring date-time required
effect'allow' | 'review' | 'deny' required

The worst rule that fired; allow when none did. Advice only: OZAV never blocks the transaction, the decision is yours.

scoreinteger required

The sum of the rules' scores, capped at 100.

rule_versionstring required
outcome'confirmed_risk' | 'false_positive' | 'completed' | 'reversed' | 'chargeback' | 'null' nullable

How the transaction ended, as you reported it with POST /transaction-screenings/{transaction_screening_id}/outcome; null until then.

outcome_notestring nullable
outcome_atstring date-time nullable
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.