Skip to main content
GET
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.

Response

Your screening setting, its price and your latest screening.

enabled
boolean

Your counterparty_screening_enabled Travel Rule setting. Off by default; nothing is screened or billed while it is off.

price
string

Decimal string, in USD: what one screening costs your organization, the Company AML Screening price.

fresh_days
integer

How many days a screening stays fresh and is reused.

screening
object | null

Your latest screening of the counterparty. Null when you never screened it.