Screening

Screen a subject against the sanctions lists you name

post/api/v1/screening/runs

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/screening/runs
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Headers

X-Korala-Mode'live' | 'test'

Dashboard JWT: live (default) or test. API keys are pinned to their credential mode. Mode cannot be changed after creation.

Idempotency-Keystring required

Retry the same request with the same key to get the same run; a changed request returns 409.

Request body

sourcesstring[] required

The lists to screen against, sanctions lists, the PEP list (korala_pep) or both. There is no default: name the lists your obligations require. Each kind is recorded as its own evidence: screening.sanctions and screening.pep.

reviewScorenumber

At or above it a candidate is a possible match. Must be below matchScore (the two must differ, so it cannot be 100).

matchScorenumber

At or above it a candidate is a match. Must be above reviewScore (the two must differ, so it cannot be 1).

pepLookbackMonthsnumber

With the PEP list: how many months after leaving office a person still counts as a PEP. At least 12, the AMLR minimum, which is the default. Refused without a PEP list.

riskSubjectIdstring uuid

A risk subject in this organisation and mode to record the outcome on: screening.sanctions evidence for sanctions lists, screening.pep for the PEP list.

Response

idstring uuid required
status'clear' | 'possible_match' | 'match' | 'incomplete' | 'error' required
incompleteboolean required

The screening was not complete (see incompleteReasons). Nothing found in an incomplete run is status incomplete, never clear.

incompleteReasonsstring[] required

source_missing, source_stale, source_attention, source_dropped_entries, source_reindex_pending, candidates_capped (the sanctions pool), pep_candidates_capped (the PEP pool), pep_lookback_beyond_list (the PEP look-back is longer than a PEP list goes back), name_terms_capped, name_without_tokens.

errorCodestring nullable required
trigger'check_step' | 'api' required
sandboxboolean required
sessionIdstring uuid nullable required
participantIdstring uuid nullable required
riskSubjectIdstring uuid nullable required
workflowRunIdstring uuid nullable required
listKindsstring[] required

The kinds of list screened: sanctions, pep, or both.

riskSourcestring required

The risk source of the first kind screened (sanctions when screened, otherwise pep); riskSources has each.

candidateCountnumber required

Listed entries scored, at most 200. Entries whose kind, dates of birth or nationalities keep them below reviewScore are set aside unscored and not counted.

topScorenumber nullable required

The highest score of the scored entries, or null when none was scored. Entries set aside as unable to reach review are not in it.

createdAtstring date-time required
updatedAtstring date-time required

Changes

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