OZozav
Screenings

Retrieve a transaction screening

Reads back a screened transaction of your organization, in the environment of the key. Free.

get/transaction-screenings/{transaction_screening_id}

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_...).

Response

The screened transaction.

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.