Passer au contenu principal
POST
cURL
Démarrez la vérification Freja eID depuis votre backend à l’aide de la clé API de votre application. Vous n’avez pas besoin de workflow ni de workflow_id. La réponse de démarrage décrit la prochaine action d’authentification ; elle ne constitue pas un résultat d’identité approuvé.

Couverture et activation

L’activation du portefeuille est distincte du déploiement de l’API et de l’éligibilité de votre application. Un endpoint documenté n’active pas un portefeuille marqué Bientôt disponible. Pour les tarifs publiés en vigueur, consultez tarifs des portefeuilles d’identité numérique.

Ce que fait la personne

La personne doit disposer d’une identité Freja Plus et d’un accès à l’application Freja. Ouvrez l’URL d’autorisation renvoyée et laissez la personne approuver dans l’application. Les inscriptions de niveau Basic et Extended ne répondent pas au niveau d’assurance requis pour cette vérification. Le code PIN de la personne reste dans Freja et n’est jamais transmis à votre API. La couverture suédoise identifie le système d’émission et n’établit pas la nationalité suédoise.

Recevoir le résultat

Suivez le guide de l’API des portefeuilles d’identité numérique pour suivre la vérification et récupérer son résultat. Ne considérez qu’un résultat terminé et vérifié comme preuve que le portefeuille a authentifié la personne. Les attributs d’identité renvoyés varient selon le portefeuille ; ne supposez pas qu’une adresse, un portrait ou l’ensemble des attributs demandés soient présents.

Pages associées

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

En-têtes

Idempotency-Key
string

Clé de sécurité pour les réessais optionnelle (255 caractères maximum). Réessayer avec la même clé, le même portefeuille et le même corps renvoie la vérification d'origine sans démarrer une deuxième connexion ; la même clé avec un autre portefeuille ou un autre corps renvoie 409 idempotency_key_reused.

Corps

Démarrer une vérification Freja eID (SWE).

return_url
string<uri>
requis

URL HTTPS vers laquelle le navigateur de l'utilisateur est redirigé après l'utilisation du portefeuille, avec request_id et result ajoutés. Son hôte doit être enregistré dans les allowed_return_hosts de l'application (ou être son domaine en marque blanche). Ne vous fiez jamais à result à lui seul : lisez le résultat avec GET .../verifications/{request_id}/ ou le webhook.

Required string length: 1 - 2048
vendor_data
string | null

Votre propre référence pour cette vérification (par exemple, votre identifiant d'utilisateur). Renvoyée dans les résultats et les webhooks.

metadata
object | null

Objet JSON optionnel stocké avec la vérification et retourné dans les résultats et les webhooks.

sandbox_scenario
string

Applications en sandbox uniquement : le résultat simulé - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error' ; la vérification réussit pour tout autre scénario (ou en l'absence de scénario). Rejeté sur les applications en production. Le catalogue complet est disponible à GET /v1/sandbox/scenarios/.

Minimum string length: 1
country
enum<string>
défaut:SWE

Pays ISO 3166-1 alpha-3 de l'identité Freja eID. La valeur par défaut est SWE, le seul pays pris en charge.

  • SWE - SWE
Options disponibles:
SWE
device
enum<string>
défaut:same_device

same_device lorsque l'utilisateur se connecte sur l'appareil affichant votre page, cross_device lorsqu'il en utilise un autre (par exemple le code QR de BankID).

  • same_device - same_device
  • cross_device - cross_device
Options disponibles:
same_device,
cross_device

Réponse

Une vérification de portefeuille autonome, telle que renvoyée par chaque endpoint de portefeuille.

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

L'objet de métadonnées envoyé au démarrage, ou null.

created_at
string<date-time>
requis
Dernière modification le 7 novembre 2026