Skip to main content
GET
curl
Use this endpoint to show which list versions ongoing monitoring screened against. Pair it with the per-subject screening history described in Proving that monitoring ran: the history says when each subject was screened, and this endpoint says how current the datasets behind those screenings were.
A missing date is reported as missing, never replaced by a substitute. Check availability first: when it is not available, dataset_freshness is null and there is nothing to read.

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.

Response

The latest dataset freshness reading, or null with the reason.

dataset_freshness
object | null
required

The latest reading, or null when availability is not available.

availability
enum<string>
required

available when a reading exists; not_configured when dataset dates are not collected in this environment; not_yet_collected when collection is set up but no reading exists yet.

Available options:
available,
not_configured,
not_yet_collected