Annuler une session
POST /v1/sessions/{session_id}/cancel · clé secrète sk_…
Annule une session qui attend l'usager (created, document_pending ou challenge_pending). Si la pièce n'a pas encore été analysée, la réservation est libérée : la session ne vous coûte rien. Un webhook session.canceled est envoyé.
Paramètres du chemin
session_id string obligatoire
Identifiant de la session.
Réponse : l'objet session
id string
Identifiant de la session (ses_…).
object string
Toujours verification_session. (défaut : verification_session)
livemode boolean
true en production, false en mode test.
status string
État de la session (voir Sessions et états).
client_reference_id string | null
Votre identifiant de l'usager, tel que transmis à la création.
metadata object
Vos métadonnées, telles que transmises à la création.
allowed_document_types array<string> | null
Pièces acceptées pour cette session. Valeurs : id_card, passport.
locale string
Langue du parcours.
return_url string | null
Adresse de retour en fin de parcours.
price integer
Prix de la session en francs CFA (entier), réservé puis débité sur votre wallet. 0 en mode test.
currency string
Toujours XOF. (défaut : XOF)
created_at date
Date de création (ISO 8601, UTC).
expires_at date
Date d'expiration si l'usager ne poursuit pas le parcours. Repoussée à chaque action de l'usager.
completed_at date | null
Date de la décision (verified, rejected ou manual_review).
canceled_at date | null
Date d'annulation.
expired_at date | null
Date d'expiration effective.
document_feedback array<string> | null
Consignes en cours quand l'usager doit reprendre les photos de sa pièce (pièce floue, illisible…).
document objet | null
Pièce analysée : type (id_card, passport), country (code ISO à 2 lettres) et data, les données lues (surname, given_names, sex, birth_date, birth_place, document_number, personal_number, expiry_date, nationality). null avant l'analyse.
decision objet | null
Résultat : score (similarité du visage, de 0 à 1) et reasons, les motifs (voir les motifs). null avant la décision.
Erreurs
| 409 | invalid_session_state | La session est en cours d'analyse ou déjà terminée. |
| 404 | not_found | Session inconnue. |
| 401 | missing_api_key | En-tête Authorization absent. |
| 401 | invalid_api_key | Clé inconnue, révoquée, ou clé publique utilisée à la place de la clé secrète. |
| 403 | account_suspended | Compte suspendu : contactez CheckID. |
| 429 | rate_limited | Trop de requêtes pour cette clé ; réessayez après le délai de l'en-tête Retry-After. |
Format commun : voir Erreurs.
