Zum Hauptinhalt springen
Dieser Artikel beschreibt eine Identitätskarten-Erkennung und Informationsüberprüfungs-API, die durch Eingabe eines Bildes der Identitätskarte oder von Namen und Identitätskartennummer die Echtheit und Konsistenz von Namen und Identitätskartennummer überprüfen kann. Diese Schnittstelle dient zur Überprüfung der Echtheit und Konsistenz von Namen und Identitätskartennummer. Sie können die erforderlichen Validierungsinformationen bereitstellen, indem Sie entweder den Namen und die Identitätskartennummer eingeben oder ein Bild der Identitätskarte hochladen.

​
Antragsprozess

Um die API zu nutzen, müssen Sie zunächst auf die entsprechende Seite der Identitätskarten-Erkennung und Informationsüberprüfungs-API gehen und den entsprechenden Dienst beantragen. Nachdem Sie die Seite betreten haben, klicken Sie auf die Schaltfläche „Acquire“, wie im Bild gezeigt: Wenn Sie noch nicht angemeldet oder registriert sind, werden Sie automatisch zur Anmeldeseite weitergeleitet, um sich zu registrieren und anzumelden. Nach der Anmeldung werden Sie automatisch zur aktuellen Seite zurückgeleitet. Bei der ersten Antragstellung gibt es ein kostenloses Kontingent, mit dem Sie die API kostenlos nutzen können.

​
Grundlegende Nutzung

Zunächst sollten Sie die grundlegende Nutzungsmethode verstehen, bei der Sie den Link zum Bild der Identitätskarte eingeben, um die verarbeiteten Validierungsergebnisse zu erhalten. Zunächst müssen Sie einfach ein image_url-Feld übermitteln, und wir können dann die entsprechenden Inhalte auf der Benutzeroberfläche ausfüllen, 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.
Außerdem haben wir den Request-Body festgelegt, einschließlich:
  • image_url: Der Link zum Bild der Identitätskarte, das verarbeitet werden soll.
  • encryption: Optional, Parameter zur Verschlüsselung sensibler Felder (falls verschlüsselte Daten gesendet werden müssen).
Nach der Auswahl können Sie feststellen, dass auf der rechten Seite auch 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, und wir erhalten folgendes Ergebnis: 
{
  "result": "0",
  "description": "Name und Identitätskartennummer stimmen überein",
  "name": "Name auf der Identitätskarte",
  "id_card": "Identitätskartennummer",
  "sex": "Geschlecht auf der Identitätskarte",
  "nation": "Ethnie auf der Identitätskarte",
  "birth": "Geburtsdatum auf der Identitätskarte",
  "address": "Wohnadresse auf der Identitätskarte"
}
Die Rückgabe enthält mehrere Felder, die wie folgt beschrieben werden:
  • result, der Authentifizierungsergebniscode, die Gebührenstruktur ist wie folgt.
    • Gebührenergebniscode:
      • 0: Name und Identitätskartennummer stimmen überein
      • -1: Name und Identitätskartennummer stimmen nicht überein
    • Gebührenfreie Ergebniscodes:
      • -2: Ungültige Identitätskartennummer (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 Identitätskarte im Dokumentenarchiv
      • -6: Autorisiertes Vergleichssystem wird aktualisiert, bitte später erneut versuchen
      • -7: Anzahl der Authentifizierungen hat das Tageslimit überschritten.
  • description, das Ergebnis der Überprüfung von Name und Identitätskartennummer.
  • name, die Namensinformation auf der Identitätskarte, wenn kein Bild der Identitätskarte hochgeladen wurde, ist dies leer.
  • id_card, die Identitätskartennummer auf der Identitätskarte, wenn kein Bild der Identitätskarte hochgeladen wurde, ist dies leer.
  • sex, die Geschlechtsinformation auf der Identitätskarte, wenn kein Bild der Identitätskarte hochgeladen wurde, ist dies leer.
  • nation, die ethnische Information auf der Identitätskarte, wenn kein Bild der Identitätskarte hochgeladen wurde, ist dies leer.
  • birth, die Geburtsinformation auf der Identitätskarte, wenn kein Bild der Identitätskarte hochgeladen wurde, ist dies leer.
  • address, die Wohnadresse auf der Identitätskarte, wenn kein Bild der Identitätskarte hochgeladen wurde, ist dies leer.
Es ist zu erkennen, dass die Informationen zu Name und Identitätskartennummer auf der Identitätskarte konsistent und gültig sind, und dass auch andere Informationen mithilfe von OCR-Technologie extrahiert und angezeigt wurden. Wenn Sie außerdem den entsprechenden Integrationscode generieren möchten, können Sie ihn direkt kopieren, zum Beispiel sieht der CURL-Code wie folgt aus: 
curl -X POST 'https://api.acedata.cloud/identity/idcard/ocr' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
Der Integrationscode in Python sieht wie folgt aus: 
import requests

url = "https://api.acedata.cloud/identity/idcard/ocr"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": {image_url}
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Benutzerdefinierte Informationsüberprüfung

Wir bieten auch eine Möglichkeit zur Überprüfung an, die keine Informationen des Identitätskartenbildes preisgibt. Sie können nur den Namen name und die Identitätskartennummer id_card übermitteln, um die Echtheit und Konsistenz von Namen und Identitätskartennummer zu überprüfen. Hier sind die spezifischen Informationen, die eingegeben wurden:

Nach dem Klicken auf Ausführen erhalten wir folgendes Ergebnis: 
{
    "address": "",
    "birth": "",
    "description": "Name und Identitätskartennummer stimmen überein",
    "id_card": "Identitätskartennummer",
    "name": "Name auf der Identitätskarte",
    "nation": "",
    "result": "0",
    "sex": ""
 }
So werden keine anderen privaten Informationen aus dem Ergebnis preisgegeben, und es kann auch die Echtheit und Konsistenz von Namen und Identitätskartennummer überprüft werden.

​
Fehlerbehandlung

Wenn beim Aufruf der API Fehler auftreten, gibt die API die entsprechenden Fehlercodes und 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ültiger oder fehlender 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

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "Abruf fehlgeschlagen"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Fazit

Durch dieses Dokument haben Sie erfahren, wie Sie die Identitätskarten-Erkennung und Informationsüberprüfungs-API zur Überprüfung der Echtheit und Konsistenz von Namen und Identitätskartennummern anhand von eingegebenen Bildern oder Informationen 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.