> ## 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-Monitoring-Job abrufen – Didit Management API

> Didit: Status, Ergebniszähler und Ergebnisse je Datensatz eines AML-Monitoring-Jobs abrufen, der über den Users- oder Businesses-Endpoint gestartet wurde.



Prompt zum Abrufen des AML-Monitoring-Jobs
        Prompt in die Zwischenablage kopieren



      
      

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



      
      

Einfügen in

## ÜberblickGibt einen Job für die laufende AML-Überwachung zurück, der über [AML-Monitoring für Benutzer umschalten](https://docs.didit.me/de/management-api/aml-monitoring/toggle-users.md) oder [AML-Monitoring für Unternehmen umschalten](https://docs.didit.me/de/management-api/aml-monitoring/toggle-businesses.md) gestartet wurde: seinen Status, die Zähler pro Ergebnistyp und je einen `results`-Eintrag für jeden verarbeiteten Benutzer oder jedes verarbeitete Unternehmen.Die Auswahl von mehr als 20 Profilen wird im Hintergrund verarbeitet. Der Aufruf zum Umschalten gibt dann `202` mit einem Job im Status `PENDING` zurück. Fragen Sie diesen Endpoint etwa alle zwei Sekunden ab, bis `status` den Wert `COMPLETED` oder `FAILED` hat. `results` füllt sich, während Profile verarbeitet werden, in der Reihenfolge der Verarbeitung, und ist vollständig, sobald der Job `COMPLETED` ist. Ergebnisse pro Datensatz werden für Jobs erfasst, die über die API gestartet wurden. Ein Job, der aus der Business Console gestartet wurde, meldet nur Zähler.## Job-Status| `status` | Bedeutung |
| - | - |
| `PENDING` | Angenommen, noch nicht gestartet. |
| `PROCESSING` | Läuft; `processed`, `outcomes` und `results` werden aktualisiert. |
| `COMPLETED` | Für jedes Profil liegt ein Ergebnis vor. |
| `FAILED` | Der Job wurde vorzeitig beendet. `error` enthält eine kurze, allgemeine Meldung, und die bis zum Fehler erfassten Ergebnisse bleiben erhalten. Senden Sie die Umschaltanfrage für die Profile erneut, für die noch kein Ergebnis vorliegt. |Die `outcome`-Werte pro Datensatz sind auf den Umschaltseiten dokumentiert.## BerechtigungenJeder aktive API-Schlüssel der Anwendung kann diesen Endpoint aufrufen. Ein Job ist nur für die Anwendung sichtbar, die ihn erstellt hat. Jede andere `job_id` gibt `404` zurück.## Verwandte Seiten- [AML-Monitoring für Benutzer umschalten](https://docs.didit.me/de/management-api/aml-monitoring/toggle-users.md)
- [AML-Monitoring für Unternehmen umschalten](https://docs.didit.me/de/management-api/aml-monitoring/toggle-businesses.md)
- [Laufende AML-Überwachung](https://docs.didit.me/de/core-technology/aml-screening/continuous-monitoring-aml-screening.md)


## OpenAPI

````yaml de/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 für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/aml-monitoring/jobs/{job_id}/:
    get:
      tags:
        - AML Ongoing Monitoring
      summary: Laufenden AML-Überwachungsauftrag abrufen
      description: >-
        Status, Ergebnisindikatoren und Datensatzergebnisse eines
        Monitoring-Umschaltauftrags, der über `POST /v3/users/aml-monitoring/`
        oder `POST /v3/businesses/aml-monitoring/` gestartet wurde. Pollen Sie
        alle paar Sekunden, während `status` `PENDING` oder `PROCESSING` ist;
        `results` ist vollständig, sobald der Status `COMPLETED` lautet.
      operationId: get_aml_monitoring_job
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Die vom Toggle-Endpoint zurückgegebene `job_id`.
      responses:
        '200':
          description: Der Job.
          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, wenn der Job die Überwachung aktiviert, false, wenn
                      er sie deaktiviert.
                  target_type:
                    type: string
                    enum:
                      - user
                      - business
                    description: Welche Profilfamilie der Auftrag umschaltet.
                  total:
                    type: integer
                    description: Profile, die der Job verarbeitet.
                  processed:
                    type: integer
                    description: Bisher verarbeitete Profile.
                  outcomes:
                    type: object
                    description: >-
                      Ergebniszähler pro Datensatz. Jedes ausgewählte Profil
                      wird genau einem Zähler zugeordnet; nichts wird
                      stillschweigend übersprungen.
                    properties:
                      enabled:
                        type: integer
                        description: >-
                          Überwachung für ein bestehendes AML-Screening
                          aktiviert.
                      screened_and_enabled:
                        type: integer
                        description: >-
                          Ein neues AML-Screening wurde erstellt (in Rechnung
                          gestellt) und die Überwachung dafür aktiviert.
                      already_enabled:
                        type: integer
                        description: >-
                          Überwachung war bereits aktiv; es wurde nichts
                          geändert und nichts in Rechnung gestellt.
                      disabled:
                        type: integer
                        description: >-
                          Überwachung für jedes AML-Screening des Profils
                          deaktiviert.
                      skipped_no_identity_data:
                        type: integer
                        description: >-
                          Übersprungen: Dem Profil fehlen der vollständige Name,
                          das Geburtsdatum und das Land (Benutzer) oder ein Name
                          (Unternehmen), die für das Screening erforderlich
                          sind.
                      skipped_blocked:
                        type: integer
                        description: 'Übersprungen: Der Benutzer ist gesperrt.'
                      skipped_sandbox:
                        type: integer
                        description: >-
                          Übersprungen: Sandbox-Anwendung, es wird kein
                          Screening erstellt.
                      failed_provider:
                        type: integer
                        description: >-
                          Das Screening konnte nicht abgeschlossen werden;
                          versuchen Sie es später erneut.
                      failed_insufficient_balance:
                        type: integer
                        description: >-
                          Das Guthaben wurde aufgebraucht, während der Auftrag
                          lief.
                  results:
                    type: array
                    description: >-
                      Ein Eintrag pro verarbeitetem Profil, in der Reihenfolge
                      der Verarbeitung. Wächst, während der Job läuft;
                      vollständig, sobald der Status COMPLETED ist. Erfasst für
                      Jobs, die über die API gestartet wurden; ein über die
                      Business Console gestarteter Job meldet nur Zähler.
                    items:
                      type: object
                      properties:
                        didit_internal_id:
                          type: string
                          format: uuid
                          description: Interne Didit-ID des Profils.
                        vendor_data:
                          type: string
                          nullable: true
                          description: Ihre eigene Kennung für das Profil.
                        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: >-
                      Generische Fehlermeldung, wenn der Status FAILED lautet;
                      die detaillierte Ursache verbleibt auf Plattformseite.
                  created_at:
                    type: string
                    format: date-time
                  completed_at:
                    type: string
                    format: date-time
                    nullable: true
        '401':
          description: Fehlender oder ungültiger API-Schlüssel.
        '404':
          description: Kein solcher Auftrag für diese Anwendung.
      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: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

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