Zum Hauptinhalt springen
ShieldID

Entwickler

Dokumentation der API für Identitätsverifizierung – gemacht für den praktischen Einsatz.

Eine REST-API, eine gehostete Seite für die Teile, die Sie nicht selbst bauen möchten, und signierte Webhooks, damit Sie im selben Moment erfahren, in dem ein Ergebnis vorliegt. Sandbox-Schlüssel werden nie abgerechnet, daher lässt sich ShieldID am schnellsten verstehen, indem Sie es aufrufen.

Kostenlos in der Sandbox startenZur Kurzanleitung

Die Fünf-Minuten-Version

Vier Aufrufe. Ein Denkmodell.

Alles Weitere in dieser Dokumentation ist Detailarbeit auf Basis dieses Ablaufs.

  1. Sitzung erstellen

    POST /v1/sessions mit einer Return-URL und einer Webhook-URL. Sie erhalten eine session_id und eine verification_url zurück.

  2. Übergeben Sie sie an den Antragsteller

    Senden Sie die verification_url als Link, oder lassen Sie den Antragsteller auf dem Desktop den QR-Code scannen, den die gehostete Seite anzeigt. Abgeschlossen wird auf dem eigenen Telefon.

  3. Signierten Webhook empfangen

    Sobald die Session VERIFIED oder FAILED erreicht, sendet ShieldID das Ergebnis per POST an Ihre Webhook-URL, signiert, damit Sie sicher sein können, dass es von uns stammt.

  4. Ergebnis lesen

    Vertrauen Sie dem Webhook oder rufen Sie GET /v1/sessions/{id}/result selbst auf. In beiden Fällen erhalten Sie Ergebnisse je Prüfung statt eines einzelnen undurchsichtigen Scores.

Ausprobieren

Erstellen Sie Ihre erste Sitzung.

Dieselbe Anfrage in drei Sprachen. Das ist der Aufruf, den Schritt eins des Denkmodells beschreibt.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Sandbox-Schlüssel (vk_sand_…) durchlaufen genau diesen Ablauf kostenlos. Tauschen Sie einen vk_live_-Schlüssel ein, und es ändert sich nichts außer der Rechnung.

Finden Sie Ihren Einstieg

Der Rest der Entwicklerdokumentation.

Sechs Seiten. Lesen Sie, was Sie brauchen.

API-Referenz

Jeder Endpunkt, jedes Feld, jeder Fehler, auf den Sie sich einstellen können.
Öffnen API-Referenz

Quickstart

Vom Sandbox-Schlüssel zum ersten signierten Webhook, der Reihe nach.
Öffnen Quickstart

SDKs

Das Web-Widget, der gehostete Ablauf und was noch kommt.
Öffnen SDKs

Sandbox

Wie der Testmodus funktioniert und wie Sie einen Schlüssel erhalten.
Öffnen Sandbox

Status

Worüber wir berichten werden, sobald der Feed live ist.
Öffnen Status

Sandbox

Testen Sie den gesamten Ablauf, bevor Sie etwas unterschreiben.

Ein Sandbox-Schlüssel (Präfix vk_sand_) führt dieselbe API, dieselbe gehostete Seite und denselben Webhook-Ablauf aus wie die Produktion. Sitzungen werden überall, wo sie erscheinen, mit environment: "sandbox" gekennzeichnet, und Sandbox-Sitzungen werden bei keinem Tarif jemals abgerechnet.

Sandbox-Leitfaden lesen
  • Erstellen Sie echte Sitzungen, verifizieren Sie ein echtes Dokument auf Ihrem eigenen Smartphone und erhalten Sie einen echten signierten Webhook zurück
  • Nichts, was Sie in der Sandbox tun, wirkt sich auf eine Rechnung aus
  • Der Wechsel in die Produktion erfolgt durch Austausch des Schlüsselpräfixes; die Struktur der Anfrage ändert sich nicht

Offen entwickelt

Was fertig ist und was noch nicht.

Wir sagen es Ihnen lieber, als dass Sie es mitten in der Integration herausfinden.

Abschluss-Callbacks des Web-Widgets

Demnächst verfügbar

onComplete, onCancel und onStep sind in der Schnittstelle des Widgets heute bereits vorhanden, werden aber noch von nichts ausgelöst. Verwenden Sie die Rückgabe-URL und den Webhook – beide funktionieren bereits.

Durchgesetzte Ratenbegrenzungen

Demnächst verfügbar

Für jeden API-Schlüssel ist ein Ratenlimit passend zu Ihrem Tarif hinterlegt, es wird bei Anfragen aber noch nicht durchgesetzt – planen Sie entsprechend und verlassen Sie sich nicht darauf, dass ShieldID Sie drosselt.

Self-Service-Registrierung für die Sandbox

Demnächst verfügbar

Sandbox-Schlüssel werden auf Anfrage ausgestellt, solange die Self-Service-Registrierung noch entwickelt wird. Fragen Sie einfach an, wir bearbeiten Ihre Anfrage zügig.

Fragen

Klare Antworten für Entwickler.

Erste Schritte

In einem Nachmittag live gehen.

Beginnen Sie mit einem Sandbox-Schlüssel, führen Sie eine Verifizierung auf Ihrem eigenen Smartphone durch und lesen Sie den Webhook, den Sie erhalten. Kein Verkaufsgespräch erforderlich.

Kostenlos in der Sandbox startenZur Kurzanleitung

Sandbox-Sitzungen werden nie abgerechnet.