Skip to main content
Dieser Artikel beschreibt eine Integrationsanleitung für die Identitätsinformationen und Gültigkeitsprüfung API, die zur Überprüfung der Echtheit und Konsistenz von Namen, Personalausweisnummer und Gültigkeitsdauer des Personalausweises verwendet werden kann.

Antragsprozess

Um die Identitätsinformationen und Gültigkeitsprüfung API zu nutzen, müssen Sie zunächst Ihr API-Token im Ace Data Cloud Dashboard abrufen und für zukünftige Verwendung aufbewahren. Wenn Sie noch nicht angemeldet oder registriert sind, werden Sie automatisch zur Anmeldeseite weitergeleitet, um sich zu registrieren und anzumelden. Nach Abschluss werden Sie automatisch zur aktuellen Seite zurückgeleitet. Ein API-Token reicht aus, um auf alle Dienste der Plattform zuzugreifen, es ist nicht erforderlich, für jeden Dienst separat zu beantragen. Bei der ersten Beantragung erhalten Sie ein kostenloses Kontingent, um es kostenlos auszuprobieren; wenn das Kontingent nicht ausreicht, können Sie im Dashboard Ihr allgemeines Guthaben aufladen.
📘 Vollständige Dokumentation: Identitätsinformationen und Gültigkeitsprüfung API →

Grundlegende Nutzung

Zunächst sollten Sie die grundlegende Nutzung verstehen, indem Sie den Link zum Bild des Personalausweises eingeben, um die verarbeiteten Validierungsergebnisse zu erhalten. Zunächst müssen Sie ein einfaches name-Feld übermitteln, das Sie dann im Interface ausfüllen können, wie im Bild gezeigt:

Hier haben wir die Request-Header festgelegt, einschließlich:
  • accept: In welchem Format Sie die Antwort erhalten möchten, hier eingetragen als application/json, also im JSON-Format.
  • authorization: Der Schlüssel zur API, den Sie nach der Beantragung direkt auswählen können.
Zusätzlich haben wir den Request-Body festgelegt, einschließlich:
  • name: Name.
  • id_card: Personalausweisnummer.
  • image_url: Link zum Bild des Gesichts, das verarbeitet werden soll.
  • validity_end: Ablaufdatum des Personalausweises, Format: YYYYMMDD, für langfristige Gültigkeit „00000000“ verwenden;
  • validity_begin: Beginn der Gültigkeit des Personalausweises, Format: YYYYMMDD.
  • encryption: Optional, Parameter zur Verschlüsselung sensibler Felder (falls verschlüsselte Daten gesendet werden müssen).
Nach der Auswahl können Sie sehen, dass auf der rechten Seite der entsprechende Code generiert wurde, wie im Bild gezeigt:

Klicken Sie auf die Schaltfläche „Try“, um einen Test durchzuführen. Wie im obigen Bild gezeigt, haben wir folgendes Ergebnis erhalten:
Die Rückgabeergebnisse bestehen aus mehreren Feldern, die wie folgt beschrieben werden:
  • result, Authentifizierungsergebniscode, die Gebührenstruktur ist wie folgt.
    • Gebührenergebniscode:
      • 0: Name und Personalausweisnummer stimmen überein
      • -1: Name und Personalausweisnummer stimmen nicht überein
    • Gebührenfreie Ergebniscodes:
      • -2: Ungültige Personalausweisnummer (Länge, Prüfziffer usw. nicht korrekt)
      • -3: Ungültiger Name (Länge, Format usw. nicht korrekt)
      • -4: Dienst des Dokumentenarchivs fehlerhaft
      • -5: Keine Aufzeichnung dieser Personalausweisnummer im Dokumentenarchiv
      • -6: Autorisiertes Vergleichssystem wird aktualisiert, bitte später erneut versuchen
      • -7: Anzahl der Authentifizierungen hat das Tageslimit überschritten.
  • description, hier das Ergebnis der Überprüfung von Name und Personalausweisnummer.
Es ist ersichtlich, dass Name, Personalausweisnummer und Gültigkeitsdauer im Personalausweis Echtheit und Konsistenz aufweisen. Wenn Sie den entsprechenden Integrationscode generieren möchten, können Sie ihn direkt kopieren, zum Beispiel sieht der CURL-Code wie folgt aus:
Der Integrationscode in Python sieht wie folgt aus:

Fehlerbehandlung

Wenn beim Aufruf der API ein Fehler auftritt, gibt die API den entsprechenden Fehlercode und die Informationen zurück. Zum Beispiel:
  • 400 token_mismatched: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
  • 400 api_not_implemented: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
  • 401 invalid_token: Unbefugt, ungültiges oder fehlendes Autorisierungstoken.
  • 429 too_many_requests: Zu viele Anfragen, Sie haben das Rate-Limit überschritten.
  • 500 api_error: Interner Serverfehler, etwas ist auf dem Server schiefgelaufen.

Beispiel für eine Fehlerantwort

Fazit

Durch dieses Dokument haben Sie erfahren, wie Sie die Identitätsinformationen und Gültigkeitsprüfung API zur Überprüfung der Echtheit und Konsistenz von Namen, Personalausweisnummer und Gültigkeitsdauer verwenden können. Wir hoffen, dass dieses Dokument Ihnen hilft, die API besser zu integrieren und zu nutzen. Bei Fragen wenden Sie sich bitte jederzeit an unser technisches Support-Team.