Schnell integrierbar für Entwickler und Systemintegratoren

API-Dokumentation

Diese Dokumentation beschreibt den öffentlichen Integrationsansatz: HTTPS-Request, Bearer Token, strukturierte Personendaten, XML-Antwort und die sichere Einordnung von Treffern und technischen Fehlern.

Swagger-Dokumentation öffnen Prüfprozess verstehen

Kostenlos testen

Beispiel-JSON mit 3 Personen herunterladen

Kein API-Token erforderlich. Jede Person verbraucht eine tägliche Prüfung. Führen Sie dieses Beispiel daher nur aus, wenn heute noch alle 3 kostenlosen Prüfungen verfügbar sind. Sind weniger übrig, wird die gesamte Anfrage abgelehnt.

curl.exe --fail-with-body --request POST "https://api.aaasoft.cz/sp_CheckPerson_XML" --header "Content-Type: application/json" --data-binary "@screening-example.json" --output "result.xml"

Den Befehl im Ordner mit der heruntergeladenen JSON-Datei ausführen.
Eine erfolgreiche HTTP-200-Antwort wird als result.xml gespeichert.
HTTP 429 bedeutet, dass das Tageslimit überschritten wurde, und darf nicht als found=No interpretiert werden.

API-Token abrufen

Registrierter Zugang mit API-Token:

curl.exe --fail-with-body --request POST "https://api.aaasoft.cz/sp_CheckPerson_XML" --header "Content-Type: application/json" --header "Authorization: Bearer IHR_API_TOKEN" --data-binary "@screening-example.json" --output "result.xml"

Navigation öffnen und API-Token anzeigen wählen.
E-Mail-Adresse und Passwort erneut eingeben.
Den angezeigten Token innerhalb von 20 Sekunden über Token kopieren in die Zwischenablage übernehmen.
IHR_API_TOKEN im Request durch den kopierten Token ersetzen.

Der API-Token ist vertraulich und darf nicht in Quellcode, öffentliche Repositories oder fachliche Protokolle übernommen werden.

Request-Felder

first_name: Vorname, erforderlich
last_name: Nachname, erforderlich
birth_date: Geburtsdatum im erforderlichen Format YYYY-MM-DD
customer_id: interne Referenz, erforderlich

Response

XML-Datei mit einem person-Element je übermittelter Person.
found=Yes kennzeichnet einen möglichen Treffer zur fachlichen Prüfung.
found=No bedeutet keinen technischen Treffer für die übermittelten Daten.
Metadaten am Root-Element bezeichnen die verwendete Listenversion.

Best Practices

Timeouts, Wiederholungsstrategie und technische Fehlerzustände definieren.
Nur eine gültige XML-Antwort mit Yes oder No fachlich weiterverarbeiten.
Treffer weder blind freigeben noch automatisch als Identitätsgleichheit behandeln.
Interne Referenzen verwenden, aber nur notwendige personenbezogene Daten übermitteln.

Maschinenstatus und Fachentscheidung trennen

Ergebnisbehandlung

found = No

Kein technischer Treffer

Kein passender Datensatz in der verwendeten Datenversion. Dies ist keine allgemeine rechtliche Freigabe und keine Prüfung anderer Listen.

found = Yes

Möglicher Treffer

Die enthaltenen Sanktionsdaten müssen anhand weiterer Identifikatoren fachlich bewertet werden. Namensähnlichkeit allein beweist keine Identität.

Fehler / Sondertext

Keine Entscheidung

HTTP-Fehler, Timeout, ungültiges Datum, Block- oder Limitmeldung dürfen nicht als No interpretiert werden. Der Client muss kontrolliert wiederholen oder eskalieren.

Opt-in-Erweiterung

Beziehungen zu anderen gelisteten Entitäten

Die optionale Erweiterung ergänzt konservativ aufgelöste Hinweise aus Textfeldern der EU-Quelldaten. Der Request-Body bleibt unverändert.

POST /sp_CheckPerson_XML?include=relations&relation_detail=summary&max_related=20

`relation_detail`

ids, summary oder full; Standard ist summary.

`max_related`

1 bis 100 Beziehungen je gefundener Sanktionsentität; Standard ist 20.

Abgrenzung

Nur Beziehungen zu anderen gelisteten Entitäten, Tiefe 1. Keine systematische Eigentums-, Kontroll- oder 50-Prozent-Prüfung.

Die Erweiterung verwendet den separaten Namespace https://api.aaasoft.cz/schema/relations/v1. Mehrdeutige Auflösungen und ein möglicher Status unavailable müssen vom Client sichtbar behandelt werden; die ursprünglichen EU-Datenelemente werden nicht verändert.

Häufige Fragen

Welche Methode wird verwendet?

Die öffentliche Dokumentation zeigt einen POST-Request gegen /sp_CheckPerson_XML.

Gibt es Swagger/OpenAPI?

Ja, die bestehende Navigation verweist auf eine FastAPI-Dokumentation unter /docs.

Kann ich mehrere Personen senden?

Das öffentliche Beispiel zeigt ein Array von Personen im Request.

Nächster Schritt

Lesen Sie den Praxisleitfaden, testen Sie die manuelle Suche und stimmen Sie für produktive Nutzung Datenschutz, interne Freigabeprozesse, Protokollierung und technische Fehlerpfade ab.

Praxisleitfaden öffnen Registrieren Kontakt aufnehmen