Sessions
Create a liveness check, read its result, and fetch the photo.
Base URL: https://api.myidii.com. Authenticate with your secret key:
Authorization: Bearer sk_test_...Sandbox keys see sandbox sessions only, and live keys see live sessions only.
The session object
{
"id": "ses_hy32tqt1ngyjxzd",
"object": "session",
"type": "liveness",
"environment": "live",
"status": "passed",
"reference": "user_4821",
"attempts": 2,
"score": 0.996,
"checks": [
{ "name": "head_turns", "status": "passed", "reason": "Moved into the oval as asked" },
{ "name": "light_reflection", "status": "passed", "reason": "Colour light check, part of the overall score" },
{ "name": "frame_analysis", "status": "passed", "reason": "Liveness confidence 99.6%, pass mark 80%" },
{ "name": "device_integrity", "status": "not_available", "reason": "Browsers can't prove their camera is real. Use the mobile SDK for this layer" }
],
"photo_url": "https://api.myidii.com/v1/sessions/ses_hy32tqt1ngyjxzd/photo",
"created_at": "2026-11-16T20:15:36.000Z",
"decided_at": "2026-11-16T20:16:37.000Z"
}Prop
Type
Create a session
POST /v1/sessionsProp
Type
curl https://api.myidii.com/v1/sessions \
-H "Authorization: Bearer $MYIDII_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"reference": "user_4821"}'Returns the session object plus three fields that are only shown once:
Prop
Type
Live sessions are charged when created. If the wallet can't cover one, you get 402 insufficient_funds.
Retrieve a session
GET /v1/sessions/:idList sessions
GET /v1/sessions?limit=20Newest first. limit is 1 to 100, default 20. Returns { "object": "list", "data": [ ...sessions ] }.
Get the photo
GET /v1/sessions/:id/photoReturns the JPEG. Only live checks that passed have one; others return 404 no_photo.