/enrollments

Active ExcelID pour un client, après vérification en personne.

Réservé aux partenaires qui vérifient les personnes en face à face (banques, opérateurs, administrations) : votre accord avec ExcelID le prévoit. Voir le parcours dans Activation chez un partenaire.

POST /enrollments

Crée une activation et renvoie le code à remettre au client.

Corps de la requête

application/json

fullName chaîne Obligatoire

Nom complet de la personne, tel qu’inscrit sur sa pièce d’identité.

personalNumber chaîne Obligatoire

Son numéro d’identité d’État : CNIB ou WURI. De 6 à 20 lettres ou chiffres.

documentVerified booléen Obligatoire

Doit valoir true : vous attestez avoir contrôlé le document original en personne. Sans cette attestation, l’appel est refusé (400 invalidParameters).

{
  "fullName": "Aïcha Ouédraogo",
  "personalNumber": "B1234567",
  "documentVerified": true
}

200 · Requête réussie

activationCode chaîne

Le code d’activation, à afficher ou à lire au client. Valable 10 minutes, utilisable une seule fois.

activationLink chaîne

Le lien à transformer en code QR : excelid://activate?code=….

enrollmentId chaîne

Référence de l’activation, pour en suivre l’état.

userId, expiresAt

L’identifiant ExcelID de la personne, et l’heure d’expiration du code.

{
  "userId": "1d7c4a52-3f0b-4c1e-9a77-2b6e8d5f1c30",
  "enrollmentId": "9a0f2e61-7d3c-4b85-a1f4-5c2d6e8b9f10",
  "activationCode": "ACX7-RSD4",
  "activationLink": "excelid://activate?code=ACX7-RSD4",
  "expiresAt": "2026-11-13T09:51:00Z"
}

GET /enrollments/{id}

Donne l’état d’une activation.

status chaîne

pending : en attente du scan. activated : ExcelID est activé (avec activatedAt et deviceLabel, le modèle du téléphone). expired : le code a expiré sans être utilisé.

{
  "enrollmentId": "9a0f2e61-7d3c-4b85-a1f4-5c2d6e8b9f10",
  "fullName": "Aïcha Ouédraogo",
  "personalNumber": "B1234567",
  "status": "activated",
  "createdAt": "2026-11-13T08:41:00Z",
  "expiresAt": "2026-11-13T08:51:00Z",
  "activatedAt": "2026-11-13T08:44:12Z",
  "deviceLabel": "moto g (2025)"
}

GET /enrollments

Liste les derniers enrôlements de votre organisation.

La réponse est une liste d’objets identiques à celui de GET /enrollments/{id}.

Erreurs

400 invalidParameters : champ manquant ou mal formé, ou documentVerified absent. 401 unauthorized : certificat ou clé invalide. 404 notFound : activation inconnue. Voir Erreurs.