> ## 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（制裁・PEPリストの更新状況）

> 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>



      
      

貼り付け先

このエンドポイントを使うと、継続的なモニタリングがどのバージョンのリストに照らしてスクリーニングを行ったかを確認できます。[モニタリングの実行を証明する](https://docs.didit.me/ja/core-technology/aml-screening/continuous-monitoring-aml-screening.md#モニタリングが実行されたことを証明する)で説明している対象者ごとのスクリーニング履歴と組み合わせて使用してください。履歴は各対象者がいつスクリーニングされたかを示し、このエンドポイントはそれらのスクリーニングで使われたデータセットがどれだけ最新だったかを示します。> [!NOTE]
>
> 日付が欠けている場合は欠落として報告され、代わりの値で置き換えられることはありません。まず`availability`を確認してください。`available`でない場合、`dataset_freshness`は`null`となり、読み取れる情報はありません。## 関連情報- [継続的なAMLモニタリング](https://docs.didit.me/ja/core-technology/aml-screening/continuous-monitoring-aml-screening.md)
- [AMLスクリーニングAPI](https://docs.didit.me/ja/standalone-apis/aml-screening.md)
- [APIキーとスコープ付きアクセス](https://docs.didit.me/ja/console/api-keys.md)


## OpenAPI

````yaml ja/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スクリーニングの基盤となるデータセットがどの程度最新かを、ソースファミリー(`sanctions`、`pep`、`warnings`、`adverse_media`)ごとに、[継続的なAMLモニタリング](https://docs.didit.me/ja/core-technology/aml-screening/continuous-monitoring-aml-screening#モニタリングが実行されたことを証明する)の監査証拠としてレポートします。回答はプラットフォーム全体に共通です。パスにセッションはなく、ボディに顧客データはなく、すべてのアプリケーションで同じ回答になります。


        受け付けられたキーに対しては常に`200`を返します。まず`availability`を確認してください。`available`でない場合、`dataset_freshness`は`null`です。日付が推定されることはありません。どのデータセットも日付を報告しなかったファミリーは`sources`に含まれず、一部のデータセットのみが日付を報告したファミリーは`oldest_updated_at:
        null`になります。測定値は呼び出しごとではなく、継続的なモニタリングの実行中に取得されます。`captured_at`がその時刻を示します。


        スコープ付きAPIキーには`sessions:
        read`が必要です。一部のワークフローまたは承認済みセッションに限定されたキーは、このエンドポイントを呼び出せません。料金は発生しません。
      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キーで1分あたり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: 現在の1分間のウィンドウがリセットされるまでの秒数です。
              schema:
                type: integer
                example: 23
            X-RateLimit-Limit:
              description: この枠で1分あたりに許可されるリクエスト数。
              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データセットの1ファミリーの鮮度。
      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: >-
            鮮度の上限:
            ファミリー内のすべてのデータセットは、少なくともこの時点まで最新です。ファミリー内の少なくとも1つのデータセットが更新日を報告していない場合は上限が不明となるため、`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で取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
        https://docs.didit.me/console/api-keys

````

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