Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

vasp_id
string<uuid>
required

The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network member.

Body

application/json
refresh
boolean
default:false

true screens again (and bills again) even when a fresh screening exists.

Response

A fresh screening already existed and was returned. Nothing was billed.

outcome
enum<string>

screened: a new screening ran and was billed (201). reused: a fresh screening was returned and nothing was billed (200).

Available options:
screened,
reused
screening
object

One sanctions and adverse-media screening of the counterparty entity, run for and billed to your application. Private to your application: another customer never sees it.