Erreurs
Une erreur renvoie un statut HTTP et un corps JSON de la forme {"errorCode": "…", "details": "…"}.
Authentification et signature
| HTTP | errorCode | Raison | Action de votre service |
|---|---|---|---|
| 400 | alreadyInProgress | Une demande avec personalNumber a été envoyée alors qu’une demande est déjà en cours pour cet utilisateur. La demande est abandonnée et rien n’est créé. | Informez l’utilisateur qu’une demande est déjà en cours (EM4). |
| 400 | invalidParameters | Paramètre invalide ou usage incorrect de la méthode. Causes possibles : un orderRef déjà terminé ou échoué (une demande ne se collecte pas deux fois) ; un orderRef trop ancien ; un autre certificat que celui qui a créé la demande ; un contenu trop volumineux ; un corps qui n’est pas du JSON ; endUserIp invalide ; userVisibleData qui n’est pas du Base64 UTF-8 ; documentVerified absent. | Ne répétez pas la même requête. C’est une erreur interne à votre système : ne la présentez pas à l’utilisateur comme une erreur ExcelID. |
| 400 | Code inconnu | Nous pouvons introduire de nouveaux codes sans préavis. | Informez l’utilisateur (EM22) et mettez votre implémentation à jour. |
| 401, 403 | unauthorized | Vous n’avez pas accès au service : certificat ou clé absents ou invalides. | Ne répétez pas la requête. Erreur interne à votre système. |
| 404 | notFound | Une adresse erronée, ou une demande introuvable ou qui n’est plus en cours. | Ne répétez pas la requête. Erreur interne à votre système. |
| 405 | methodNotAllowed | Seule la méthode POST est autorisée (sauf GET /enrollments). | Ne répétez pas la requête. Erreur interne à votre système. |
| 408 | requestTimeout | La transmission de la requête a pris trop de temps. | Ne réessayez pas automatiquement. Informez l’utilisateur (EM5). |
| 415 | unsupportedMediaType | Ajouter un paramètre charset après application/json n’est pas permis. | Ne répétez pas la requête. Erreur interne à votre système. |
| 500 | internalError | Erreur technique interne au système ExcelID. | Ne réessayez pas automatiquement. Informez l’utilisateur (EM5). |
| 503 | maintenance | Le service est temporairement indisponible. | Réessayez sans informer l’utilisateur. Si l’erreur se répète, informez-le (EM5). |
Exemple : réponse de /collect avec un orderRef invalide
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"errorCode": "invalidParameters",
"details": "No such order"
}Activation
| HTTP | errorCode | Raison |
|---|---|---|
| 400 | invalidParameters | Nom ou numéro d’identité mal formé, ou documentVerified différent de true. |
| 404 | notFound | Aucune activation avec cet identifiant pour votre organisation. |
Carte numérique
Voir les erreurs de la vérification de la carte numérique : invalidParameters, qrCodeExpired, qrCodeUsed, unauthorized.