Ein Dokument mit der API verifizieren
Sende ein PDF an die VerifyPDF-REST-API mit deinem API-Schlüssel im API-KEY-Header. Jede Verifizierung verbraucht ein Dokument und gibt dasselbe Ergebnis zurück wie das Dashboard.
Die VerifyPDF-REST-API lässt deine eigenen Systeme Dokumente verifizieren, ohne dass jemand das Dashboard öffnet. Dieser Artikel deckt den groben Ablauf ab. Für die vollständigen Anfrage- und Antwortdetails nutze die Referenz unter /agents/.
Bevor du startest
- Die REST-API ist auf den Tarifen Professional und Corporate verfügbar. Sie ist nicht in Basic oder einem Konto ohne Tarif enthalten. Sieh dir Die Tarife erklärt an.
- Du brauchst einen API-Schlüssel. Sieh dir API-Schlüssel erstellen und verwalten an.
Der grundlegende Ablauf
- Erstelle einen API-Schlüssel im Bereich Developers und kopiere ihn einmal.
- Sende das PDF an die API mit deinem Schlüssel im
API-KEY-Anfrage-Header. - Lies das Ergebnis, das mit demselben Trust-Score und derselben Betrugsrisiko-Bewertung zurückkommt, die du im Dashboard siehst. Sieh dir Dein Verifizierungsergebnis lesen an.
Jede API-Verifizierung verbraucht ein Dokument aus deinem monatlichen Kontingent oder Prepaid-Guthaben, genau wie ein Upload im Dashboard. Sieh dir Wie Prepaid-Pakete funktionieren an.
Deine eigene Referenz-ID hinzufügen
Du kannst eine custom_id an eine Verifizierung anhängen, zum Beispiel deine interne Fallnummer oder Bestell-ID. Damit kannst du die Verifizierung später über deine eigene Referenz nachschlagen. Jede custom_id muss innerhalb deines Kontos eindeutig sein.
Eine kurze Veranschaulichung
Auf hoher Ebene sendet eine Anfrage das PDF zusammen mit dem API-KEY-Header, der deinen Schlüssel enthält. Der genaue Endpunkt, der Anfragetext und das Antwortformat stehen in der API-Referenz unter /agents/ und im Bereich Developers des Dashboards. Nutze diese für kopierfertige Beispiele, statt zu raten.
Erst testen, dann live gehen
Während du baust, nutze einen test-Schlüssel. Wechsle für echte Verifizierungen zu einem live-Schlüssel. Sieh dir Test- vs. Live-API-Schlüssel an.
Nächste Schritte
- Willst du Ergebnisse zugeschickt bekommen, statt zu pollen? Sieh dir Webhooks einrichten an.
- Brauchst du die vollständige Referenz? Gehe zu /agents/.