Screenings

Decide a screening hit

Marks one hit of a screening as false_positive or confirmed, with a reason.

Decide once. The decision is kept by the hit's fingerprint (list entry, strength, listed name) and reused by the following screenings of the same subject that hit the same entry - when the subject is identifiable: a customer_id, or a person with date_of_birth. Without that (a person without date of birth, or an inline business), the decision applies to this screening only, because a bare name matches every homonym. A changed list entry starts open.

The screening you decide on keeps the suggested_decision it was created with; its matches[].status shows the decision. Your decision is the final one, on any hit, sanctions lists included. When OZAV compliance has also reviewed a hit, its decision shows until you decide. Screenings created before hit decisions existed return 422 HIT_NOT_DECIDABLE: screen the subject again and decide on the new screening. Sending the decision the hit already has (by you) returns 200 with the current state and records nothing new.

patch/screenings/{screening_id}/hits/{hit_id}

Request

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

Path parameters

screening_idstring required

The opaque screening id (ozav_scr_...).

hit_idstring required

The hit id (hit_...) from matches[].id.

Request body

decision'false_positive' | 'confirmed' required
  • false_positive - the hit is not the subject.
  • confirmed - the hit is the subject.
reasonstring required

Why - kept for audit (at least 10 characters, no NUL). Do not put personal data here.

Response

The hit with its effective decision.

idstring required

The hit id (hit_...).

object'screening_hit' required

Always the literal screening_hit.

screening_idstring required

The screening the decision was made on (ozav_scr_...).

category'sanctions_list' | 'pep_list' required
  • sanctions_list - a sanctions-list hit.
  • pep_list - a PEP-register hit.
status'open' | 'false_positive' | 'confirmed' required

The effective decision now (yours prevails over OZAV's).

decided_by'you' | 'ozav' | 'null' nullable

you or ozav.

reasonstring nullable

The reason of the effective decision.

decided_atstring date-time nullable

When the effective decision was made.

Changes

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