---
title: "Add new screening(s)"
method: POST
path: "/v2/screening"
tags: ["Screening"]
---

# Add new screening(s)

`POST /v2/screening`

## Request body

- object[] — Screening data to add.
  - `lists` string[], required — The list(s) that the transaction was screened against. E.g. OFAC, ComplyAdvantage, Watchlists...
  - `outcome` 'POSITIVE' | 'NEGATIVE' | 'FALSE_NEGATIVE' | 'FALSE_POSITIVE' | 'TRUE_NEGATIVE' | 'TRUE_POSITIVE' | 'SCREENED', required — The outcome of the screening check (e.g., POSITIVE, NEGATIVE, TRUE_POSITIVE, etc.). The value "SCREENED" should only be used when the outcome is not available but there is the confirmation that the screening has been done.
  - `outcome_details` string — Further details on the reason of the screening outcome. For a transaction screening, it could be due to many reasons, so it could be relevant to include further details.
  - `provider` string, required — The provider that performed the screening check.
  - `related_company_id` string — Unique identifier for the related company in case of a company screening. Only one of `related_tx_id`, `related_person_id` or `related_company_id` should be provided.
  - `related_person_id` string — Unique identifier for the related person in case of a person and/or transaction screening. Only one of `related_tx_id`, `related_person_id` or `related_company_id` should be provided.
  - `related_tx_id` string — Unique identifier for the related transaction in case of a transaction screening. Only one of `related_tx_id`, `related_person_id` or `related_company_id` should be provided.
  - `screening_id` string, required — Unique identifier for the screening. This is the primary key for a screening and should be unique across screenings.
  - `timestamp` string, date-time, required — When the screening was performed in your system, in ISO 8601 format.
  - `type` 'ADVERSE_MEDIA' | 'AML' | 'PEP' | 'SANCTION', required — The type of screening check performed (e.g., SANCTION, PEP, ADVERSE_MEDIA, etc.).

## Response `201`

Screening added successfully

- WriteOperationResponse
  - `message` string, required — Provides additional information about the operation result.
  - `organization_id` string, required — The organization ID for which the operation was performed.
  - `success` boolean, required — Indicates if the write operation was successful.
  - `write_count` integer, required — The number of records written to the database.

## Other responses

- `400` — Invalid Screening data
- `401` — Unauthorized request
- `409` — Screening already exists
- `429` — Rate limit exceeded
- `500` — Server error
- `default` — General error

---

[API](https://skmtc.dev/cable/apis/cable-api.md) · [All operations](https://skmtc.dev/cable/apis/cable-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cable/cable-api/revisions/3222cd28dba5/schema)