Références API

Aperçu de l’API

Les utilisateurs ont besoin d’ExcelID et de l’application

Pour utiliser l’identification et la signature ExcelID, les utilisateurs doivent installer l’application ExcelID sur un appareil mobile et la faire activer par un partenaire (banque, opérateur) après vérification de leur pièce d’identité.

Vous avez besoin d’un accord et d’un certificat

Vous utilisez les services d’identification et de signature ExcelID par l’API. L’API n’est accessible qu’avec un certificat valide, que vous commandez auprès d’ExcelID (voir Demander un certificat).

Quand utiliser le code QR et le démarrage automatique

Si l’application ExcelID est installée sur l’appareil sur lequel s’exécute votre service, elle peut être lancée automatiquement. Si votre service s’exécute sur un autre appareil, par exemple le navigateur d’un ordinateur, votre service doit présenter un code QR animé que l’utilisateur scanne avec son application ExcelID.

Points d’accès et descriptions

Point d’accèsDescriptionCommentaire
/authAuthentification. Identifie l’utilisateur.Utilisé par exemple pour se connecter, accéder à des services en ligne.
/signUne signature numérique.Utilisé pour signer des accords et des contrats.
/paymentUne signature numérique pour un paiement.Le montant et le bénéficiaire sont affichés de façon structurée dans l’application.
/phone/authAuthentification pendant un appel téléphonique.Il y a des différences selon que l’appel est entrant ou sortant.
/phone/signUne signature numérique pendant un appel téléphonique.Il y a des différences selon que l’appel est entrant ou sortant.
/collectRenvoie les informations de la demande en cours, et son état.À interroger jusqu’à un succès ou un échec.
/cancelAnnule une demande en cours, de tout type.
/enrollmentsActivation d’ExcelID pour un client, par un partenaire.Réservé aux partenaires qui vérifient les personnes en face à face.
/idcard/verifyVérification de la carte numérique.API distincte, avec son propre point d’accès.

Journal des modifications, version 1

DateModification
2026-11-13Première version de l’API : /auth, /sign, /payment, /phone/auth, /phone/sign, /collect, /cancel, /enrollments et /idcard/verify.

Prérequis techniques

HTTP/1.1

Le service ne prend en charge que HTTP/1.1. HTTP/1.0 ne fonctionne pas.

Versions de TLS

Le service exige TLS 1.2 ou TLS 1.3.

OpenAPI

Vous pouvez télécharger la référence de l’API au format OpenAPI (YAML). Le fichier est versionné et mis à jour quand nous ajoutons des fonctions à l’API et améliorons la documentation.

Télécharger