> ## 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のAPIで、ユーザーまたは企業のエンドポイントから開始したAMLの継続的なモニタリングジョブのステータス、結果カウンター、レコードごとの結果をポーリングして取得します。



AMLモニタリングジョブ取得用プロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`Goal: Read the status and the per-record results of an AML ongoing monitoring job started with POST /v3/users/aml-monitoring/ or POST /v3/businesses/aml-monitoring/. Needed whenever the toggle call returned 202 (more than 20 profiles); also works for jobs that already completed inline.

Endpoint: GET https://verification.didit.me/v3/aml-monitoring/jobs/{job_id}/
Auth header: x-api-key: <DIDIT_API_KEY>

Path param:
\- job_id: the job_id returned by the toggle endpoint.

curl:
curl 'https://verification.didit.me/v3/aml-monitoring/jobs/JOB_ID/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200:
\{
"job_id": "<uuid>",
"status": "PROCESSING",            // PENDING | PROCESSING | COMPLETED | FAILED
"is_enabled": true,
"target_type": "user",             // user | business
"total": 120,
"processed": 40,
"outcomes": {"enabled": 12, "screened_and_enabled": 25, "already_enabled": 3, "disabled": 0, "skipped_no_identity_data": 0, "skipped_blocked": 0, "skipped_sandbox": 0, "failed_provider": 0, "failed_insufficient_balance": 0},
"results": [
\{"didit_internal_id": "<uuid>", "vendor_data": "user-123", "outcome": "enabled"},
...one entry per processed profile, in processing order...
],
"error": null,                     // generic message when status is FAILED
"created_at": "<datetime>",
"completed_at": null
}

Polling: request the job every couple of seconds while status is PENDING or PROCESSING. results grows as profiles are processed and is complete once status is COMPLETED. A FAILED job keeps the results recorded before the failure and carries a short generic message in error; re-send the toggle request for the profiles that have no result yet. Per-record results are recorded for jobs started through the API; a job started from the Business Console reports counters only.

Failure modes:
\- 401 - missing/invalid x-api-key.
\- 404 - no such job for this application (jobs are only visible to the application that created them).

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\</pre>



      
      

貼り付け先

## 概要[ユーザーのAMLモニタリングを切り替える](https://docs.didit.me/ja/management-api/aml-monitoring/toggle-users.md)または[企業のAMLモニタリングを切り替える](https://docs.didit.me/ja/management-api/aml-monitoring/toggle-businesses.md)から開始した継続的なAMLモニタリングのジョブを返します。返される内容は、ジョブのステータス、結果ごとのカウンター、および処理済みのユーザーまたは企業1件につき1つの`results`エントリです。20件を超えるプロファイルを選択した場合はバックグラウンドで実行され、切り替えリクエストは`PENDING`のジョブとともに`202`を返します。`status`が`COMPLETED`または`FAILED`になるまで、このエンドポイントを数秒ごとにポーリングしてください。`results`はプロファイルが処理されるたびに処理順で追加され、ジョブが`COMPLETED`になった時点ですべて揃います。レコードごとの結果が記録されるのはAPIから開始したジョブのみで、Business Consoleから開始したジョブはカウンターのみを報告します。## ジョブのステータス| `status` | 意味 |
| - | - |
| `PENDING` | 受け付け済みで、まだ開始されていません。 |
| `PROCESSING` | 実行中です。`processed`、`outcomes`、`results`が更新されています。 |
| `COMPLETED` | すべてのプロファイルに結果があります。 |
| `FAILED` | ジョブが途中で停止しました。`error`には短い汎用メッセージが含まれ、失敗前に記録された結果は保持されます。まだ結果がないプロファイルについて、トグルリクエストを再送してください。 |レコードごとの`outcome`の値は、トグルの各ページに記載されています。## 権限アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。ジョブはそれを作成したアプリケーションからのみ参照でき、他のアプリケーションが作成した`job_id`では`404`が返されます。## 関連ページ- [ユーザーのAMLモニタリングを切り替える](https://docs.didit.me/ja/management-api/aml-monitoring/toggle-users.md)
- [企業のAMLモニタリングを切り替える](https://docs.didit.me/ja/management-api/aml-monitoring/toggle-businesses.md)
- [継続的なAMLモニタリング](https://docs.didit.me/ja/core-technology/aml-screening/continuous-monitoring-aml-screening.md)


## OpenAPI

````yaml ja/openapi-25.json GET /v3/aml-monitoring/jobs/{job_id}/
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-monitoring/jobs/{job_id}/:
    get:
      tags:
        - AML Ongoing Monitoring
      summary: AMLの継続的なモニタリングジョブを取得
      description: >-
        `POST /v3/users/aml-monitoring/`または`POST
        /v3/businesses/aml-monitoring/`で開始したモニタリング切り替えジョブのステータス、結果カウンター、レコードごとの結果。`status`が`PENDING`または`PROCESSING`の間は数秒ごとにポーリングしてください。`COMPLETED`になると`results`は完全な状態になります。
      operationId: get_aml_monitoring_job
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: トグルエンドポイントが返した`job_id`です。
      responses:
        '200':
          description: ジョブです。
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - PENDING
                      - PROCESSING
                      - COMPLETED
                      - FAILED
                  is_enabled:
                    type: boolean
                    description: ジョブがモニタリングを有効にする場合はtrue、無効にする場合はfalseです。
                  target_type:
                    type: string
                    enum:
                      - user
                      - business
                    description: ジョブが切り替えるプロファイルの種類。
                  total:
                    type: integer
                    description: ジョブが処理するプロフィール。
                  processed:
                    type: integer
                    description: これまでに処理されたプロフィール。
                  outcomes:
                    type: object
                    description: >-
                      レコードごとの結果カウンターです。選択された各プロフィールは必ずいずれか1つのカウンターに集計され、黙ってスキップされるものはありません。
                    properties:
                      enabled:
                        type: integer
                        description: 既存のAMLスクリーニングでモニタリングが有効化されました。
                      screened_and_enabled:
                        type: integer
                        description: 新しいAMLスクリーニングが作成され（課金対象）、そのスクリーニングでモニタリングが有効になりました。
                      already_enabled:
                        type: integer
                        description: モニタリングはすでに有効でした。何も変更されず、請求も発生していません。
                      disabled:
                        type: integer
                        description: プロファイルのすべてのAMLスクリーニングでモニタリングがオフになりました。
                      skipped_no_identity_data:
                        type: integer
                        description: >-
                          スキップ:
                          プロファイルに、スクリーニングに必要な氏名、生年月日、国(ユーザーの場合)または名称(企業の場合)がありません。
                      skipped_blocked:
                        type: integer
                        description: 'スキップ: ユーザーがブロックされています。'
                      skipped_sandbox:
                        type: integer
                        description: 'スキップ: サンドボックスアプリケーションのため、スクリーニングは作成されません。'
                      failed_provider:
                        type: integer
                        description: スクリーニングを完了できませんでした。後で再試行してください。
                      failed_insufficient_balance:
                        type: integer
                        description: ジョブの実行中に残高が不足しました。
                  results:
                    type: array
                    description: >-
                      処理されたプロファイルごとに処理順で1エントリー。ジョブの実行中に増えていき、ステータスがCOMPLETEDになった時点で完全になります。APIから開始したジョブについて記録されます。Business
                      Consoleから開始したジョブはカウンターのみを報告します。
                    items:
                      type: object
                      properties:
                        didit_internal_id:
                          type: string
                          format: uuid
                          description: プロファイルのDidit内部IDです。
                        vendor_data:
                          type: string
                          nullable: true
                          description: プロファイルに対するお客様独自の識別子です。
                        outcome:
                          type: string
                          enum:
                            - enabled
                            - screened_and_enabled
                            - already_enabled
                            - disabled
                            - skipped_no_identity_data
                            - skipped_blocked
                            - skipped_sandbox
                            - failed_provider
                            - failed_insufficient_balance
                  error:
                    type: string
                    nullable: true
                    description: ステータスがFAILEDの場合の汎用的な失敗メッセージ。詳細な原因はプラットフォーム側で保持されます。
                  created_at:
                    type: string
                    format: date-time
                  completed_at:
                    type: string
                    format: date-time
                    nullable: true
        '401':
          description: APIキーがないか無効です。
        '404':
          description: このアプリケーションにそのようなジョブはありません。
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl 'https://verification.didit.me/v3/aml-monitoring/jobs/JOB_ID/'
            \
              -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_monitoring.retrieve_job(
                "11111111-2222-3333-4444-555555555555",
            )
            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.amlMonitoring.retrieveJob("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AMLMonitoring.RetrieveJob(ctx, \"11111111-2222-3333-4444-555555555555\")\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.amlMonitoring().retrieveJob("11111111-2222-3333-4444-555555555555");

            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->amlMonitoring->retrieveJob('11111111-2222-3333-4444-555555555555');

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


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.aml_monitoring.retrieve_job("11111111-2222-3333-4444-555555555555")

            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.AmlMonitoring.RetrieveJobAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  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.