Zum Hauptinhalt springen
GET
curl

Überblick

Gibt einen Job für die laufende AML-Überwachung zurück, der über AML-Monitoring für Benutzer umschalten oder AML-Monitoring für Unternehmen umschalten 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

Die outcome-Werte pro Datensatz sind auf den Umschaltseiten dokumentiert.

Berechtigungen

Jeder 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

Autorisierungen

x-api-key
string
header
erforderlich

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.

Pfadparameter

job_id
string<uuid>
erforderlich

Die vom Toggle-Endpoint zurückgegebene job_id.

Antwort

Der Job.

job_id
string<uuid>
status
enum<string>
Verfügbare Optionen:
PENDING,
PROCESSING,
COMPLETED,
FAILED
is_enabled
boolean

true, wenn der Job die Überwachung aktiviert, false, wenn er sie deaktiviert.

target_type
enum<string>

Welche Profilfamilie der Auftrag umschaltet.

Verfügbare Optionen:
user,
business
total
integer

Profile, die der Job verarbeitet.

processed
integer

Bisher verarbeitete Profile.

outcomes
object

Ergebniszähler pro Datensatz. Jedes ausgewählte Profil wird genau einem Zähler zugeordnet; nichts wird stillschweigend übersprungen.

results
object[]

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.

error
string | null

Generische Fehlermeldung, wenn der Status FAILED lautet; die detaillierte Ursache verbleibt auf Plattformseite.

created_at
string<date-time>
completed_at
string<date-time> | null
Zuletzt geändert am 7. November 2026