Référence API / Sessions
Lister les sessions
GET /v1/sessions · clé secrète sk_…
Les sessions de votre compte dans le mode de la clé, les plus récentes d'abord. Pour la page suivante, passez starting_after avec l'identifiant de la dernière session reçue, tant que has_more vaut true.
Paramètres de la requête
client_reference_id string facultatif
Ne renvoie que les sessions de cet usager.
status string facultatif
Ne renvoie que les sessions dans cet état.
limit integer facultatif
Nombre de sessions par page. (défaut : 20 · de 1 à 100)
starting_after string facultatif
Identifiant de la dernière session de la page précédente.
Réponse
object string
Toujours list. (défaut : list)
data array<session>
Les sessions, les plus récentes d'abord.
has_more boolean
true s'il reste des sessions : demandez la page suivante avec starting_after.
Chaque élément de data est un objet session .
Erreurs 400 invalid_cursorstarting_after ne désigne pas une session de ce compte et de ce mode.401 missing_api_keyEn-tête Authorization absent. 401 invalid_api_keyClé inconnue, révoquée, ou clé publique utilisée à la place de la clé secrète. 403 account_suspendedCompte suspendu : contactez CheckID. 429 rate_limitedTrop de requêtes pour cette clé ; réessayez après le délai de l'en-tête Retry-After.
Format commun : voir Erreurs .
cURL Node.js PHP Python
Copier
curl https://checkid.lapieuvre.tech/v1/sessions?client_reference_id=user_1842&limit=10 \
-H "Authorization: Bearer sk_test_…"
const response = await fetch("https://checkid.lapieuvre.tech/v1/sessions?client_reference_id=user_1842&limit=10" , {
headers: {
Authorization: `Bearer ${process.env.CHECKID_SECRET_KEY}` ,
},
});
const data = await response.json();
$ch = curl_init('https://checkid.lapieuvre.tech/v1/sessions?client_reference_id=user_1842&limit=10' );
curl_setopt_array($ch , [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('CHECKID_SECRET_KEY' ),
],
]);
$data = json_decode(curl_exec($ch ), true);
import os
import requests
response = requests.get(
"https://checkid.lapieuvre.tech/v1/sessions?client_reference_id=user_1842&limit=10" ,
headers={
"Authorization" : f"Bearer {os.environ['CHECKID_SECRET_KEY']}" ,
},
timeout=10 ,
)
data = response.json()
{
"object" : "list" ,
"data" : [
{
"id" : "ses_8Kq2LmR4wXa9TbN3cE7yP1f9" ,
"object" : "verification_session" ,
"livemode" : false ,
"status" : "verified" ,
"client_reference_id" : "user_1842" ,
"metadata" : {
"plan" : "pro"
},
"allowed_document_types" : [
"id_card"
],
"locale" : "fr" ,
"return_url" : "https://app.exemple.ci/fin" ,
"price" : 0 ,
"currency" : "XOF" ,
"created_at" : "2026-10-25T12:00:05Z" ,
"expires_at" : "2026-10-25T12:32:40Z" ,
"completed_at" : "2026-10-25T12:02:41Z" ,
"canceled_at" : null ,
"expired_at" : null ,
"document_feedback" : null ,
"document" : {
"type" : "id_card" ,
"country" : "CI" ,
"data" : {
"surname" : "KOUASSI" ,
"given_names" : "AMINATA" ,
"sex" : "F" ,
"birth_date" : "1994-03-12" ,
"birth_place" : "BOUAKE" ,
"document_number" : "C012345678" ,
"expiry_date" : "2031-06-30" ,
"nationality" : "CIV"
}
},
"decision" : {
"score" : 0.71 ,
"reasons" : []
}
}
],
"has_more" : false
}