Erste Schritte

Einführung

Die IDParse API ist eine API zur Datenextraktion aus Ausweisdokumenten. Sie laden ein Foto oder einen Scan eines Reisepasses, eines Personalausweises oder eines Visums hoch. Die API liest die MRZ (maschinenlesbare Zone, die Zeilen aus Buchstaben, Ziffern und <-Zeichen am unteren Rand des Dokuments) und gibt die Daten als JSON zurück.

Hauptmerkmale:

Ein Endpunkt für die Extraktion: Eine hochgeladene Datei ist ein Scan.
Prüfsummenvalidierte Ergebnisse. Die Prüfziffern (Kontrollzahlen, die in der MRZ aufgedruckt sind) schützen die Dokumentnummer, das Geburtsdatum und das Ablaufdatum. Sie erkennen viele Lesefehler, garantieren aber nicht, dass die extrahierten Werte richtig sind.
Faire Abrechnung. Nur ein validierter Erfolg wird berechnet. Ein Dokument, das nicht gelesen werden konnte, ist kostenlos.
Datenschutz durch Technik. Dokumentinhalte werden nicht in Anwendungsdatensätzen oder Protokollen gespeichert. Siehe Datenschutz.
Klare Limits. Antwort-Header zeigen Ihre enthaltenen Scans und Ihre Nutzung.

Wichtig

IDParse liest Daten aus einem Dokument. Es beweist nicht, dass ein Dokument echt ist, und es beweist nicht, dass das Dokument der Person gehört, die es vorlegt. Siehe Ergebnisse und Abrechnung.

Basis-URL

Alle API-v1-Anfragen verwenden die folgende Basis-URL:

text

https://api.idparse.com/v1/

Hinweis

Alle Anfragen müssen einen gültigen API-Schlüssel enthalten. Details finden Sie unter Authentifizierung.

API-Schlüssel erhalten

Erstellen Sie ein kostenloses Konto bei IDParse.
Bestätigen Sie Ihre E-Mail-Adresse.
Gehen Sie zu Ihrem Dashboard.
Navigieren Sie zu API-Schlüssel.
Klicken Sie auf Neuen Schlüssel erstellen und vergeben Sie einen Namen.
Kopieren Sie den Schlüssel sofort. Er wird nur einmal angezeigt.

Wichtig

Bewahren Sie Ihren API-Schlüssel sicher auf. Geben Sie ihn niemals in clientseitigem Code, öffentlichen Repositories oder URLs preis.

Schnellstart

Senden Sie eine Dokumentdatei an den Extract-Endpunkt:

bash

curl -s -X POST "https://api.idparse.com/v1/extract" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@passport.jpg"

Antwort:

json

{
    "success": true,
    "documents": [
        {
            "success": true,
            "document_type": "TD3",
            "fields": {
                "surname": "ERIKSSON",
                "given_names": "ANNA MARIA",
                "birth_date": "1974-08-12",
                "sex": "F",
                "nationality": "UTO",
                "document_number": "L898902C3",
                "expiry_date": "2012-04-15",
                "issuing_country": "UTO"
            },
            "check_digits_valid": {
                "document_number": true,
                "birth_date": true,
                "expiry_date": true
            },
            "checksum_protected": {
                "surname": false,
                "given_names": false,
                "birth_date": true,
                "sex": false,
                "nationality": false,
                "document_number": true,
                "expiry_date": true,
                "issuing_country": false
            },
            "failure_reason": null,
            "notes": [
                "birth date century inferred",
                "expiry date century inferred"
            ],
            "page": 1,
            "region": { "x": 0.05, "y": 0.81, "width": 0.9, "height": 0.12 }
        }
    ],
    "document_count": 1,
    "verified_document_count": 1,
    "processing_complete": true,
    "truncation_reason": null,
    "failure_reason": null,
    "notes": ["engines tried: locator"],
    "duration_ms": 480,
    "service_version": "2.0.0"
}

Das Beispiel zeigt den öffentlichen ICAO-Musterpass. Es ist keine echte Person.

Hinweis

Die Antwort des Extract-Endpunkts ist JSON ohne data-Hülle. Sie listet jedes in der Datei gefundene Dokument unter documents auf. Lesen Sie immer zuerst das Feld success, dann success jedes Dokuments. HTTP 200 wird auch zurückgegeben, wenn kein Dokument gelesen werden konnte. Fehler geben stattdessen "success": false mit einem error-Objekt zurück.

Mehr finden Sie auf den Seiten Endpunkte, Ergebnisse und Abrechnung und Codebeispiele.