> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# AML डेटासेट ताज़गी API

> Didit के प्रतिबंध, PEP, चेतावनी और प्रतिकूल मीडिया डेटासेट कितने अद्यतन हैं, यह स्रोत परिवार के अनुसार जांचें। AML निगरानी के लिए ऑडिट साक्ष्य।



AML डेटासेट फ़्रेशनेस API प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\`Read how current Didit's AML screening datasets are, so I can attach it to an audit of ongoing AML monitoring.

Endpoint:
GET https://verification.didit.me/v3/aml/dataset-freshness/

Authentication:
Use the x-api-key header with my Didit API key. A scoped key needs sessions: read. A key limited to some workflows or to approved sessions can't call this endpoint.

Goal:
\- Get, per AML source family (sanctions, pep, warnings, adverse_media), the most recent dataset update and the staleness bound, and store it next to the AML screening history I hand to an auditor.

Behavior:
\- Platform-wide: no session in the path, no customer data in the answer, the same answer for every application.
\- Always 200. When no reading exists, dataset_freshness is null and availability says why: "not_configured" (dataset dates are not collected in this environment) or "not_yet_collected" (collection is set up, no reading yet).
\- Dates are never estimated. A family whose datasets reported no date is absent from sources. A family where only some datasets reported a date has oldest_updated_at: null.
\- captured_at is when the dates were read. Readings are taken while ongoing monitoring runs, not on each call.

Example call:
curl -X GET "https://verification.didit.me/v3/aml/dataset-freshness/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- availability - "available", "not_configured" or "not_yet_collected". Check it before reading dataset_freshness.
\- dataset_freshness.captured_at - when the reading was taken.
\- dataset_freshness.sources.<family>.last_updated_at - the most recent update in that family.
\- dataset_freshness.sources.<family>.oldest_updated_at - every dataset in the family is at least this current; null when some dates are missing.
\- dataset_freshness.sources.<family>.dataset_count and dated_dataset_count - how many datasets the family has and how many reported a date.
\- dataset_freshness.catalog_version - the data source's own catalog version, when reported.

Failure modes:
\- 401 - the API key has expired.
\- 403 - missing key (a wrong, revoked or expired key gets 401) ({"detail": "You do not have permission to perform this action."}), a scoped key without sessions: read, a key limited to workflows or approved sessions, or a request from outside the key's IP list.
\- 429 - more than 600 GET requests per minute with this key; wait Retry-After seconds.

Side effects: none. Not billed.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

यहाँ पेस्ट करें

इस endpoint का उपयोग यह दिखाने के लिए करें कि सतत निगरानी ने किन सूची संस्करणों के विरुद्ध स्क्रीनिंग की। इसे [निगरानी चलने का प्रमाण](https://docs.didit.me/hi/core-technology/aml-screening/continuous-monitoring-aml-screening.md#यह-प्रमाणित-करना-कि-निगरानी-चली-थी) में वर्णित प्रति-विषय स्क्रीनिंग इतिहास के साथ उपयोग करें: इतिहास बताता है कि हर विषय की स्क्रीनिंग कब हुई, और यह endpoint बताता है कि उन स्क्रीनिंग के पीछे के डेटासेट कितने ताज़ा थे।> [!NOTE]
>
> अनुपस्थित तिथि को अनुपस्थित ही दर्शाया जाता है, किसी विकल्प से नहीं बदला जाता। पहले `availability` जाँचें: जब यह `available` न हो, तो `dataset_freshness` `null` होता है और पढ़ने के लिए कुछ नहीं होता।## संबंधित- [सतत AML निगरानी](https://docs.didit.me/hi/core-technology/aml-screening/continuous-monitoring-aml-screening.md)
- [AML स्क्रीनिंग API](https://docs.didit.me/hi/standalone-apis/aml-screening.md)
- [API कुंजियाँ और सीमित पहुँच](https://docs.didit.me/hi/console/api-keys.md)


## OpenAPI

````yaml hi/openapi-25.json GET /v3/aml/dataset-freshness/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/aml/dataset-freshness/:
    get:
      tags:
        - Standalone APIs
      summary: AML डेटासेट की ताज़गी प्राप्त करें
      description: >-
        [सतत AML
        निगरानी](https://docs.didit.me/hi/core-technology/aml-screening/continuous-monitoring-aml-screening#यह-प्रमाणित-करना-कि-निगरानी-चली-थी)
        के लिए ऑडिट साक्ष्य के रूप में रिपोर्ट करें कि AML स्क्रीनिंग के पीछे के
        डेटासेट प्रति स्रोत फ़ैमिली (`sanctions`, `pep`, `warnings`,
        `adverse_media`) कितने अद्यतित हैं। यह उत्तर पूरे प्लेटफ़ॉर्म पर लागू
        होता है: पाथ में कोई सत्र नहीं, बॉडी में कोई ग्राहक डेटा नहीं, प्रत्येक
        एप्लिकेशन के लिए समान उत्तर।


        स्वीकृत कुंजी के लिए हमेशा `200`। पहले `availability` की जाँच करें: जब
        यह `available` नहीं होता है, तो `dataset_freshness` `null` होता है।
        तिथियों का अनुमान कभी नहीं लगाया जाता है: जिस फ़ैमिली के डेटासेट ने किसी
        तिथि की रिपोर्ट नहीं की है, वह `sources` से अनुपस्थित है, और ऐसी फ़ैमिली
        जहां केवल कुछ डेटासेट ने तिथि की रिपोर्ट की है, उसमें
        `oldest_updated_at: null` होता है। रीडिंग तब ली जाती है जब सतत निगरानी
        चलती है, प्रत्येक कॉल पर नहीं; `captured_at` बताता है कि कब ली गई।


        एक स्कोप्ड API कुंजी को `sessions: read` की आवश्यकता होती है; कुछ
        वर्कफ़्लो या स्वीकृत सत्रों तक सीमित कुंजी इस endpoint को कॉल नहीं कर
        सकती है। कोई शुल्क नहीं लिया जाता है।
      operationId: get_aml_dataset_freshness
      parameters: []
      responses:
        '200':
          description: नवीनतम डेटासेट फ्रेशनेस रीडिंग, या कारण के साथ `null`।
          content:
            application/json:
              schema:
                type: object
                required:
                  - dataset_freshness
                  - availability
                properties:
                  dataset_freshness:
                    allOf:
                      - $ref: '#/components/schemas/AMLDatasetFreshness'
                    nullable: true
                    description: >-
                      नवीनतम रीडिंग, या `availability` के `available` न होने पर
                      `null`।
                  availability:
                    type: string
                    enum:
                      - available
                      - not_configured
                      - not_yet_collected
                    description: >-
                      रीडिंग मौजूद होने पर `available`; इस एनवायरनमेंट में
                      डेटासेट तिथियां एकत्र नहीं होने पर `not_configured`;
                      संग्रह सेट होने पर लेकिन अभी तक कोई रीडिंग मौजूद नहीं होने
                      पर `not_yet_collected`।
              examples:
                Available:
                  value:
                    dataset_freshness:
                      captured_at: '2026-10-17T06:00:12.345678+00:00'
                      provider: aml_data_source
                      catalog_version: 20261017054500-abc
                      sources:
                        sanctions:
                          last_updated_at: '2026-10-17T04:10:00+00:00'
                          oldest_updated_at: '2026-10-15T22:30:00+00:00'
                          dataset_count: 48
                          dated_dataset_count: 48
                        pep:
                          last_updated_at: '2026-10-16T23:05:00+00:00'
                          oldest_updated_at: null
                          dataset_count: 12
                          dated_dataset_count: 11
                    availability: available
                Not collected yet:
                  value:
                    dataset_freshness: null
                    availability: not_yet_collected
        '401':
          description: >-
            API कुंजी की समय-सीमा समाप्त हो गई है। केवल समाप्ति तिथि के साथ बनाई
            गई कुंजी ही समाप्त हो सकती है; उस तिथि के बाद इसके साथ किया गया
            प्रत्येक अनुरोध `401` रिस्पॉन्स देता है।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            अनुरोध की अनुमति नहीं है। एक अनुपलब्ध कुंजी को सामान्य संदेश मिलता
            है; एक गलत, निरस्त या समय-सीमा समाप्त कुंजी को `401` मिलता है।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Missing or invalid key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without sessions read:
                  value:
                    detail: This API key has no read access to sessions.
                Key limited to workflows or approved sessions:
                  value:
                    detail: >-
                      This API key only reaches sessions inside its workflow or
                      status limits, so it can't use this endpoint.
                Outside the key's IP list:
                  value:
                    detail: This API key can't be used from this IP address.
        '429':
          description: >-
            इस API कुंजी के साथ प्रति मिनट 600 से अधिक GET अनुरोध। `Retry-After`
            में दिए गए सेकंड तक प्रतीक्षा करें, फिर पुनः प्रयास करें।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Throttled:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
          headers:
            Retry-After:
              description: वर्तमान एक-मिनट की विंडो रीसेट होने तक के सेकंड।
              schema:
                type: integer
                example: 23
            X-RateLimit-Limit:
              description: इस बजट में प्रति मिनट अनुमत अनुरोध।
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: वर्तमान विंडो में शेष अनुरोध।
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Unix समय जब विंडो रीसेट होती है।
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/aml/dataset-freshness/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.aml.retrieve_dataset_freshness()
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.aml.retrieveDatasetFreshness();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AML.RetrieveDatasetFreshness(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.aml().retrieveDatasetFreshness();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->aml->retrieveDatasetFreshness();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.aml.retrieve_dataset_freshness
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            var result = await client.Aml.RetrieveDatasetFreshnessAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    AMLDatasetFreshness:
      type: object
      description: >-
        स्क्रीनिंग चलने पर AML डेटासेट कितने अद्यतित थे। तिथियों का अनुमान कभी
        नहीं लगाया जाता है।
      required:
        - captured_at
        - provider
        - catalog_version
        - sources
      properties:
        captured_at:
          type: string
          format: date-time
          description: Didit ने वह डेटासेट कैटलॉग कब पढ़ा जिससे यह ताजगी आती है।
        provider:
          type: string
          description: >-
            AML डेटा स्रोत का अपारदर्शी पहचानकर्ता। इसे एक अपारदर्शी स्ट्रिंग के
            रूप में मानें; इस पर शाखा न बनाएं।
          example: aml_data_source
        catalog_version:
          type: string
          nullable: true
          description: >-
            डेटासेट कैटलॉग का संस्करण पहचानकर्ता, जब स्रोत किसी संस्करण की
            रिपोर्ट करता है।
        sources:
          type: object
          description: >-
            प्रति डेटासेट परिवार नवीनता। जिस परिवार के डेटासेट ने कोई अपडेट तिथि
            रिपोर्ट नहीं की है, वह `null` से भरे जाने के बजाय अनुपस्थित रहता है।
          properties:
            sanctions:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
            pep:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
            warnings:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
            adverse_media:
              $ref: '#/components/schemas/AMLDatasetSourceFreshness'
    AMLDatasetSourceFreshness:
      type: object
      description: AML डेटासेट के एक परिवार की नवीनता।
      required:
        - last_updated_at
        - oldest_updated_at
        - dataset_count
        - dated_dataset_count
      properties:
        last_updated_at:
          type: string
          format: date-time
          description: फ़ैमिली में किसी भी डेटासेट का सबसे हालिया अपडेट।
        oldest_updated_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            स्टेलनेस बाउंड: परिवार का प्रत्येक डेटासेट कम से कम इतना अद्यतित है।
            जब परिवार में कम से कम एक डेटासेट ने कोई अपडेट तिथि रिपोर्ट नहीं की
            हो तो `null`, क्योंकि तब यह सीमा अज्ञात होती है।
        dataset_count:
          type: integer
          description: फ़ैमिली में डेटासेट की संख्या।
        dated_dataset_count:
          type: integer
          description: उन डेटासेट की संख्या जिन्होंने अपडेट तिथि की सूचना दी।
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys
        से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
        किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
        स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
        सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
        समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
        कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
        सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
        के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
        छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
        के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
        देखें https://docs.didit.me/console/api-keys।

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.