Screening

Search news for a subject and judge each article

On request, for enhanced due diligence: findings go to review with their citations and never decline a customer. Test mode uses simulated articles and sends nothing to a search API or a model. Live mode answers 503 until adverse media is configured.

post/api/v1/screening/adverse-media/runs

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/screening/adverse-media/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

riskSubjectIdstring uuid

A risk subject in this organisation and mode to record the outcome on, as screening.adverse_media evidence.

Response

idstring uuid required
status'clear' | 'possible_finding' | 'finding' | 'incomplete' | 'error' required

finding: an open finding about the subject, or a confirmed one. possible_finding: open findings whose subject is unclear. clear: nothing found by a complete run. incomplete: nothing found, but something was not searched or judged. error: nothing could be searched or judged.

incompleteboolean required

Something was not searched or judged. Never a clear result, whatever the status.

incompleteReasonsstring[] required
errorCode'missing_name' | 'name_too_long' | 'not_configured' | 'retrieval_failed' | 'judge_failed' | 'concurrency_limited' | 'invalid_config' | 'no_session' nullable required
trigger'check_step' | 'api' required
sandboxboolean required
simulatedboolean required

The fake provider and judge answered: nothing was sent to a search API or a model. Every test-mode run is simulated.

sessionIdstring uuid nullable required
participantIdstring uuid nullable required
riskSubjectIdstring uuid nullable required
workflowRunIdstring uuid nullable required
riskFactstring required

screening.adverse_media

riskSourcestring required

The risk source its evidence is recorded under: korala:screening:adverse_media:v1.

findingCountnumber required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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