Zum Hauptinhalt springen
POST
cURL
Starten Sie die Freja-eID-Verifizierung von Ihrem Backend aus mit Ihrem Anwendungs-API-Schlüssel. Sie benötigen keinen Workflow und keine workflow_id. Die Antwort auf den Start beschreibt die nächste Authentifizierungsaktion; sie ist kein genehmigtes Identitätsergebnis.

Abdeckung und Aktivierung

Die Aktivierung der Wallet ist unabhängig von der API-Bereitstellung und der Berechtigung Ihrer Anwendung. Ein dokumentierter Endpoint aktiviert keine Wallet, die als Demnächst verfügbar gekennzeichnet ist. Aktuelle veröffentlichte Preise finden Sie unter Preise für digitale ID-Wallets.

Was die Person tut

Die Person benötigt eine Freja-Plus-Identität und Zugriff auf die Freja-App. Öffnen Sie die zurückgegebene Autorisierungs-URL, und lassen Sie die Person den Vorgang in der App genehmigen. Basis- und Extended-Registrierungen erfüllen die für diese Verifizierung erforderliche Sicherheitsstufe nicht. Die PIN der Person bleibt in Freja und wird niemals an Ihre API übermittelt. Die Abdeckung für Schweden kennzeichnet das ausstellende System und belegt keine schwedische Staatsangehörigkeit.

Ergebnis abrufen

Folgen Sie dem Leitfaden zur API für digitale ID-Wallets, um die Verifizierung zu verfolgen und ihr Ergebnis abzurufen. Betrachten Sie nur ein abgeschlossenes, verifiziertes Ergebnis als Nachweis, dass die Wallet die Person authentifiziert hat. Die zurückgegebenen Identitätsattribute unterscheiden sich je nach Wallet; gehen Sie nicht davon aus, dass eine Adresse, ein Porträt oder alle angefragten Attribute vorhanden sind.

Verwandte Themen

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Header

Idempotency-Key
string

Optionaler Schlüssel zur Wiederholungssicherheit (max. 255 Zeichen). Ein erneuter Versuch mit demselben Schlüssel, derselben Wallet und demselben Body gibt die ursprüngliche Verifizierung zurück, ohne eine zweite Anmeldung zu starten; derselbe Schlüssel mit einer anderen Wallet oder einem anderen Body gibt 409 idempotency_key_reused zurück.

Body

Starten Sie eine Freja-eID-Verifizierung (SWE).

return_url
string<uri>
erforderlich

HTTPS-URL, zu der der Browser des Benutzers nach der Wallet zurückkehrt, wobei request_id und result angehängt werden. Ihr Host muss in den allowed_return_hosts der Anwendung registriert sein (oder deren White-Label-Domain sein). Vertrauen Sie result niemals allein: Rufen Sie das Ergebnis mit GET .../verifications/{request_id}/ oder über den Webhook ab.

Required string length: 1 - 2048
vendor_data
string | null

Ihre eigene Referenz für diese Verifizierung (z. B. Ihre Benutzer-ID). Wird in Ergebnissen und Webhooks zurückgegeben.

metadata
object | null

Optionales JSON-Objekt, das mit der Verifizierung gespeichert und in Ergebnissen sowie Webhooks zurückgegeben wird.

sandbox_scenario
string

Nur für Sandbox-Anwendungen: Das simulierte Ergebnis – 'wallet_cancelled', 'wallet_timeout' oder 'wallet_provider_error'; jedes andere Szenario (oder keines) verifiziert erfolgreich. Bei Live-Anwendungen abgelehnt. Der vollständige Katalog ist unter GET /v1/sandbox/scenarios/ verfügbar.

Minimum string length: 1
country
enum<string>
Standard:SWE

ISO 3166-1-Alpha-3-Land der Freja eID-Identität. Standardmäßig SWE, das einzige Land, das unterstützt wird.

  • SWE - SWE
Verfügbare Optionen:
SWE
device
enum<string>
Standard:same_device

same_device, wenn sich der Benutzer auf dem Gerät anmeldet, das Ihre Seite anzeigt; cross_device, wenn er ein anderes Gerät verwendet (z. B. den QR-Code von BankID).

  • same_device - same_device
  • cross_device - cross_device
Verfügbare Optionen:
same_device,
cross_device

Antwort

Eine eigenständige Wallet-Verifizierung, wie sie von jedem Wallet-Endpoint beantwortet wird.

request_id
string<uuid>
erforderlich
wallet_verification
object
erforderlich
vendor_data
string | null
erforderlich
metadata
object | null
erforderlich

Das beim Start gesendete Metadaten-Objekt oder null.

created_at
string<date-time>
erforderlich
Zuletzt geändert am 7. November 2026