Build and test FaceSign step-up verification flows from your AI coding tool
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Export the current FaceSign session configuration as a standalone, deployable Next.js application. You MUST supply `landingHtml` (pre-session page), `recapHtml` (results page), and `uiStrings` (per-language dictionary whose keys are invented by you to match placeholders in the HTML). The exported app ships NO default chrome — every visible string comes from you. Run with `npm install && npm run dev` or deploy to Vercel after setting FACESIGN_API_KEY.
Array of nodes forming the session's directed graph
REQUIRED. Raw HTML/JS for the results/recap page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` (via {{KEY}} or window.t('KEY')). Contract: reads window.__FACESIGN_SESSION__, window.__FACESIGN_SESSION_ID__, window.__refetchSession() (returns Promise with updated session data). The COMMON MISTAKES sections from the `landingHtml` field description apply here too — read them once and follow for both fields. For the complete session data shape (Session, SessionReport, NodeReport types, delayed vs immediate fields), read the `facesign://session-data-types` MCP resource. STYLE GUIDE (Results/Recap Page): Match this visual style for consistency with the FaceSign UI. Background: Light gray #f5f7fa with subtle gradient to light blue at top. Layout: Single-column, max-width 900px, centered (margin 0 auto), padding 2rem. Page header: "Session summary" bold 1.6rem. Subtitle with date/time and duration in muted color #888, font-size 0.9rem. User info card: White card with rounded photo (80-100px), grid of icon+text pairs for age, gender, location, device. Icons in muted blue #6b7faa. Section cards: White background, border-radius 12px, box-shadow 0 2px 12px rgba(0,0,0,.05), padding 1.5rem, margin-bottom 1.5rem. Section headings: Bold 1.15rem, color #1a1a2e, with small emoji/icon prefix (e.g. ✨ AI Analysis, 🔍 Detected Signals, 📋 Transcript). Margin-bottom 1rem. Status banners (full-width within card, border-radius 12px, padding 1rem 1.5rem, white text, bold): - Verified/success: background #4a9d6e, shield ✓ icon - High-risk/warning: background #d97b30, ⚠ warning icon Signal items: Left border 4px solid, padding-left 1rem, margin-bottom 1rem, background white or tinted. - Normal: border-color #059669, light green tint background #f0fdf4 - Suspicious: border-color #f59e0b, light yellow tint background #fefce8 - High-risk: border-color #ef4444, light red tint background #fef2f2 Status badges (inline, pill): border-radius 6px, padding 2px 10px, font-weight 700, font-size 0.8rem, uppercase. - RECOGNIZED/NORMAL: background #d1fae5, color #065f46 - SUSPICIOUS: background #fef3c7, color #92400e Confidence scores: Right-aligned, font-size 0.85rem, color #aaa. Key-value grid: Two-column layout. Label: small text, color #888, font-size 0.8rem, uppercase. Value: font-size 0.95rem, color #1a1a2e, below label. Transcript: Dark background #1e2a3a, border-radius 10px, padding 1.5rem, monospace font. "CONVERSATION LOG" header uppercase, small, muted. Each line: timestamp (gray #777), speaker label (FACESIGN: in teal #4db8a4, USER: in green #6bc96f), message text white. Line-height 1.8. Video: Centered, border-radius 8px, max-width 100%, dark container background. Font: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif. BEST PRACTICES FOR STABLE RENDERING (recapHtml): Session data arrives in two stages: some fields are available immediately when the session ends (user info, AI analysis, transcript), while others require polling. Video AI analysis may take up to 60 seconds; media usually arrives sooner. Naive implementations cause layout jumping (DOM rebuild on each poll) and duplicate network requests. ARCHITECTURE: Split Static vs Dynamic Rendering. renderStatic(data) — called ONCE: Renders all sections that won't change: user info (age, sex, location, device), aiAnalysis.overallSummary, aiAnalysis.analysis list, transcript, documentImages. updateDynamic(data) — called on each poll: Updates ONLY sections whose data arrives asynchronously: nodeReports, videoAIAnalysis, deepfakeDetection, and media (avatarVideo, screenshots). IMPORTANT: nodeReports is DELAYED — do NOT render node report data (face compare results, document scan results, etc.) in renderStatic(). Each dynamic section has its own wrapper element (e.g. <div id="video-ai-content">, <div id="node-reports-content">) so updates replace only that element's innerHTML, leaving the rest untouched. Track completion with boolean flags (videoAIDone, recordingDone, nodeReportsDone). Once a section is populated, skip further updates. Set videoAIDone when videoAIAnalysisStatus is either `succeeded` or `failed`. A failed analysis is terminal: replace the spinner with an unavailable message and do not interpret the missing result as clean evidence. If the status is absent, analysis was not requested, so omit the section. HTML STRUCTURE: <!-- Static sections: rendered once --> <div id="userinfo-card"></div> <div id="summary-card"></div> <div id="analysis-card"></div> <!-- Dynamic sections: inner content updated by polling --> <div id="video-ai-card"> <div class="card"> <div class="card-title">Video AI Analysis</div> <div id="video-ai-content"><!-- spinner initially, replaced when data arrives --></div> </div> </div> <div id="recording-card"> <div class="card"> <div class="card-title">Session Recording</div> <div id="recording-content"><!-- spinner initially, replaced when data arrives --></div> </div> </div> <!-- Static section: rendered once --> <div id="transcript-card"></div> POLLING: Single Entry Point with Guard (IIFE pattern): IMPORTANT: Polling MUST be limited — max 30 attempts, max 2 minutes total. Stop polling when limits are reached even if some data hasn't arrived. (function() { var polling = false; var pollCount = 0; var MAX_POLLS = 30; var startTime = Date.now(); var MAX_DURATION = 2 * 60 * 1000; // 2 minutes var videoAIDone = false; var recordingDone = false; var nodeReportsDone = false; function shouldStop() { return pollCount >= MAX_POLLS || (Date.now() - startTime) >= MAX_DURATION; } function poll() { if (polling) return; if (shouldStop()) return; polling = true; pollCount++; if (typeof window.__refetchSession !== 'function') { polling = false; setTimeout(poll, 2000); return; } window.__refetchSession() .then(function(data) { polling = false; updateDynamic(data); if ((!videoAIDone || !recordingDone || !nodeReportsDone) && !shouldStop()) setTimeout(poll, 4000); }) .catch(function() { polling = false; if (!shouldStop()) setTimeout(poll, 4000); }); } function init() { var data = window.__FACESIGN_SESSION__; if (!data) return; renderStatic(data); var needMore = updateDynamic(data); if (needMore) setTimeout(poll, 4000); } if (window.__FACESIGN_SESSION__) { init(); } else { var chk = setInterval(function() { if (window.__FACESIGN_SESSION__) { clearInterval(chk); init(); } }, 500); } })(); KEY RULES: - Call renderStatic() exactly once — avoids DOM rebuild and layout jumps - updateDynamic() only touches dedicated container elements — no reflow outside the updated section - Use a polling boolean guard — prevents concurrent __refetchSession() calls - ALWAYS limit polling — max 30 attempts AND max 2 minutes total. Never poll indefinitely. - Use videoAIDone / recordingDone / nodeReportsDone flags — stops updating a section once its data has been rendered - For video AI, derive videoAIDone from videoAIAnalysisStatus, not from the presence of videoAIAnalysis alone - nodeReports is DELAYED — always render node report data (face compare, document scan, etc.) in updateDynamic(), never in renderStatic() - Single init() entry point via IIFE — eliminates duplicate initialization paths - Check typeof __refetchSession === 'function' before calling — handles the case where the API isn't injected yet - Use setTimeout not setInterval for polling — ensures the next poll starts only after the previous one completes - nodeReport.type is lowercase snake_case ("face_compare", "document_scan") — use case-insensitive comparison - Document scan report fields are Microblink nested objects — use a safe-value extractor function (see COMMON MISTAKES) - videoAIAnalysis criterion is camelCase — convert to human-readable with toStartCase() (see COMMON MISTAKES) SUMMARY: Render once, patch selectively, poll safely with limits. Static content is written to the DOM a single time. Dynamic content (nodeReports, videoAIAnalysis, media) targets specific container elements. Polling is serialized with a guard flag and stops as soon as all async data has arrived or limits are reached (max 30 attempts / 2 minutes).
REQUIRED. Per-language UI string dictionary: { langId: { key: translatedString } }. You invent the keys to match {{KEY}} / window.t('KEY') in landingHtml and recapHtml. Must contain `en` plus every language in `langs` (or every catalog language if `langs` is omitted). All per-language dicts must share the IDENTICAL key set.
REQUIRED. Raw HTML/JS for the pre-session landing page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` — reference them via {{KEY}} placeholders (interpolated at inject time) or via window.t('KEY') (dynamic at runtime). Contract: reads window.__FACESIGN_FLOW__ (the default flow, for display only). MUST call window.__startSession(input?) to launch the session. input may contain only a declared flowId and/or providedData collected by the form; never pass a flow graph from the browser. STYLE GUIDE (Pre-Session Page): Match this visual style for consistency with the FaceSign UI. Background: Light gray #f5f7fa. Full-viewport centered layout (flexbox, min-height: 100vh; min-height: 100dvh — always use dvh with vh fallback for iOS compatibility). Card: White, border-radius 16px, box-shadow 0 4px 24px rgba(0,0,0,.08), padding 2.5-3rem, max-width 480-600px, centered. Headings: Bold, 1.4-1.8rem, color #1a1a2e, centered in card. Inputs: Full-width, padding 14px 16px, border 2px solid #d1d5db, border-radius 12px, font-size 1rem. Focus: border-color #5b7bab. Placeholder color #9ca3af. Primary buttons: Background #7b8fb5 (steel-blue), color white, font-weight 600, font-size 1.05rem, border-radius 50px (pill shape), padding 14px, full-width in card. Hover: background #6a7fa5. Disabled: background #c5cdd8, cursor not-allowed. Links: Color #4573b8, no underline, underline on hover. Back navigation: "← Back" at top-left of card, color #4573b8, font-size 0.95rem. Profile images: Circular (border-radius 50%), 120-150px diameter, centered, subtle box-shadow. Spacing: 2.5-3rem card padding, 1.5rem between form groups, 1rem between label and input, 2rem above primary button. Font: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif. COMMON MISTAKES TO AVOID (UI/CSS): 1. Never set padding or margin on body The custom HTML is injected into a host page that controls its own layout. Setting padding, margin, or min-height on body will conflict with the host page styles and create unwanted spacing. Wrong: body { padding: 2rem; min-height: 100vh; } (Also wrong — using only 100vh without dvh fallback. Always add min-height: 100dvh after 100vh for iOS Safari.) Right — use a wrapper element instead: body { margin: 0; padding: 0; } .wrap { max-width: 860px; margin: 0 auto; padding: 2rem; } The same applies to background on body — avoid it unless you are certain the host page does not set its own background. 2. Use HTML entities for emoji, not JS unicode escapes When building HTML strings in JavaScript (via innerHTML, string concatenation, etc.), JS unicode escapes like \ud83c\udfa5 will NOT render as emoji. They only work inside JS string literals that are directly displayed via textContent or similar APIs. Wrong — renders as garbled text: h += '<div class="title">\ud83c\udfa5 Video AI Analysis</div>'; Right — use HTML numeric entities: h += '<div class="title">🎥 Video AI Analysis</div>'; Also right — use emoji directly in static HTML (outside of JS): <div class="title">🎥 Video AI Analysis</div> Common emoji HTML entities reference: 👤 👤 User/person 🎂 🎂 Birthday cake 📍 📍 Pin/location 💻 💻 Computer ✨ ✨ Sparkles 🔍 🔍 Search 🎥 🎥 Camera 🎬 🎬 Clapper board 📋 📋 Clipboard ⚧ ⚧ Gender symbol ✓ ✓ Checkmark 3. CSS class name collision between landingHtml and recapHtml CRITICAL: landingHtml and recapHtml are injected into the SAME host document. If both fragments use the same class names (e.g., .card, .container, .header), styles from one will leak into the other, causing layout breakage. ALWAYS use unique prefixed class names: - landingHtml (pre-session/landing page): prefix all classes with .lp- (e.g., .lp-card, .lp-header, .lp-btn) - recapHtml (results page): prefix all classes with .r- (e.g., .r-card, .r-header, .r-wrap) Wrong — causes collisions: /* in landingHtml */ .card { max-width: 460px; } /* in recapHtml */ .card { max-width: 900px; } Right — namespaced: /* in landingHtml */ .lp-card { max-width: 460px; } /* in recapHtml */ .r-card { max-width: 900px; } COMMON MISTAKES TO AVOID (Code/API): 4. window.__startSession race condition NEVER call window.__startSession() synchronously in a click handler. The host page may not have injected the function yet. ALWAYS use polling: function waitAndStart(input) { var n = 0; var iv = setInterval(function() { n++; if (typeof window.__startSession === 'function') { clearInterval(iv); window.__startSession(input); } else if (n > 100) { clearInterval(iv); document.body.innerHTML = '<p style="text-align:center;padding:2rem;color:red;">Failed to initialize session. Please refresh.</p>'; } }, 100); } Wrong: startBtn.addEventListener('click', function() { window.__startSession(); }); Right: startBtn.addEventListener('click', function() { waitAndStart(); }); For exported apps, NEVER send window.__FACESIGN_FLOW__ or another graph back to the server. To select a flow declared in export_app, pass its ID: waitAndStart({ flowId: 'enhanced', providedData: { name: nameInput.value } }); 5. Permissions are automatic — do NOT add a permissions node by default FaceSign automatically requests camera and microphone permissions at session start. Most flows do NOT need a PERMISSIONS node. Only add one in these specific cases: (a) The user wants to request microphone and camera permissions separately at different times during the flow (instead of both at once at session start). (b) The user wants to move the permission request to the initial page (landingHtml), outside the FaceSign flow itself. 6. nodeReport.type values are lowercase snake_case The API returns nodeReport.type in lowercase snake_case: "face_compare", "document_scan", "conversation", "permissions", "liveness_detection", etc. — NOT uppercase like "FACE_COMPARE". ALWAYS use case-insensitive comparison when looking up node reports: function getNode(r, type) { var rr = (r && r.nodeReports) || []; var tl = type.toLowerCase(); for (var i = 0; i < rr.length; i++) { if (rr[i].type && rr[i].type.toLowerCase() === tl) return rr[i]; } return null; } // Usage: getNode(report, 'face_compare'), getNode(report, 'document_scan') 7. Microblink document report — nested field structure DOCUMENT_SCAN nodeReport.report fields are NOT plain strings. They use Microblink's nested structure: firstName: { latin: { value: "JANICE" } } dateOfBirth: { originalString: { latin: { value: "04/30/1970" } } } — OR — dateOfBirth: { day: 30, month: 4, year: 1970 } NEVER read fields directly as strings (e.g., dr.firstName will be an object, not "JANICE"). ALWAYS use this safe-value extractor: function sv(v) { if (v == null) return ''; if (typeof v === 'string') return v; if (v.latin && v.latin.value != null) return String(v.latin.value); if (v.originalString) return sv(v.originalString); if (v.day != null && v.month != null && v.year != null) return v.month + '/' + v.day + '/' + v.year; return ''; } // Usage: sv(dr.firstName) → "JANICE", sv(dr.dateOfBirth) → "04/30/1970" 8. videoAIAnalysis criterion is camelCase — format for display The criterion field (e.g., "facialExpressionAndMovement", "useOfExternalDevices") comes in camelCase. Convert to human-readable format: function toStartCase(s) { if (!s) return ''; return s.replace(/([A-Z]+)/g, function(m) { return ' ' + m.toLowerCase(); }) .trim().replace(/^./, function(c) { return c.toUpperCase(); }); } // "facialExpressionAndMovement" → "Facial expression and movement" 9. Conversation node: condition vs prompt In CONVERSATION nodes: - "condition" (in outcomes) = ONLY describes the trigger event for transitioning to the next node (e.g., "User explicitly agrees to proceed") - "prompt" = ALL instructions for the avatar's behavior, including how to greet, how to respond to questions, how to handle objections, and how to persuade - User questions or objections during the conversation are handled within the SAME node (continued dialog), NOT via separate outcomes - Conversation nodes can have any number of outcomes depending on the use case: * Branching nodes (e.g., "what color?") → one outcome per branch + a fallback * Consent/agreement nodes → typically 2: agreement + fallback after N attempts - ALWAYS include a fallback outcome for when the conversation stalls (e.g., "conversation exceeded N exchanges with no condition met" or "user does not want to reply") Wrong — putting behavior instructions in condition: "condition": "User agrees. If they ask questions, answer warmly and ask again" Right — behavior in prompt, condition is just the trigger: "prompt": "Explain the process. If the user has questions, answer them warmly. Once they're ready, confirm." "condition": "User explicitly agrees or says they are ready"
Data processing zone
Optional whitelist of BCP-47 language codes (from facesign://catalog) the exported session may use. DEFAULT BEHAVIOUR (recommended): OMIT this parameter entirely — the app then supports every language in the FaceSign catalog, and `uiStrings` must cover every catalog language. ONLY set `langs` when the user EXPLICITLY restricts the language set (e.g. 'Spanish-only demo', 'support English and Russian'). Do NOT narrow to `['en']` just because the user described the demo in English or did not mention languages. Example (explicit restriction): ["en", "es", "ru"]. The set of target languages for `uiStrings` is derived from this list (or the full catalog if omitted).
Name for the generated app (used in package.json, defaults to 'facesign-app')
Avatar ID from the facesign://catalog resource.
Arbitrary metadata to attach
Optional fallback BCP-47 language code used when the end-user's browser language is not in `langs`. DEFAULT BEHAVIOUR: OMIT this parameter. When set, must be one of the codes in `langs` (if `langs` is also set).
Optional additional flows declared at export time. The landing page selects one by calling window.__startSession({ flowId: 'variant-id' }); the browser never sends a graph.
Pre-known user data
UI customization
Optional schema describing fields the FaceSign backend should extract from the session transcript using an LLM. Results are populated post-session at `session.report.extractedData` as `{ [fieldName]: string | number | boolean | null }` (null when the transcript did not contain the data). Render results in your recapHtml when present.
Your own reference ID for this session
Enable post-session liveness assessment with the selected public policy version. The result is available in session.report.postSessionLiveness after the interaction.
Enable video AI fraud analysis
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Export the current FaceSign session configuration as a standalone, deployable Next.js application. You MUST supply `landingHtml` (pre-session page), `recapHtml` (results page), and `uiStrings` (per-language dictionary whose keys are invented by you to match placeholders in the HTML). The exported app ships NO default chrome — every visible string comes from you. Run with `npm install && npm run dev` or deploy to Vercel after setting FACESIGN_API_KEY.
| Argument | Type | Description |
|---|---|---|
| flow* | array | Array of nodes forming the session's directed graph |
| zone | string | Data processing zone |
| langs | array | Optional whitelist of BCP-47 language codes (from facesign://catalog) the exported session may use. DEFAULT BEHAVIOUR (recommended): OMIT this parameter entirely — the app then supports every language in the FaceSign catalog, and `uiStrings` must cover every catalog language. ONLY set `langs` when the user EXPLICITLY restricts the language set (e.g. 'Spanish-only demo', 'support English and Russian'). Do NOT narrow to `['en']` just because the user described the demo in English or did not mention languages. Example (explicit restriction): ["en", "es", "ru"]. The set of target languages for `uiStrings` is derived from this list (or the full catalog if omitted). |
| appName | string | Name for the generated app (used in package.json, defaults to 'facesign-app') |
| avatarId | string | Avatar ID from the facesign://catalog resource. |
| metadata | object | Arbitrary metadata to attach |
| recapHtml* | string | REQUIRED. Raw HTML/JS for the results/recap page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` (via {{KEY}} or window.t('KEY')). Contract: reads window.__FACESIGN_SESSION__, window.__FACESIGN_SESSION_ID__, window.__refetchSession() (returns Promise with updated session data). The COMMON MISTAKES sections from the `landingHtml` field description apply here too — read them once and follow for both fields. For the complete session data shape (Session, SessionReport, NodeReport types, delayed vs immediate fields), read the `facesign://session-data-types` MCP resource. STYLE GUIDE (Results/Recap Page): Match this visual style for consistency with the FaceSign UI. Background: Light gray #f5f7fa with subtle gradient to light blue at top. Layout: Single-column, max-width 900px, centered (margin 0 auto), padding 2rem. Page header: "Session summary" bold 1.6rem. Subtitle with date/time and duration in muted color #888, font-size 0.9rem. User info card: White card with rounded photo (80-100px), grid of icon+text pairs for age, gender, location, device. Icons in muted blue #6b7faa. Section cards: White background, border-radius 12px, box-shadow 0 2px 12px rgba(0,0,0,.05), padding 1.5rem, margin-bottom 1.5rem. Section headings: Bold 1.15rem, color #1a1a2e, with small emoji/icon prefix (e.g. ✨ AI Analysis, 🔍 Detected Signals, 📋 Transcript). Margin-bottom 1rem. Status banners (full-width within card, border-radius 12px, padding 1rem 1.5rem, white text, bold): - Verified/success: background #4a9d6e, shield ✓ icon - High-risk/warning: background #d97b30, ⚠ warning icon Signal items: Left border 4px solid, padding-left 1rem, margin-bottom 1rem, background white or tinted. - Normal: border-color #059669, light green tint background #f0fdf4 - Suspicious: border-color #f59e0b, light yellow tint background #fefce8 - High-risk: border-color #ef4444, light red tint background #fef2f2 Status badges (inline, pill): border-radius 6px, padding 2px 10px, font-weight 700, font-size 0.8rem, uppercase. - RECOGNIZED/NORMAL: background #d1fae5, color #065f46 - SUSPICIOUS: background #fef3c7, color #92400e Confidence scores: Right-aligned, font-size 0.85rem, color #aaa. Key-value grid: Two-column layout. Label: small text, color #888, font-size 0.8rem, uppercase. Value: font-size 0.95rem, color #1a1a2e, below label. Transcript: Dark background #1e2a3a, border-radius 10px, padding 1.5rem, monospace font. "CONVERSATION LOG" header uppercase, small, muted. Each line: timestamp (gray #777), speaker label (FACESIGN: in teal #4db8a4, USER: in green #6bc96f), message text white. Line-height 1.8. Video: Centered, border-radius 8px, max-width 100%, dark container background. Font: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif. BEST PRACTICES FOR STABLE RENDERING (recapHtml): Session data arrives in two stages: some fields are available immediately when the session ends (user info, AI analysis, transcript), while others require polling. Video AI analysis may take up to 60 seconds; media usually arrives sooner. Naive implementations cause layout jumping (DOM rebuild on each poll) and duplicate network requests. ARCHITECTURE: Split Static vs Dynamic Rendering. renderStatic(data) — called ONCE: Renders all sections that won't change: user info (age, sex, location, device), aiAnalysis.overallSummary, aiAnalysis.analysis list, transcript, documentImages. updateDynamic(data) — called on each poll: Updates ONLY sections whose data arrives asynchronously: nodeReports, videoAIAnalysis, deepfakeDetection, and media (avatarVideo, screenshots). IMPORTANT: nodeReports is DELAYED — do NOT render node report data (face compare results, document scan results, etc.) in renderStatic(). Each dynamic section has its own wrapper element (e.g. <div id="video-ai-content">, <div id="node-reports-content">) so updates replace only that element's innerHTML, leaving the rest untouched. Track completion with boolean flags (videoAIDone, recordingDone, nodeReportsDone). Once a section is populated, skip further updates. Set videoAIDone when videoAIAnalysisStatus is either `succeeded` or `failed`. A failed analysis is terminal: replace the spinner with an unavailable message and do not interpret the missing result as clean evidence. If the status is absent, analysis was not requested, so omit the section. HTML STRUCTURE: <!-- Static sections: rendered once --> <div id="userinfo-card"></div> <div id="summary-card"></div> <div id="analysis-card"></div> <!-- Dynamic sections: inner content updated by polling --> <div id="video-ai-card"> <div class="card"> <div class="card-title">Video AI Analysis</div> <div id="video-ai-content"><!-- spinner initially, replaced when data arrives --></div> </div> </div> <div id="recording-card"> <div class="card"> <div class="card-title">Session Recording</div> <div id="recording-content"><!-- spinner initially, replaced when data arrives --></div> </div> </div> <!-- Static section: rendered once --> <div id="transcript-card"></div> POLLING: Single Entry Point with Guard (IIFE pattern): IMPORTANT: Polling MUST be limited — max 30 attempts, max 2 minutes total. Stop polling when limits are reached even if some data hasn't arrived. (function() { var polling = false; var pollCount = 0; var MAX_POLLS = 30; var startTime = Date.now(); var MAX_DURATION = 2 * 60 * 1000; // 2 minutes var videoAIDone = false; var recordingDone = false; var nodeReportsDone = false; function shouldStop() { return pollCount >= MAX_POLLS || (Date.now() - startTime) >= MAX_DURATION; } function poll() { if (polling) return; if (shouldStop()) return; polling = true; pollCount++; if (typeof window.__refetchSession !== 'function') { polling = false; setTimeout(poll, 2000); return; } window.__refetchSession() .then(function(data) { polling = false; updateDynamic(data); if ((!videoAIDone || !recordingDone || !nodeReportsDone) && !shouldStop()) setTimeout(poll, 4000); }) .catch(function() { polling = false; if (!shouldStop()) setTimeout(poll, 4000); }); } function init() { var data = window.__FACESIGN_SESSION__; if (!data) return; renderStatic(data); var needMore = updateDynamic(data); if (needMore) setTimeout(poll, 4000); } if (window.__FACESIGN_SESSION__) { init(); } else { var chk = setInterval(function() { if (window.__FACESIGN_SESSION__) { clearInterval(chk); init(); } }, 500); } })(); KEY RULES: - Call renderStatic() exactly once — avoids DOM rebuild and layout jumps - updateDynamic() only touches dedicated container elements — no reflow outside the updated section - Use a polling boolean guard — prevents concurrent __refetchSession() calls - ALWAYS limit polling — max 30 attempts AND max 2 minutes total. Never poll indefinitely. - Use videoAIDone / recordingDone / nodeReportsDone flags — stops updating a section once its data has been rendered - For video AI, derive videoAIDone from videoAIAnalysisStatus, not from the presence of videoAIAnalysis alone - nodeReports is DELAYED — always render node report data (face compare, document scan, etc.) in updateDynamic(), never in renderStatic() - Single init() entry point via IIFE — eliminates duplicate initialization paths - Check typeof __refetchSession === 'function' before calling — handles the case where the API isn't injected yet - Use setTimeout not setInterval for polling — ensures the next poll starts only after the previous one completes - nodeReport.type is lowercase snake_case ("face_compare", "document_scan") — use case-insensitive comparison - Document scan report fields are Microblink nested objects — use a safe-value extractor function (see COMMON MISTAKES) - videoAIAnalysis criterion is camelCase — convert to human-readable with toStartCase() (see COMMON MISTAKES) SUMMARY: Render once, patch selectively, poll safely with limits. Static content is written to the DOM a single time. Dynamic content (nodeReports, videoAIAnalysis, media) targets specific container elements. Polling is serialized with a guard flag and stops as soon as all async data has arrived or limits are reached (max 30 attempts / 2 minutes). |
| uiStrings* | object | REQUIRED. Per-language UI string dictionary: { langId: { key: translatedString } }. You invent the keys to match {{KEY}} / window.t('KEY') in landingHtml and recapHtml. Must contain `en` plus every language in `langs` (or every catalog language if `langs` is omitted). All per-language dicts must share the IDENTICAL key set. |
| defaultLang | string | Optional fallback BCP-47 language code used when the end-user's browser language is not in `langs`. DEFAULT BEHAVIOUR: OMIT this parameter. When set, must be one of the codes in `langs` (if `langs` is also set). |
| landingHtml* | string | REQUIRED. Raw HTML/JS for the pre-session landing page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` — reference them via {{KEY}} placeholders (interpolated at inject time) or via window.t('KEY') (dynamic at runtime). Contract: reads window.__FACESIGN_FLOW__ (the default flow, for display only). MUST call window.__startSession(input?) to launch the session. input may contain only a declared flowId and/or providedData collected by the form; never pass a flow graph from the browser. STYLE GUIDE (Pre-Session Page): Match this visual style for consistency with the FaceSign UI. Background: Light gray #f5f7fa. Full-viewport centered layout (flexbox, min-height: 100vh; min-height: 100dvh — always use dvh with vh fallback for iOS compatibility). Card: White, border-radius 16px, box-shadow 0 4px 24px rgba(0,0,0,.08), padding 2.5-3rem, max-width 480-600px, centered. Headings: Bold, 1.4-1.8rem, color #1a1a2e, centered in card. Inputs: Full-width, padding 14px 16px, border 2px solid #d1d5db, border-radius 12px, font-size 1rem. Focus: border-color #5b7bab. Placeholder color #9ca3af. Primary buttons: Background #7b8fb5 (steel-blue), color white, font-weight 600, font-size 1.05rem, border-radius 50px (pill shape), padding 14px, full-width in card. Hover: background #6a7fa5. Disabled: background #c5cdd8, cursor not-allowed. Links: Color #4573b8, no underline, underline on hover. Back navigation: "← Back" at top-left of card, color #4573b8, font-size 0.95rem. Profile images: Circular (border-radius 50%), 120-150px diameter, centered, subtle box-shadow. Spacing: 2.5-3rem card padding, 1.5rem between form groups, 1rem between label and input, 2rem above primary button. Font: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif. COMMON MISTAKES TO AVOID (UI/CSS): 1. Never set padding or margin on body The custom HTML is injected into a host page that controls its own layout. Setting padding, margin, or min-height on body will conflict with the host page styles and create unwanted spacing. Wrong: body { padding: 2rem; min-height: 100vh; } (Also wrong — using only 100vh without dvh fallback. Always add min-height: 100dvh after 100vh for iOS Safari.) Right — use a wrapper element instead: body { margin: 0; padding: 0; } .wrap { max-width: 860px; margin: 0 auto; padding: 2rem; } The same applies to background on body — avoid it unless you are certain the host page does not set its own background. 2. Use HTML entities for emoji, not JS unicode escapes When building HTML strings in JavaScript (via innerHTML, string concatenation, etc.), JS unicode escapes like \ud83c\udfa5 will NOT render as emoji. They only work inside JS string literals that are directly displayed via textContent or similar APIs. Wrong — renders as garbled text: h += '<div class="title">\ud83c\udfa5 Video AI Analysis</div>'; Right — use HTML numeric entities: h += '<div class="title">🎥 Video AI Analysis</div>'; Also right — use emoji directly in static HTML (outside of JS): <div class="title">🎥 Video AI Analysis</div> Common emoji HTML entities reference: 👤 👤 User/person 🎂 🎂 Birthday cake 📍 📍 Pin/location 💻 💻 Computer ✨ ✨ Sparkles 🔍 🔍 Search 🎥 🎥 Camera 🎬 🎬 Clapper board 📋 📋 Clipboard ⚧ ⚧ Gender symbol ✓ ✓ Checkmark 3. CSS class name collision between landingHtml and recapHtml CRITICAL: landingHtml and recapHtml are injected into the SAME host document. If both fragments use the same class names (e.g., .card, .container, .header), styles from one will leak into the other, causing layout breakage. ALWAYS use unique prefixed class names: - landingHtml (pre-session/landing page): prefix all classes with .lp- (e.g., .lp-card, .lp-header, .lp-btn) - recapHtml (results page): prefix all classes with .r- (e.g., .r-card, .r-header, .r-wrap) Wrong — causes collisions: /* in landingHtml */ .card { max-width: 460px; } /* in recapHtml */ .card { max-width: 900px; } Right — namespaced: /* in landingHtml */ .lp-card { max-width: 460px; } /* in recapHtml */ .r-card { max-width: 900px; } COMMON MISTAKES TO AVOID (Code/API): 4. window.__startSession race condition NEVER call window.__startSession() synchronously in a click handler. The host page may not have injected the function yet. ALWAYS use polling: function waitAndStart(input) { var n = 0; var iv = setInterval(function() { n++; if (typeof window.__startSession === 'function') { clearInterval(iv); window.__startSession(input); } else if (n > 100) { clearInterval(iv); document.body.innerHTML = '<p style="text-align:center;padding:2rem;color:red;">Failed to initialize session. Please refresh.</p>'; } }, 100); } Wrong: startBtn.addEventListener('click', function() { window.__startSession(); }); Right: startBtn.addEventListener('click', function() { waitAndStart(); }); For exported apps, NEVER send window.__FACESIGN_FLOW__ or another graph back to the server. To select a flow declared in export_app, pass its ID: waitAndStart({ flowId: 'enhanced', providedData: { name: nameInput.value } }); 5. Permissions are automatic — do NOT add a permissions node by default FaceSign automatically requests camera and microphone permissions at session start. Most flows do NOT need a PERMISSIONS node. Only add one in these specific cases: (a) The user wants to request microphone and camera permissions separately at different times during the flow (instead of both at once at session start). (b) The user wants to move the permission request to the initial page (landingHtml), outside the FaceSign flow itself. 6. nodeReport.type values are lowercase snake_case The API returns nodeReport.type in lowercase snake_case: "face_compare", "document_scan", "conversation", "permissions", "liveness_detection", etc. — NOT uppercase like "FACE_COMPARE". ALWAYS use case-insensitive comparison when looking up node reports: function getNode(r, type) { var rr = (r && r.nodeReports) || []; var tl = type.toLowerCase(); for (var i = 0; i < rr.length; i++) { if (rr[i].type && rr[i].type.toLowerCase() === tl) return rr[i]; } return null; } // Usage: getNode(report, 'face_compare'), getNode(report, 'document_scan') 7. Microblink document report — nested field structure DOCUMENT_SCAN nodeReport.report fields are NOT plain strings. They use Microblink's nested structure: firstName: { latin: { value: "JANICE" } } dateOfBirth: { originalString: { latin: { value: "04/30/1970" } } } — OR — dateOfBirth: { day: 30, month: 4, year: 1970 } NEVER read fields directly as strings (e.g., dr.firstName will be an object, not "JANICE"). ALWAYS use this safe-value extractor: function sv(v) { if (v == null) return ''; if (typeof v === 'string') return v; if (v.latin && v.latin.value != null) return String(v.latin.value); if (v.originalString) return sv(v.originalString); if (v.day != null && v.month != null && v.year != null) return v.month + '/' + v.day + '/' + v.year; return ''; } // Usage: sv(dr.firstName) → "JANICE", sv(dr.dateOfBirth) → "04/30/1970" 8. videoAIAnalysis criterion is camelCase — format for display The criterion field (e.g., "facialExpressionAndMovement", "useOfExternalDevices") comes in camelCase. Convert to human-readable format: function toStartCase(s) { if (!s) return ''; return s.replace(/([A-Z]+)/g, function(m) { return ' ' + m.toLowerCase(); }) .trim().replace(/^./, function(c) { return c.toUpperCase(); }); } // "facialExpressionAndMovement" → "Facial expression and movement" 9. Conversation node: condition vs prompt In CONVERSATION nodes: - "condition" (in outcomes) = ONLY describes the trigger event for transitioning to the next node (e.g., "User explicitly agrees to proceed") - "prompt" = ALL instructions for the avatar's behavior, including how to greet, how to respond to questions, how to handle objections, and how to persuade - User questions or objections during the conversation are handled within the SAME node (continued dialog), NOT via separate outcomes - Conversation nodes can have any number of outcomes depending on the use case: * Branching nodes (e.g., "what color?") → one outcome per branch + a fallback * Consent/agreement nodes → typically 2: agreement + fallback after N attempts - ALWAYS include a fallback outcome for when the conversation stalls (e.g., "conversation exceeded N exchanges with no condition met" or "user does not want to reply") Wrong — putting behavior instructions in condition: "condition": "User agrees. If they ask questions, answer warmly and ask again" Right — behavior in prompt, condition is just the trigger: "prompt": "Explain the process. If the user has questions, answer them warmly. Once they're ready, confirm." "condition": "User explicitly agrees or says they are ready" |
| flowVariants | object | Optional additional flows declared at export time. The landing page selects one by calling window.__startSession({ flowId: 'variant-id' }); the browser never sends a graph. |
| providedData | object | Pre-known user data |
| customization | object | UI customization |
| extractionSchema | array | Optional schema describing fields the FaceSign backend should extract from the session transcript using an LLM. Results are populated post-session at `session.report.extractedData` as `{ [fieldName]: string | number | boolean | null }` (null when the transcript did not contain the data). Render results in your recapHtml when present. |
| clientReferenceId | string | Your own reference ID for this session |
| postSessionLiveness | string | Enable post-session liveness assessment with the selected public policy version. The result is available in session.report.postSessionLiveness after the interaction. |
| videoAIAnalysisEnabled | boolean | Enable video AI fraud analysis |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"flow",
"landingHtml",
"recapHtml",
"uiStrings"
],
"properties": {
"flow": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"type",
"outcome"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "start"
},
"outcome": {
"type": "string",
"description": "The id of the next node"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "end"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "conversation"
},
"prompt": {
"type": "string",
"description": "What the avatar says to the user"
},
"outcomes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"targetNodeId",
"condition"
],
"properties": {
"id": {
"type": "string"
},
"condition": {
"type": "string",
"description": "Condition description, e.g. \"default\", \"user says yes\""
},
"targetNodeId": {
"type": "string",
"description": "The id of the node to route to"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Array of {id, targetNodeId, condition} routing entries"
},
"awaitExternal": {
"type": "object",
"required": [
"request",
"poll",
"exits"
],
"properties": {
"poll": {
"type": "object",
"required": [
"intervalMs",
"timeoutMs"
],
"properties": {
"timeoutMs": {
"type": "number",
"description": "Total time to keep polling before giving up"
},
"intervalMs": {
"type": "number",
"description": "Delay between polls in milliseconds"
}
},
"description": "Polling cadence and overall timeout",
"additionalProperties": false
},
"exits": {
"type": "object",
"required": [
"onDataReady",
"onTimeout",
"onError"
],
"properties": {
"onError": {
"type": "string",
"description": "Node id when the call errors"
},
"onTimeout": {
"type": "string",
"description": "Node id when poll.timeoutMs elapses first"
},
"onDataReady": {
"type": "string",
"description": "Node id when the endpoint returns HTTP 200 (result ready)"
}
},
"description": "Where to route when the background poll resolves",
"additionalProperties": false
},
"request": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Endpoint to call (must pass the server-side allowlist). The current sessionId is appended automatically as a query parameter"
},
"vars": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Key under which the value is placed in the request payload"
},
"value": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "string",
"const": "literal"
},
"value": {
"type": [
"string",
"number",
"boolean"
],
"description": "The literal scalar value"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"source",
"field"
],
"properties": {
"type": {
"type": "string",
"const": "ref"
},
"field": {
"type": "string",
"description": "The field/key name within the source"
},
"source": {
"enum": [
"extractedData",
"providedData"
],
"type": "string",
"description": "Source to resolve the referenced value from"
}
},
"additionalProperties": false
}
],
"description": "Literal value or a reference resolved from session data"
}
},
"additionalProperties": false
},
"description": "Payload variables, each resolving to a literal or a session value"
},
"method": {
"enum": [
"GET",
"POST"
],
"type": "string",
"description": "HTTP method. Defaults to POST (JSON body); GET sends vars as query params"
}
},
"description": "The endpoint to poll in the background",
"additionalProperties": false
}
},
"description": "Optional background poll: the avatar keeps talking (normal outcomes stay active) while an external result becomes ready; exits via onDataReady/onTimeout/onError",
"additionalProperties": false
},
"doesNotRequireReply": {
"type": "boolean",
"description": "If true, avatar speaks without waiting for user reply"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "liveness_detection"
},
"outcomes": {
"type": "object",
"required": [
"livenessDetected",
"deepfakeDetected",
"noFace",
"inconclusive"
],
"properties": {
"noFace": {
"type": "string",
"description": "Node id when frames were captured but no face is on them"
},
"inconclusive": {
"type": "string",
"description": "Node id when the check produced no verdict — the detector could not decide, did not run, or there was nothing to analyse. This is our failure, not the user's: route it to a retry, a step-up or a manual review, never to the happy path by default"
},
"deepfakeDetected": {
"type": "string",
"description": "Node id when deepfake is detected"
},
"livenessDetected": {
"type": "string",
"description": "Node id when liveness is confirmed"
}
},
"description": "Record mapping each outcome to a target node id. All four are required",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "enter_email"
},
"prompt": {
"type": "string",
"description": "Optional phrase the avatar says at the moment the email input field appears (direct speech, e.g. \"Could you please enter your email address?\"). Keep it short — one sentence. Omit to let the avatar stay silent while the field is shown."
},
"outcomes": {
"type": "object",
"required": [
"emailEntered",
"canceled"
],
"properties": {
"canceled": {
"type": "string",
"description": "Node id when user cancels"
},
"emailEntered": {
"type": "string",
"description": "Node id when email is provided"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"validation",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "data_validation"
},
"outcomes": {
"type": "array",
"items": {
"$ref": "#/properties/flow/items/anyOf/2/properties/outcomes/items"
},
"minItems": 1,
"description": "Array of {id, targetNodeId, condition} routing entries"
},
"validation": {
"type": "object",
"required": [
"field",
"action"
],
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
},
"action": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"scanningMode",
"allowedDocumentTypes",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "document_scan"
},
"outcomes": {
"type": "object",
"required": [
"scanSuccess",
"userCancelled",
"scanTimeout"
],
"properties": {
"scanSuccess": {
"type": "string",
"description": "Node id on successful scan"
},
"scanTimeout": {
"type": "string",
"description": "Node id on scan timeout"
},
"userCancelled": {
"type": "string",
"description": "Node id when user cancels"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"scanningMode": {
"enum": [
"single",
"automatic"
],
"type": "string",
"description": "Scanning mode"
},
"allowedDocumentTypes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Allowed document types, e.g. [\"id\", \"passport\", \"dl\"]"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "recognition"
},
"outcomes": {
"type": "object",
"required": [
"recognized",
"newUser",
"noFace"
],
"properties": {
"noFace": {
"type": "string",
"description": "Node id when no face is found"
},
"newUser": {
"type": "string",
"description": "Node id when user is new"
},
"recognized": {
"type": "string",
"description": "Node id when user is recognized"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "face_scan"
},
"outcomes": {
"type": "object",
"required": [
"passed",
"notPassed",
"cancelled",
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Node id on error"
},
"passed": {
"type": "string",
"description": "Node id when face scan passes"
},
"cancelled": {
"type": "string",
"description": "Node id when user cancels"
},
"notPassed": {
"type": "string",
"description": "Node id when face scan fails"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"captureInstructions": {
"type": "string"
},
"similarityThreshold": {
"type": "number",
"description": "0-1, how similar faces must be"
},
"requireAILivenessCheck": {
"type": "boolean"
},
"requireLivenessChallenge": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "two_factor_email"
},
"showUI": {
"type": "boolean",
"description": "Whether to show the OTP input UI"
},
"outcomes": {
"type": "object",
"required": [
"verified",
"delivery_failed",
"failed_unverified",
"cancelled",
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Node id on error"
},
"verified": {
"type": "string",
"description": "Node id when OTP verified"
},
"cancelled": {
"type": "string",
"description": "Node id when user cancels"
},
"delivery_failed": {
"type": "string",
"description": "Node id when delivery fails"
},
"failed_unverified": {
"type": "string",
"description": "Node id when max attempts exhausted"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"otpLength": {
"type": "number",
"description": "OTP length 4-8, default 6"
},
"maxAttempts": {
"type": "number",
"description": "Max verification attempts, default 3"
},
"emailTemplate": {
"type": "string"
},
"expirySeconds": {
"type": "number",
"description": "OTP expiry in seconds, default 300"
},
"resendAfterSeconds": {
"type": "number",
"description": "Seconds before allowing OTP resend"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "two_factor_sms"
},
"showUI": {
"type": "boolean",
"description": "Whether to show the OTP input UI"
},
"outcomes": {
"type": "object",
"required": [
"verified",
"delivery_failed",
"failed_unverified",
"cancelled",
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Node id on error"
},
"verified": {
"type": "string",
"description": "Node id when OTP verified"
},
"cancelled": {
"type": "string",
"description": "Node id when user cancels"
},
"delivery_failed": {
"type": "string",
"description": "Node id when delivery fails"
},
"failed_unverified": {
"type": "string",
"description": "Node id when max attempts exhausted"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"otpLength": {
"type": "number",
"description": "OTP length 4-8, default 6"
},
"maxAttempts": {
"type": "number",
"description": "Max verification attempts, default 3"
},
"smsTemplate": {
"type": "string"
},
"expirySeconds": {
"type": "number",
"description": "OTP expiry in seconds, default 300"
},
"resendAfterSeconds": {
"type": "number",
"description": "Seconds before allowing OTP resend"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"permissions",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "permissions"
},
"prompt": {
"type": "string",
"description": "Optional message the avatar says (direct speech mode, e.g. 'Say: Please enable your camera.')"
},
"outcomes": {
"type": "object",
"required": [
"permissionsGranted",
"permissionsDenied"
],
"properties": {
"permissionsDenied": {
"type": "string",
"description": "Node id when permissions are denied"
},
"permissionsGranted": {
"type": "string",
"description": "Node id when permissions are granted"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"permissions": {
"type": "object",
"properties": {
"camera": {
"type": "boolean",
"description": "Request camera access"
},
"microphone": {
"type": "boolean",
"description": "Request microphone access"
}
},
"description": "Which permissions to request",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"sourceA",
"sourceB",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "face_compare"
},
"sourceA": {
"type": "object",
"required": [
"source"
],
"properties": {
"source": {
"enum": [
"sessionVideo",
"faceScan",
"providedData",
"documentPhoto"
],
"type": "string",
"description": "Source of the face image"
},
"providedDataKey": {
"type": "string",
"description": "Required when source is 'providedData' — the key in providedData that holds the image URL"
}
},
"description": "First face image source",
"additionalProperties": false
},
"sourceB": {
"type": "object",
"required": [
"source"
],
"properties": {
"source": {
"$ref": "#/properties/flow/items/anyOf/12/properties/sourceA/properties/source"
},
"providedDataKey": {
"$ref": "#/properties/flow/items/anyOf/12/properties/sourceA/properties/providedDataKey"
}
},
"description": "Second face image source",
"additionalProperties": false
},
"outcomes": {
"type": "object",
"required": [
"match",
"noMatch",
"imageUnavailable"
],
"properties": {
"match": {
"type": "string",
"description": "Node id when faces match"
},
"noMatch": {
"type": "string",
"description": "Node id when faces do not match"
},
"imageUnavailable": {
"type": "string",
"description": "Node id when one or both images could not be obtained"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"similarityThreshold": {
"type": "number",
"description": "0-1, minimum similarity score required for a match"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"request",
"outcome"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "external_call"
},
"outcome": {
"type": "string",
"description": "Node id to advance to after the response is merged into providedData (never branches)"
},
"request": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/url"
},
"vars": {
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/vars"
},
"method": {
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/method"
}
},
"description": "The external endpoint to call and the payload to send",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"rules",
"default"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "field_condition"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator",
"outcome"
],
"properties": {
"left": {
"type": "object",
"required": [
"source",
"field"
],
"properties": {
"field": {
"type": "string",
"description": "The field/key name within the source"
},
"source": {
"enum": [
"extractedData",
"providedData"
],
"type": "string",
"description": "Where the value is read from: 'extractedData' (a field from extractionSchema, extracted on demand from the transcript) or 'providedData' (a key set at creation or written by a prior external_call)"
}
},
"description": "Reference to the session value to test",
"additionalProperties": false
},
"right": {
"anyOf": [
{
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/vars/items/properties/value/anyOf/0"
},
{
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/vars/items/properties/value/anyOf/1"
}
],
"description": "Literal or reference to compare against; omit for 'exists'/'notExists'"
},
"outcome": {
"type": "string",
"description": "Node id to route to when this rule matches"
},
"operator": {
"enum": [
"equals",
"notEquals",
"gt",
"lt",
"gte",
"lte",
"exists",
"notExists"
],
"type": "string",
"description": "Comparison operator (omit 'right' for 'exists'/'notExists')"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Rules evaluated top-to-bottom; first match wins"
},
"default": {
"type": "string",
"description": "Node id to route to when no rule matches"
}
},
"additionalProperties": false
}
]
},
"description": "Array of nodes forming the session's directed graph"
},
"zone": {
"enum": [
"us",
"eu"
],
"type": "string",
"description": "Data processing zone"
},
"langs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional whitelist of BCP-47 language codes (from facesign://catalog) the exported session may use. DEFAULT BEHAVIOUR (recommended): OMIT this parameter entirely — the app then supports every language in the FaceSign catalog, and `uiStrings` must cover every catalog language. ONLY set `langs` when the user EXPLICITLY restricts the language set (e.g. 'Spanish-only demo', 'support English and Russian'). Do NOT narrow to `['en']` just because the user described the demo in English or did not mention languages. Example (explicit restriction): [\"en\", \"es\", \"ru\"]. The set of target languages for `uiStrings` is derived from this list (or the full catalog if omitted)."
},
"appName": {
"type": "string",
"description": "Name for the generated app (used in package.json, defaults to 'facesign-app')"
},
"avatarId": {
"type": "string",
"description": "Avatar ID from the facesign://catalog resource."
},
"metadata": {
"type": "object",
"description": "Arbitrary metadata to attach",
"additionalProperties": {}
},
"recapHtml": {
"type": "string",
"description": "REQUIRED. Raw HTML/JS for the results/recap page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` (via {{KEY}} or window.t('KEY')). Contract: reads window.__FACESIGN_SESSION__, window.__FACESIGN_SESSION_ID__, window.__refetchSession() (returns Promise with updated session data). The COMMON MISTAKES sections from the `landingHtml` field description apply here too — read them once and follow for both fields. For the complete session data shape (Session, SessionReport, NodeReport types, delayed vs immediate fields), read the `facesign://session-data-types` MCP resource.\n\nSTYLE GUIDE (Results/Recap Page):\nMatch this visual style for consistency with the FaceSign UI.\n\nBackground: Light gray #f5f7fa with subtle gradient to light blue at top.\n\nLayout: Single-column, max-width 900px, centered (margin 0 auto), padding 2rem.\n\nPage header: \"Session summary\" bold 1.6rem. Subtitle with date/time and duration in muted color #888, font-size 0.9rem.\n\nUser info card: White card with rounded photo (80-100px), grid of icon+text pairs for age, gender, location, device. Icons in muted blue #6b7faa.\n\nSection cards: White background, border-radius 12px, box-shadow 0 2px 12px rgba(0,0,0,.05), padding 1.5rem, margin-bottom 1.5rem.\n\nSection headings: Bold 1.15rem, color #1a1a2e, with small emoji/icon prefix (e.g. ✨ AI Analysis, 🔍 Detected Signals, 📋 Transcript). Margin-bottom 1rem.\n\nStatus banners (full-width within card, border-radius 12px, padding 1rem 1.5rem, white text, bold):\n- Verified/success: background #4a9d6e, shield ✓ icon\n- High-risk/warning: background #d97b30, ⚠ warning icon\n\nSignal items: Left border 4px solid, padding-left 1rem, margin-bottom 1rem, background white or tinted.\n- Normal: border-color #059669, light green tint background #f0fdf4\n- Suspicious: border-color #f59e0b, light yellow tint background #fefce8\n- High-risk: border-color #ef4444, light red tint background #fef2f2\n\nStatus badges (inline, pill): border-radius 6px, padding 2px 10px, font-weight 700, font-size 0.8rem, uppercase.\n- RECOGNIZED/NORMAL: background #d1fae5, color #065f46\n- SUSPICIOUS: background #fef3c7, color #92400e\n\nConfidence scores: Right-aligned, font-size 0.85rem, color #aaa.\n\nKey-value grid: Two-column layout. Label: small text, color #888, font-size 0.8rem, uppercase. Value: font-size 0.95rem, color #1a1a2e, below label.\n\nTranscript: Dark background #1e2a3a, border-radius 10px, padding 1.5rem, monospace font. \"CONVERSATION LOG\" header uppercase, small, muted. Each line: timestamp (gray #777), speaker label (FACESIGN: in teal #4db8a4, USER: in green #6bc96f), message text white. Line-height 1.8.\n\nVideo: Centered, border-radius 8px, max-width 100%, dark container background.\n\nFont: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif.\n\n\nBEST PRACTICES FOR STABLE RENDERING (recapHtml):\n\nSession data arrives in two stages: some fields are available immediately when the session ends (user info, AI analysis, transcript), while others require polling. Video AI analysis may take up to 60 seconds; media usually arrives sooner. Naive implementations cause layout jumping (DOM rebuild on each poll) and duplicate network requests.\n\nARCHITECTURE: Split Static vs Dynamic Rendering.\n\nrenderStatic(data) — called ONCE:\nRenders all sections that won't change: user info (age, sex, location, device), aiAnalysis.overallSummary, aiAnalysis.analysis list, transcript, documentImages.\n\nupdateDynamic(data) — called on each poll:\nUpdates ONLY sections whose data arrives asynchronously: nodeReports, videoAIAnalysis, deepfakeDetection, and media (avatarVideo, screenshots).\nIMPORTANT: nodeReports is DELAYED — do NOT render node report data (face compare results, document scan results, etc.) in renderStatic().\nEach dynamic section has its own wrapper element (e.g. <div id=\"video-ai-content\">, <div id=\"node-reports-content\">) so updates replace only that element's innerHTML, leaving the rest untouched.\nTrack completion with boolean flags (videoAIDone, recordingDone, nodeReportsDone). Once a section is populated, skip further updates.\nSet videoAIDone when videoAIAnalysisStatus is either `succeeded` or `failed`. A failed analysis is terminal: replace the spinner with an unavailable message and do not interpret the missing result as clean evidence. If the status is absent, analysis was not requested, so omit the section.\n\nHTML STRUCTURE:\n<!-- Static sections: rendered once -->\n<div id=\"userinfo-card\"></div>\n<div id=\"summary-card\"></div>\n<div id=\"analysis-card\"></div>\n\n<!-- Dynamic sections: inner content updated by polling -->\n<div id=\"video-ai-card\">\n <div class=\"card\">\n <div class=\"card-title\">Video AI Analysis</div>\n <div id=\"video-ai-content\"><!-- spinner initially, replaced when data arrives --></div>\n </div>\n</div>\n\n<div id=\"recording-card\">\n <div class=\"card\">\n <div class=\"card-title\">Session Recording</div>\n <div id=\"recording-content\"><!-- spinner initially, replaced when data arrives --></div>\n </div>\n</div>\n\n<!-- Static section: rendered once -->\n<div id=\"transcript-card\"></div>\n\nPOLLING: Single Entry Point with Guard (IIFE pattern):\nIMPORTANT: Polling MUST be limited — max 30 attempts, max 2 minutes total. Stop polling when limits are reached even if some data hasn't arrived.\n(function() {\n var polling = false;\n var pollCount = 0;\n var MAX_POLLS = 30;\n var startTime = Date.now();\n var MAX_DURATION = 2 * 60 * 1000; // 2 minutes\n var videoAIDone = false;\n var recordingDone = false;\n var nodeReportsDone = false;\n\n function shouldStop() {\n return pollCount >= MAX_POLLS || (Date.now() - startTime) >= MAX_DURATION;\n }\n\n function poll() {\n if (polling) return;\n if (shouldStop()) return;\n polling = true;\n pollCount++;\n if (typeof window.__refetchSession !== 'function') {\n polling = false;\n setTimeout(poll, 2000);\n return;\n }\n window.__refetchSession()\n .then(function(data) {\n polling = false;\n updateDynamic(data);\n if ((!videoAIDone || !recordingDone || !nodeReportsDone) && !shouldStop()) setTimeout(poll, 4000);\n })\n .catch(function() {\n polling = false;\n if (!shouldStop()) setTimeout(poll, 4000);\n });\n }\n\n function init() {\n var data = window.__FACESIGN_SESSION__;\n if (!data) return;\n renderStatic(data);\n var needMore = updateDynamic(data);\n if (needMore) setTimeout(poll, 4000);\n }\n\n if (window.__FACESIGN_SESSION__) {\n init();\n } else {\n var chk = setInterval(function() {\n if (window.__FACESIGN_SESSION__) { clearInterval(chk); init(); }\n }, 500);\n }\n})();\n\nKEY RULES:\n- Call renderStatic() exactly once — avoids DOM rebuild and layout jumps\n- updateDynamic() only touches dedicated container elements — no reflow outside the updated section\n- Use a polling boolean guard — prevents concurrent __refetchSession() calls\n- ALWAYS limit polling — max 30 attempts AND max 2 minutes total. Never poll indefinitely.\n- Use videoAIDone / recordingDone / nodeReportsDone flags — stops updating a section once its data has been rendered\n- For video AI, derive videoAIDone from videoAIAnalysisStatus, not from the presence of videoAIAnalysis alone\n- nodeReports is DELAYED — always render node report data (face compare, document scan, etc.) in updateDynamic(), never in renderStatic()\n- Single init() entry point via IIFE — eliminates duplicate initialization paths\n- Check typeof __refetchSession === 'function' before calling — handles the case where the API isn't injected yet\n- Use setTimeout not setInterval for polling — ensures the next poll starts only after the previous one completes\n- nodeReport.type is lowercase snake_case (\"face_compare\", \"document_scan\") — use case-insensitive comparison\n- Document scan report fields are Microblink nested objects — use a safe-value extractor function (see COMMON MISTAKES)\n- videoAIAnalysis criterion is camelCase — convert to human-readable with toStartCase() (see COMMON MISTAKES)\n\nSUMMARY: Render once, patch selectively, poll safely with limits. Static content is written to the DOM a single time. Dynamic content (nodeReports, videoAIAnalysis, media) targets specific container elements. Polling is serialized with a guard flag and stops as soon as all async data has arrived or limits are reached (max 30 attempts / 2 minutes)."
},
"uiStrings": {
"type": "object",
"description": "REQUIRED. Per-language UI string dictionary: { langId: { key: translatedString } }. You invent the keys to match {{KEY}} / window.t('KEY') in landingHtml and recapHtml. Must contain `en` plus every language in `langs` (or every catalog language if `langs` is omitted). All per-language dicts must share the IDENTICAL key set.",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"defaultLang": {
"type": "string",
"description": "Optional fallback BCP-47 language code used when the end-user's browser language is not in `langs`. DEFAULT BEHAVIOUR: OMIT this parameter. When set, must be one of the codes in `langs` (if `langs` is also set)."
},
"landingHtml": {
"type": "string",
"description": "REQUIRED. Raw HTML/JS for the pre-session landing page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` — reference them via {{KEY}} placeholders (interpolated at inject time) or via window.t('KEY') (dynamic at runtime). Contract: reads window.__FACESIGN_FLOW__ (the default flow, for display only). MUST call window.__startSession(input?) to launch the session. input may contain only a declared flowId and/or providedData collected by the form; never pass a flow graph from the browser.\n\nSTYLE GUIDE (Pre-Session Page):\nMatch this visual style for consistency with the FaceSign UI.\n\nBackground: Light gray #f5f7fa. Full-viewport centered layout (flexbox, min-height: 100vh; min-height: 100dvh — always use dvh with vh fallback for iOS compatibility).\n\nCard: White, border-radius 16px, box-shadow 0 4px 24px rgba(0,0,0,.08), padding 2.5-3rem, max-width 480-600px, centered.\n\nHeadings: Bold, 1.4-1.8rem, color #1a1a2e, centered in card.\n\nInputs: Full-width, padding 14px 16px, border 2px solid #d1d5db, border-radius 12px, font-size 1rem. Focus: border-color #5b7bab. Placeholder color #9ca3af.\n\nPrimary buttons: Background #7b8fb5 (steel-blue), color white, font-weight 600, font-size 1.05rem, border-radius 50px (pill shape), padding 14px, full-width in card. Hover: background #6a7fa5. Disabled: background #c5cdd8, cursor not-allowed.\n\nLinks: Color #4573b8, no underline, underline on hover. Back navigation: \"← Back\" at top-left of card, color #4573b8, font-size 0.95rem.\n\nProfile images: Circular (border-radius 50%), 120-150px diameter, centered, subtle box-shadow.\n\nSpacing: 2.5-3rem card padding, 1.5rem between form groups, 1rem between label and input, 2rem above primary button.\n\nFont: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif.\n\n\nCOMMON MISTAKES TO AVOID (UI/CSS):\n\n1. Never set padding or margin on body\nThe custom HTML is injected into a host page that controls its own layout. Setting padding, margin, or min-height on body will conflict with the host page styles and create unwanted spacing.\n\nWrong:\nbody { padding: 2rem; min-height: 100vh; }\n(Also wrong — using only 100vh without dvh fallback. Always add min-height: 100dvh after 100vh for iOS Safari.)\n\nRight — use a wrapper element instead:\nbody { margin: 0; padding: 0; }\n.wrap { max-width: 860px; margin: 0 auto; padding: 2rem; }\n\nThe same applies to background on body — avoid it unless you are certain the host page does not set its own background.\n\n2. Use HTML entities for emoji, not JS unicode escapes\nWhen building HTML strings in JavaScript (via innerHTML, string concatenation, etc.), JS unicode escapes like \\ud83c\\udfa5 will NOT render as emoji. They only work inside JS string literals that are directly displayed via textContent or similar APIs.\n\nWrong — renders as garbled text:\nh += '<div class=\"title\">\\ud83c\\udfa5 Video AI Analysis</div>';\n\nRight — use HTML numeric entities:\nh += '<div class=\"title\">🎥 Video AI Analysis</div>';\n\nAlso right — use emoji directly in static HTML (outside of JS):\n<div class=\"title\">🎥 Video AI Analysis</div>\n\nCommon emoji HTML entities reference:\n👤 👤 User/person\n🎂 🎂 Birthday cake\n📍 📍 Pin/location\n💻 💻 Computer\n✨ ✨ Sparkles\n🔍 🔍 Search\n🎥 🎥 Camera\n🎬 🎬 Clapper board\n📋 📋 Clipboard\n⚧ ⚧ Gender symbol\n✓ ✓ Checkmark\n\n3. CSS class name collision between landingHtml and recapHtml\nCRITICAL: landingHtml and recapHtml are injected into the SAME host document. If both fragments use the same class names (e.g., .card, .container, .header), styles from one will leak into the other, causing layout breakage.\n\nALWAYS use unique prefixed class names:\n- landingHtml (pre-session/landing page): prefix all classes with .lp- (e.g., .lp-card, .lp-header, .lp-btn)\n- recapHtml (results page): prefix all classes with .r- (e.g., .r-card, .r-header, .r-wrap)\n\nWrong — causes collisions:\n/* in landingHtml */ .card { max-width: 460px; }\n/* in recapHtml */ .card { max-width: 900px; }\n\nRight — namespaced:\n/* in landingHtml */ .lp-card { max-width: 460px; }\n/* in recapHtml */ .r-card { max-width: 900px; }\n\n\nCOMMON MISTAKES TO AVOID (Code/API):\n\n4. window.__startSession race condition\nNEVER call window.__startSession() synchronously in a click handler. The host page may not have injected the function yet. ALWAYS use polling:\n\nfunction waitAndStart(input) {\n var n = 0;\n var iv = setInterval(function() {\n n++;\n if (typeof window.__startSession === 'function') {\n clearInterval(iv);\n window.__startSession(input);\n } else if (n > 100) {\n clearInterval(iv);\n document.body.innerHTML = '<p style=\"text-align:center;padding:2rem;color:red;\">Failed to initialize session. Please refresh.</p>';\n }\n }, 100);\n}\n\nWrong:\nstartBtn.addEventListener('click', function() { window.__startSession(); });\n\nRight:\nstartBtn.addEventListener('click', function() { waitAndStart(); });\n\nFor exported apps, NEVER send window.__FACESIGN_FLOW__ or another graph back to\nthe server. To select a flow declared in export_app, pass its ID:\nwaitAndStart({ flowId: 'enhanced', providedData: { name: nameInput.value } });\n\n5. Permissions are automatic — do NOT add a permissions node by default\nFaceSign automatically requests camera and microphone permissions at session start. Most flows do NOT need a PERMISSIONS node. Only add one in these specific cases:\n(a) The user wants to request microphone and camera permissions separately at different times during the flow (instead of both at once at session start).\n(b) The user wants to move the permission request to the initial page (landingHtml), outside the FaceSign flow itself.\n\n6. nodeReport.type values are lowercase snake_case\nThe API returns nodeReport.type in lowercase snake_case: \"face_compare\", \"document_scan\", \"conversation\", \"permissions\", \"liveness_detection\", etc. — NOT uppercase like \"FACE_COMPARE\".\n\nALWAYS use case-insensitive comparison when looking up node reports:\n\nfunction getNode(r, type) {\n var rr = (r && r.nodeReports) || [];\n var tl = type.toLowerCase();\n for (var i = 0; i < rr.length; i++) {\n if (rr[i].type && rr[i].type.toLowerCase() === tl) return rr[i];\n }\n return null;\n}\n\n// Usage: getNode(report, 'face_compare'), getNode(report, 'document_scan')\n\n7. Microblink document report — nested field structure\nDOCUMENT_SCAN nodeReport.report fields are NOT plain strings. They use Microblink's nested structure:\n firstName: { latin: { value: \"JANICE\" } }\n dateOfBirth: { originalString: { latin: { value: \"04/30/1970\" } } }\n — OR —\n dateOfBirth: { day: 30, month: 4, year: 1970 }\n\nNEVER read fields directly as strings (e.g., dr.firstName will be an object, not \"JANICE\").\n\nALWAYS use this safe-value extractor:\n\nfunction sv(v) {\n if (v == null) return '';\n if (typeof v === 'string') return v;\n if (v.latin && v.latin.value != null) return String(v.latin.value);\n if (v.originalString) return sv(v.originalString);\n if (v.day != null && v.month != null && v.year != null)\n return v.month + '/' + v.day + '/' + v.year;\n return '';\n}\n\n// Usage: sv(dr.firstName) → \"JANICE\", sv(dr.dateOfBirth) → \"04/30/1970\"\n\n8. videoAIAnalysis criterion is camelCase — format for display\nThe criterion field (e.g., \"facialExpressionAndMovement\", \"useOfExternalDevices\") comes in camelCase. Convert to human-readable format:\n\nfunction toStartCase(s) {\n if (!s) return '';\n return s.replace(/([A-Z]+)/g, function(m) { return ' ' + m.toLowerCase(); })\n .trim().replace(/^./, function(c) { return c.toUpperCase(); });\n}\n// \"facialExpressionAndMovement\" → \"Facial expression and movement\"\n\n9. Conversation node: condition vs prompt\nIn CONVERSATION nodes:\n- \"condition\" (in outcomes) = ONLY describes the trigger event for transitioning to the next node (e.g., \"User explicitly agrees to proceed\")\n- \"prompt\" = ALL instructions for the avatar's behavior, including how to greet, how to respond to questions, how to handle objections, and how to persuade\n- User questions or objections during the conversation are handled within the SAME node (continued dialog), NOT via separate outcomes\n- Conversation nodes can have any number of outcomes depending on the use case:\n * Branching nodes (e.g., \"what color?\") → one outcome per branch + a fallback\n * Consent/agreement nodes → typically 2: agreement + fallback after N attempts\n- ALWAYS include a fallback outcome for when the conversation stalls (e.g., \"conversation exceeded N exchanges with no condition met\" or \"user does not want to reply\")\n\nWrong — putting behavior instructions in condition:\n\"condition\": \"User agrees. If they ask questions, answer warmly and ask again\"\n\nRight — behavior in prompt, condition is just the trigger:\n\"prompt\": \"Explain the process. If the user has questions, answer them warmly. Once they're ready, confirm.\"\n\"condition\": \"User explicitly agrees or says they are ready\""
},
"flowVariants": {
"type": "object",
"description": "Optional additional flows declared at export time. The landing page selects one by calling window.__startSession({ flowId: 'variant-id' }); the browser never sends a graph.",
"propertyNames": {
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 64,
"minLength": 1
},
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/properties/flow/items"
}
}
},
"providedData": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
}
},
"description": "Pre-known user data",
"additionalProperties": true
},
"customization": {
"type": "object",
"properties": {
"controls": {
"type": "object",
"properties": {
"buttons": {
"type": "array",
"items": {
"enum": [
"microphone",
"camera",
"captions",
"language",
"close"
],
"type": "string"
},
"description": "Optional exact subset of in-session control buttons. Omit this field for the recommended default panel with all applicable controls. Set it only when the user requests a specialized flow or UI; for example, [\"captions\"] creates a captions-only panel, while an empty array hides the panel. Ignored when showUxControls is false"
},
"autoHide": {
"type": "boolean",
"description": "Whether controls may automatically fade out. Omitted or true preserves the default behavior; false keeps the selected buttons visible. Ignored when showUxControls is false"
},
"showUxControls": {
"type": "boolean",
"description": "Master switch for the in-session control panel. When false the panel is not rendered and every other controls.* setting has no effect"
},
"captionsOpenedByDefault": {
"type": "boolean",
"description": "Start the session with the closed-captions (transcript) panel open. Omitted or false keeps it closed. The user can toggle it with the CC button either way. Set it for accessibility, or when viewers may be reading along in a second language. Ignored when showUxControls is false"
}
},
"additionalProperties": false
},
"permissionsPage": {
"type": "object",
"properties": {
"buttonText": {
"type": "string"
},
"subheading": {
"type": "string"
},
"mainHeading": {
"type": "string"
},
"backgroundType": {
"enum": [
"AVATAR",
"COLOR"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"buttonTextTranslates": {
"type": "object",
"description": "Localized permission-button text, for example { es: 'Continuar' }",
"additionalProperties": {
"type": "string"
}
},
"subheadingTranslates": {
"$ref": "#/properties/customization/properties/permissionsPage/properties/buttonTextTranslates",
"description": "Localized permission-page subheadings"
},
"mainHeadingTranslates": {
"$ref": "#/properties/customization/properties/permissionsPage/properties/buttonTextTranslates",
"description": "Localized permission-page headings"
}
},
"additionalProperties": false
}
},
"description": "UI customization",
"additionalProperties": false
},
"extractionSchema": {
"type": "array",
"items": {
"type": "object",
"required": [
"fieldName",
"type",
"description"
],
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional allowed string values. When set, the LLM normalizes free-form answers into one of the listed values."
},
"type": {
"enum": [
"string",
"number",
"boolean",
"date"
],
"type": "string",
"description": "Expected value type. `date` is returned as an ISO 8601 string."
},
"fieldName": {
"type": "string",
"description": "Key under which the extracted value appears in session.report.extractedData."
},
"description": {
"type": "string",
"description": "Natural-language hint for the LLM describing what to look for in the transcript. This is the primary extraction signal — be specific."
}
},
"additionalProperties": false
},
"description": "Optional schema describing fields the FaceSign backend should extract from the session transcript using an LLM. Results are populated post-session at `session.report.extractedData` as `{ [fieldName]: string | number | boolean | null }` (null when the transcript did not contain the data). Render results in your recapHtml when present."
},
"clientReferenceId": {
"type": "string",
"description": "Your own reference ID for this session"
},
"postSessionLiveness": {
"enum": [
"v1",
"v2"
],
"type": "string",
"description": "Enable post-session liveness assessment with the selected public policy version. The result is available in session.report.postSessionLiveness after the interaction."
},
"videoAIAnalysisEnabled": {
"type": "boolean",
"description": "Enable video AI fraud analysis"
}
},
"additionalProperties": false
}Retrieve detailed information about a FaceSign session including status, transcript, AI analysis, node reports, video AI analysis, and asynchronous analysis lifecycle states.
| Argument | Type | Description |
|---|---|---|
| sessionId* | string | The session ID to retrieve |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sessionId"
],
"properties": {
"sessionId": {
"type": "string",
"description": "The session ID to retrieve"
}
},
"additionalProperties": false
}REQUIRES set_api_key to be called first. Launch a local web page in the browser for a FaceSign session. You MUST supply `landingHtml` (the pre-session page shown before the iframe), `recapHtml` (the results page shown after the session finishes), and `uiStrings` (a per-language dictionary whose keys are invented by you to match placeholders in the HTML). The MCP server provides NO default chrome — every visible string comes from you. Each page load / refresh creates a fresh session.
| Argument | Type | Description |
|---|---|---|
| flow* | array | Array of nodes forming the session's directed graph |
| zone | string | Data processing zone |
| langs | array | Optional whitelist of BCP-47 language codes (from facesign://catalog) the session may use. DEFAULT BEHAVIOUR (recommended): OMIT this parameter entirely — the session then supports every language in the FaceSign catalog, and `uiStrings` must cover every catalog language. ONLY set `langs` when the user EXPLICITLY restricts the language set (e.g. 'Spanish-only demo', 'support English and Russian'). Do NOT narrow to `['en']` just because the user described the demo in English or did not mention languages — that would silently drop multilingual support. Example (explicit restriction): ["en", "es", "ru"]. The set of target languages for `uiStrings` is derived from this list (or the full catalog if omitted). |
| avatarId | string | Avatar ID from the facesign://catalog resource. |
| metadata | object | Arbitrary metadata to attach |
| recapHtml |
List FaceSign sessions with optional filtering by status, date range, and search term. Supports pagination via cursor.
| Argument | Type | Description |
|---|---|---|
| limit | number | Max sessions to return (1-100, default 10) |
| cursor | string | Pagination cursor from a previous response |
| flowId | string | Filter sessions by flow ID |
| search | string | Search term to filter sessions |
| sortBy | string | Field to sort by |
| status | any | Filter by session status |
| toDate | number | End of date range (Unix timestamp in ms) |
| fromDate | number | Start of date range (Unix timestamp in ms) |
| sortOrder | string | Sort direction |
| clientReferenceId | string | Filter by client reference ID |
Set your FaceSign API key for this session. This must be called before any other FaceSign tools. Get your API key from the FaceSign dashboard. The key starts with sk_live_... or sk_test_... Optionally override the API server URL via `serverUrl` — intended for FaceSign developers pointing the SDK at a non-production backend (e.g. a dev server). Leave unset to use the default production API.
| Argument | Type | Description |
|---|---|---|
| apiKey* | string | Your FaceSign API key (sk_live_... or sk_test_...) |
| serverUrl | string | Optional FaceSign API server URL override. Only set this if the user explicitly asks to target a non-default server (e.g. a dev backend). Omit otherwise to use the production API. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"apiKey"
],
"properties": {
"apiKey": {
"type": "string",
"description": "Your FaceSign API key (sk_live_... or sk_test_...)"
},
"serverUrl": {
"type": "string",
"format": "uri",
"description": "Optional FaceSign API server URL override. Only set this if the user explicitly asks to target a non-default server (e.g. a dev backend). Omit otherwise to use the production API."
}
},
"additionalProperties": false
}| string |
| REQUIRED. Raw HTML/JS for the results/recap page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` (via {{KEY}} or window.t('KEY')). Contract: reads window.__FACESIGN_SESSION__ (session data, re-populated on each poll), window.__FACESIGN_SESSION_ID__, window.__refetchSession() (returns Promise with updated data). The COMMON MISTAKES sections from the `landingHtml` field description apply here too — read them once and follow for both fields. For the complete session data shape (Session, SessionReport, NodeReport types, delayed vs immediate fields), read the `facesign://session-data-types` MCP resource. STYLE GUIDE (Results/Recap Page): Match this visual style for consistency with the FaceSign UI. Background: Light gray #f5f7fa with subtle gradient to light blue at top. Layout: Single-column, max-width 900px, centered (margin 0 auto), padding 2rem. Page header: "Session summary" bold 1.6rem. Subtitle with date/time and duration in muted color #888, font-size 0.9rem. User info card: White card with rounded photo (80-100px), grid of icon+text pairs for age, gender, location, device. Icons in muted blue #6b7faa. Section cards: White background, border-radius 12px, box-shadow 0 2px 12px rgba(0,0,0,.05), padding 1.5rem, margin-bottom 1.5rem. Section headings: Bold 1.15rem, color #1a1a2e, with small emoji/icon prefix (e.g. ✨ AI Analysis, 🔍 Detected Signals, 📋 Transcript). Margin-bottom 1rem. Status banners (full-width within card, border-radius 12px, padding 1rem 1.5rem, white text, bold): - Verified/success: background #4a9d6e, shield ✓ icon - High-risk/warning: background #d97b30, ⚠ warning icon Signal items: Left border 4px solid, padding-left 1rem, margin-bottom 1rem, background white or tinted. - Normal: border-color #059669, light green tint background #f0fdf4 - Suspicious: border-color #f59e0b, light yellow tint background #fefce8 - High-risk: border-color #ef4444, light red tint background #fef2f2 Status badges (inline, pill): border-radius 6px, padding 2px 10px, font-weight 700, font-size 0.8rem, uppercase. - RECOGNIZED/NORMAL: background #d1fae5, color #065f46 - SUSPICIOUS: background #fef3c7, color #92400e Confidence scores: Right-aligned, font-size 0.85rem, color #aaa. Key-value grid: Two-column layout. Label: small text, color #888, font-size 0.8rem, uppercase. Value: font-size 0.95rem, color #1a1a2e, below label. Transcript: Dark background #1e2a3a, border-radius 10px, padding 1.5rem, monospace font. "CONVERSATION LOG" header uppercase, small, muted. Each line: timestamp (gray #777), speaker label (FACESIGN: in teal #4db8a4, USER: in green #6bc96f), message text white. Line-height 1.8. Video: Centered, border-radius 8px, max-width 100%, dark container background. Font: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif. BEST PRACTICES FOR STABLE RENDERING (recapHtml): Session data arrives in two stages: some fields are available immediately when the session ends (user info, AI analysis, transcript), while others require polling. Video AI analysis may take up to 60 seconds; media usually arrives sooner. Naive implementations cause layout jumping (DOM rebuild on each poll) and duplicate network requests. ARCHITECTURE: Split Static vs Dynamic Rendering. renderStatic(data) — called ONCE: Renders all sections that won't change: user info (age, sex, location, device), aiAnalysis.overallSummary, aiAnalysis.analysis list, transcript, documentImages. updateDynamic(data) — called on each poll: Updates ONLY sections whose data arrives asynchronously: nodeReports, videoAIAnalysis, deepfakeDetection, and media (avatarVideo, screenshots). IMPORTANT: nodeReports is DELAYED — do NOT render node report data (face compare results, document scan results, etc.) in renderStatic(). Each dynamic section has its own wrapper element (e.g. <div id="video-ai-content">, <div id="node-reports-content">) so updates replace only that element's innerHTML, leaving the rest untouched. Track completion with boolean flags (videoAIDone, recordingDone, nodeReportsDone). Once a section is populated, skip further updates. Set videoAIDone when videoAIAnalysisStatus is either `succeeded` or `failed`. A failed analysis is terminal: replace the spinner with an unavailable message and do not interpret the missing result as clean evidence. If the status is absent, analysis was not requested, so omit the section. HTML STRUCTURE: <!-- Static sections: rendered once --> <div id="userinfo-card"></div> <div id="summary-card"></div> <div id="analysis-card"></div> <!-- Dynamic sections: inner content updated by polling --> <div id="video-ai-card"> <div class="card"> <div class="card-title">Video AI Analysis</div> <div id="video-ai-content"><!-- spinner initially, replaced when data arrives --></div> </div> </div> <div id="recording-card"> <div class="card"> <div class="card-title">Session Recording</div> <div id="recording-content"><!-- spinner initially, replaced when data arrives --></div> </div> </div> <!-- Static section: rendered once --> <div id="transcript-card"></div> POLLING: Single Entry Point with Guard (IIFE pattern): IMPORTANT: Polling MUST be limited — max 30 attempts, max 2 minutes total. Stop polling when limits are reached even if some data hasn't arrived. (function() { var polling = false; var pollCount = 0; var MAX_POLLS = 30; var startTime = Date.now(); var MAX_DURATION = 2 * 60 * 1000; // 2 minutes var videoAIDone = false; var recordingDone = false; var nodeReportsDone = false; function shouldStop() { return pollCount >= MAX_POLLS || (Date.now() - startTime) >= MAX_DURATION; } function poll() { if (polling) return; if (shouldStop()) return; polling = true; pollCount++; if (typeof window.__refetchSession !== 'function') { polling = false; setTimeout(poll, 2000); return; } window.__refetchSession() .then(function(data) { polling = false; updateDynamic(data); if ((!videoAIDone || !recordingDone || !nodeReportsDone) && !shouldStop()) setTimeout(poll, 4000); }) .catch(function() { polling = false; if (!shouldStop()) setTimeout(poll, 4000); }); } function init() { var data = window.__FACESIGN_SESSION__; if (!data) return; renderStatic(data); var needMore = updateDynamic(data); if (needMore) setTimeout(poll, 4000); } if (window.__FACESIGN_SESSION__) { init(); } else { var chk = setInterval(function() { if (window.__FACESIGN_SESSION__) { clearInterval(chk); init(); } }, 500); } })(); KEY RULES: - Call renderStatic() exactly once — avoids DOM rebuild and layout jumps - updateDynamic() only touches dedicated container elements — no reflow outside the updated section - Use a polling boolean guard — prevents concurrent __refetchSession() calls - ALWAYS limit polling — max 30 attempts AND max 2 minutes total. Never poll indefinitely. - Use videoAIDone / recordingDone / nodeReportsDone flags — stops updating a section once its data has been rendered - For video AI, derive videoAIDone from videoAIAnalysisStatus, not from the presence of videoAIAnalysis alone - nodeReports is DELAYED — always render node report data (face compare, document scan, etc.) in updateDynamic(), never in renderStatic() - Single init() entry point via IIFE — eliminates duplicate initialization paths - Check typeof __refetchSession === 'function' before calling — handles the case where the API isn't injected yet - Use setTimeout not setInterval for polling — ensures the next poll starts only after the previous one completes - nodeReport.type is lowercase snake_case ("face_compare", "document_scan") — use case-insensitive comparison - Document scan report fields are Microblink nested objects — use a safe-value extractor function (see COMMON MISTAKES) - videoAIAnalysis criterion is camelCase — convert to human-readable with toStartCase() (see COMMON MISTAKES) SUMMARY: Render once, patch selectively, poll safely with limits. Static content is written to the DOM a single time. Dynamic content (nodeReports, videoAIAnalysis, media) targets specific container elements. Polling is serialized with a guard flag and stops as soon as all async data has arrived or limits are reached (max 30 attempts / 2 minutes). |
| uiStrings* | object | REQUIRED. Per-language UI string dictionary: { langId: { key: translatedString } }. You invent the keys to match the {{KEY}} placeholders / window.t('KEY') calls in your landingHtml and recapHtml. Must contain an entry for `en` (ultimate runtime fallback) and for every language in `langs` (or every catalog language if `langs` is omitted). Every per-language dict must share the IDENTICAL set of keys. Example: { "en": { "START": "Start", "LOADING": "Loading..." }, "fr": { "START": "Commencer", "LOADING": "Chargement..." } }. |
| defaultLang | string | Optional fallback BCP-47 language code used when the end-user's browser language is not in `langs`. DEFAULT BEHAVIOUR: OMIT this parameter. The MCP server falls back to 'en' internally only as a last-resort for UI string lookup; you should not hardcode a default language here unless the user explicitly asks for one. When set, must be one of the codes in `langs` (if `langs` is also set). |
| landingHtml* | string | REQUIRED. Raw HTML/JS for the pre-session landing page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` — reference them via {{KEY}} placeholders (interpolated at inject time) or via window.t('KEY') (dynamic at runtime). Contract: reads window.__FACESIGN_FLOW__ (the flow array). MUST call window.__startSession(updatedFlow?) to launch the session. The session iframe has its own Start button for audio/video autoplay gesture — the landing page does NOT need one for that purpose. STYLE GUIDE (Pre-Session Page): Match this visual style for consistency with the FaceSign UI. Background: Light gray #f5f7fa. Full-viewport centered layout (flexbox, min-height: 100vh; min-height: 100dvh — always use dvh with vh fallback for iOS compatibility). Card: White, border-radius 16px, box-shadow 0 4px 24px rgba(0,0,0,.08), padding 2.5-3rem, max-width 480-600px, centered. Headings: Bold, 1.4-1.8rem, color #1a1a2e, centered in card. Inputs: Full-width, padding 14px 16px, border 2px solid #d1d5db, border-radius 12px, font-size 1rem. Focus: border-color #5b7bab. Placeholder color #9ca3af. Primary buttons: Background #7b8fb5 (steel-blue), color white, font-weight 600, font-size 1.05rem, border-radius 50px (pill shape), padding 14px, full-width in card. Hover: background #6a7fa5. Disabled: background #c5cdd8, cursor not-allowed. Links: Color #4573b8, no underline, underline on hover. Back navigation: "← Back" at top-left of card, color #4573b8, font-size 0.95rem. Profile images: Circular (border-radius 50%), 120-150px diameter, centered, subtle box-shadow. Spacing: 2.5-3rem card padding, 1.5rem between form groups, 1rem between label and input, 2rem above primary button. Font: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif. COMMON MISTAKES TO AVOID (UI/CSS): 1. Never set padding or margin on body The custom HTML is injected into a host page that controls its own layout. Setting padding, margin, or min-height on body will conflict with the host page styles and create unwanted spacing. Wrong: body { padding: 2rem; min-height: 100vh; } (Also wrong — using only 100vh without dvh fallback. Always add min-height: 100dvh after 100vh for iOS Safari.) Right — use a wrapper element instead: body { margin: 0; padding: 0; } .wrap { max-width: 860px; margin: 0 auto; padding: 2rem; } The same applies to background on body — avoid it unless you are certain the host page does not set its own background. 2. Use HTML entities for emoji, not JS unicode escapes When building HTML strings in JavaScript (via innerHTML, string concatenation, etc.), JS unicode escapes like \ud83c\udfa5 will NOT render as emoji. They only work inside JS string literals that are directly displayed via textContent or similar APIs. Wrong — renders as garbled text: h += '<div class="title">\ud83c\udfa5 Video AI Analysis</div>'; Right — use HTML numeric entities: h += '<div class="title">🎥 Video AI Analysis</div>'; Also right — use emoji directly in static HTML (outside of JS): <div class="title">🎥 Video AI Analysis</div> Common emoji HTML entities reference: 👤 👤 User/person 🎂 🎂 Birthday cake 📍 📍 Pin/location 💻 💻 Computer ✨ ✨ Sparkles 🔍 🔍 Search 🎥 🎥 Camera 🎬 🎬 Clapper board 📋 📋 Clipboard ⚧ ⚧ Gender symbol ✓ ✓ Checkmark 3. CSS class name collision between landingHtml and recapHtml CRITICAL: landingHtml and recapHtml are injected into the SAME host document. If both fragments use the same class names (e.g., .card, .container, .header), styles from one will leak into the other, causing layout breakage. ALWAYS use unique prefixed class names: - landingHtml (pre-session/landing page): prefix all classes with .lp- (e.g., .lp-card, .lp-header, .lp-btn) - recapHtml (results page): prefix all classes with .r- (e.g., .r-card, .r-header, .r-wrap) Wrong — causes collisions: /* in landingHtml */ .card { max-width: 460px; } /* in recapHtml */ .card { max-width: 900px; } Right — namespaced: /* in landingHtml */ .lp-card { max-width: 460px; } /* in recapHtml */ .r-card { max-width: 900px; } COMMON MISTAKES TO AVOID (Code/API): 4. window.__startSession race condition NEVER call window.__startSession() synchronously in a click handler. The host page may not have injected the function yet. ALWAYS use polling: function waitAndStart(input) { var n = 0; var iv = setInterval(function() { n++; if (typeof window.__startSession === 'function') { clearInterval(iv); window.__startSession(input); } else if (n > 100) { clearInterval(iv); document.body.innerHTML = '<p style="text-align:center;padding:2rem;color:red;">Failed to initialize session. Please refresh.</p>'; } }, 100); } Wrong: startBtn.addEventListener('click', function() { window.__startSession(); }); Right: startBtn.addEventListener('click', function() { waitAndStart(); }); For exported apps, NEVER send window.__FACESIGN_FLOW__ or another graph back to the server. To select a flow declared in export_app, pass its ID: waitAndStart({ flowId: 'enhanced', providedData: { name: nameInput.value } }); 5. Permissions are automatic — do NOT add a permissions node by default FaceSign automatically requests camera and microphone permissions at session start. Most flows do NOT need a PERMISSIONS node. Only add one in these specific cases: (a) The user wants to request microphone and camera permissions separately at different times during the flow (instead of both at once at session start). (b) The user wants to move the permission request to the initial page (landingHtml), outside the FaceSign flow itself. 6. nodeReport.type values are lowercase snake_case The API returns nodeReport.type in lowercase snake_case: "face_compare", "document_scan", "conversation", "permissions", "liveness_detection", etc. — NOT uppercase like "FACE_COMPARE". ALWAYS use case-insensitive comparison when looking up node reports: function getNode(r, type) { var rr = (r && r.nodeReports) || []; var tl = type.toLowerCase(); for (var i = 0; i < rr.length; i++) { if (rr[i].type && rr[i].type.toLowerCase() === tl) return rr[i]; } return null; } // Usage: getNode(report, 'face_compare'), getNode(report, 'document_scan') 7. Microblink document report — nested field structure DOCUMENT_SCAN nodeReport.report fields are NOT plain strings. They use Microblink's nested structure: firstName: { latin: { value: "JANICE" } } dateOfBirth: { originalString: { latin: { value: "04/30/1970" } } } — OR — dateOfBirth: { day: 30, month: 4, year: 1970 } NEVER read fields directly as strings (e.g., dr.firstName will be an object, not "JANICE"). ALWAYS use this safe-value extractor: function sv(v) { if (v == null) return ''; if (typeof v === 'string') return v; if (v.latin && v.latin.value != null) return String(v.latin.value); if (v.originalString) return sv(v.originalString); if (v.day != null && v.month != null && v.year != null) return v.month + '/' + v.day + '/' + v.year; return ''; } // Usage: sv(dr.firstName) → "JANICE", sv(dr.dateOfBirth) → "04/30/1970" 8. videoAIAnalysis criterion is camelCase — format for display The criterion field (e.g., "facialExpressionAndMovement", "useOfExternalDevices") comes in camelCase. Convert to human-readable format: function toStartCase(s) { if (!s) return ''; return s.replace(/([A-Z]+)/g, function(m) { return ' ' + m.toLowerCase(); }) .trim().replace(/^./, function(c) { return c.toUpperCase(); }); } // "facialExpressionAndMovement" → "Facial expression and movement" 9. Conversation node: condition vs prompt In CONVERSATION nodes: - "condition" (in outcomes) = ONLY describes the trigger event for transitioning to the next node (e.g., "User explicitly agrees to proceed") - "prompt" = ALL instructions for the avatar's behavior, including how to greet, how to respond to questions, how to handle objections, and how to persuade - User questions or objections during the conversation are handled within the SAME node (continued dialog), NOT via separate outcomes - Conversation nodes can have any number of outcomes depending on the use case: * Branching nodes (e.g., "what color?") → one outcome per branch + a fallback * Consent/agreement nodes → typically 2: agreement + fallback after N attempts - ALWAYS include a fallback outcome for when the conversation stalls (e.g., "conversation exceeded N exchanges with no condition met" or "user does not want to reply") Wrong — putting behavior instructions in condition: "condition": "User agrees. If they ask questions, answer warmly and ask again" Right — behavior in prompt, condition is just the trigger: "prompt": "Explain the process. If the user has questions, answer them warmly. Once they're ready, confirm." "condition": "User explicitly agrees or says they are ready" |
| providedData | object | Pre-known user data |
| customization | object | UI customization |
| extractionSchema | array | Optional schema describing fields the FaceSign backend should extract from the session transcript using an LLM. Results are populated post-session at `session.report.extractedData` as `{ [fieldName]: string | number | boolean | null }` (null when the transcript did not contain the data — every field is treated as optional). Use this for structured data collection that does NOT need its own dedicated node — e.g. follow-up questions in a single CONVERSATION node where you'd otherwise have to author multiple branching outcomes. The conversation flow itself is unaffected; extraction runs on the final transcript. Render the results in your recapHtml when present. |
| clientReferenceId | string | Your own reference ID for this session |
| postSessionLiveness | string | Enable post-session liveness assessment with the selected public policy version. The result is available in session.report.postSessionLiveness after the interaction. |
| videoAIAnalysisEnabled | boolean | Enable video AI fraud analysis |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"flow",
"landingHtml",
"recapHtml",
"uiStrings"
],
"properties": {
"flow": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"type",
"outcome"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "start"
},
"outcome": {
"type": "string",
"description": "The id of the next node"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "end"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "conversation"
},
"prompt": {
"type": "string",
"description": "What the avatar says to the user"
},
"outcomes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"targetNodeId",
"condition"
],
"properties": {
"id": {
"type": "string"
},
"condition": {
"type": "string",
"description": "Condition description, e.g. \"default\", \"user says yes\""
},
"targetNodeId": {
"type": "string",
"description": "The id of the node to route to"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Array of {id, targetNodeId, condition} routing entries"
},
"awaitExternal": {
"type": "object",
"required": [
"request",
"poll",
"exits"
],
"properties": {
"poll": {
"type": "object",
"required": [
"intervalMs",
"timeoutMs"
],
"properties": {
"timeoutMs": {
"type": "number",
"description": "Total time to keep polling before giving up"
},
"intervalMs": {
"type": "number",
"description": "Delay between polls in milliseconds"
}
},
"description": "Polling cadence and overall timeout",
"additionalProperties": false
},
"exits": {
"type": "object",
"required": [
"onDataReady",
"onTimeout",
"onError"
],
"properties": {
"onError": {
"type": "string",
"description": "Node id when the call errors"
},
"onTimeout": {
"type": "string",
"description": "Node id when poll.timeoutMs elapses first"
},
"onDataReady": {
"type": "string",
"description": "Node id when the endpoint returns HTTP 200 (result ready)"
}
},
"description": "Where to route when the background poll resolves",
"additionalProperties": false
},
"request": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Endpoint to call (must pass the server-side allowlist). The current sessionId is appended automatically as a query parameter"
},
"vars": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Key under which the value is placed in the request payload"
},
"value": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "string",
"const": "literal"
},
"value": {
"type": [
"string",
"number",
"boolean"
],
"description": "The literal scalar value"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"source",
"field"
],
"properties": {
"type": {
"type": "string",
"const": "ref"
},
"field": {
"type": "string",
"description": "The field/key name within the source"
},
"source": {
"enum": [
"extractedData",
"providedData"
],
"type": "string",
"description": "Source to resolve the referenced value from"
}
},
"additionalProperties": false
}
],
"description": "Literal value or a reference resolved from session data"
}
},
"additionalProperties": false
},
"description": "Payload variables, each resolving to a literal or a session value"
},
"method": {
"enum": [
"GET",
"POST"
],
"type": "string",
"description": "HTTP method. Defaults to POST (JSON body); GET sends vars as query params"
}
},
"description": "The endpoint to poll in the background",
"additionalProperties": false
}
},
"description": "Optional background poll: the avatar keeps talking (normal outcomes stay active) while an external result becomes ready; exits via onDataReady/onTimeout/onError",
"additionalProperties": false
},
"doesNotRequireReply": {
"type": "boolean",
"description": "If true, avatar speaks without waiting for user reply"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "liveness_detection"
},
"outcomes": {
"type": "object",
"required": [
"livenessDetected",
"deepfakeDetected",
"noFace",
"inconclusive"
],
"properties": {
"noFace": {
"type": "string",
"description": "Node id when frames were captured but no face is on them"
},
"inconclusive": {
"type": "string",
"description": "Node id when the check produced no verdict — the detector could not decide, did not run, or there was nothing to analyse. This is our failure, not the user's: route it to a retry, a step-up or a manual review, never to the happy path by default"
},
"deepfakeDetected": {
"type": "string",
"description": "Node id when deepfake is detected"
},
"livenessDetected": {
"type": "string",
"description": "Node id when liveness is confirmed"
}
},
"description": "Record mapping each outcome to a target node id. All four are required",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "enter_email"
},
"prompt": {
"type": "string",
"description": "Optional phrase the avatar says at the moment the email input field appears (direct speech, e.g. \"Could you please enter your email address?\"). Keep it short — one sentence. Omit to let the avatar stay silent while the field is shown."
},
"outcomes": {
"type": "object",
"required": [
"emailEntered",
"canceled"
],
"properties": {
"canceled": {
"type": "string",
"description": "Node id when user cancels"
},
"emailEntered": {
"type": "string",
"description": "Node id when email is provided"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"validation",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "data_validation"
},
"outcomes": {
"type": "array",
"items": {
"$ref": "#/properties/flow/items/anyOf/2/properties/outcomes/items"
},
"minItems": 1,
"description": "Array of {id, targetNodeId, condition} routing entries"
},
"validation": {
"type": "object",
"required": [
"field",
"action"
],
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
},
"action": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"scanningMode",
"allowedDocumentTypes",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "document_scan"
},
"outcomes": {
"type": "object",
"required": [
"scanSuccess",
"userCancelled",
"scanTimeout"
],
"properties": {
"scanSuccess": {
"type": "string",
"description": "Node id on successful scan"
},
"scanTimeout": {
"type": "string",
"description": "Node id on scan timeout"
},
"userCancelled": {
"type": "string",
"description": "Node id when user cancels"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"scanningMode": {
"enum": [
"single",
"automatic"
],
"type": "string",
"description": "Scanning mode"
},
"allowedDocumentTypes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Allowed document types, e.g. [\"id\", \"passport\", \"dl\"]"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "recognition"
},
"outcomes": {
"type": "object",
"required": [
"recognized",
"newUser",
"noFace"
],
"properties": {
"noFace": {
"type": "string",
"description": "Node id when no face is found"
},
"newUser": {
"type": "string",
"description": "Node id when user is new"
},
"recognized": {
"type": "string",
"description": "Node id when user is recognized"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "face_scan"
},
"outcomes": {
"type": "object",
"required": [
"passed",
"notPassed",
"cancelled",
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Node id on error"
},
"passed": {
"type": "string",
"description": "Node id when face scan passes"
},
"cancelled": {
"type": "string",
"description": "Node id when user cancels"
},
"notPassed": {
"type": "string",
"description": "Node id when face scan fails"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"captureInstructions": {
"type": "string"
},
"similarityThreshold": {
"type": "number",
"description": "0-1, how similar faces must be"
},
"requireAILivenessCheck": {
"type": "boolean"
},
"requireLivenessChallenge": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "two_factor_email"
},
"showUI": {
"type": "boolean",
"description": "Whether to show the OTP input UI"
},
"outcomes": {
"type": "object",
"required": [
"verified",
"delivery_failed",
"failed_unverified",
"cancelled",
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Node id on error"
},
"verified": {
"type": "string",
"description": "Node id when OTP verified"
},
"cancelled": {
"type": "string",
"description": "Node id when user cancels"
},
"delivery_failed": {
"type": "string",
"description": "Node id when delivery fails"
},
"failed_unverified": {
"type": "string",
"description": "Node id when max attempts exhausted"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"otpLength": {
"type": "number",
"description": "OTP length 4-8, default 6"
},
"maxAttempts": {
"type": "number",
"description": "Max verification attempts, default 3"
},
"emailTemplate": {
"type": "string"
},
"expirySeconds": {
"type": "number",
"description": "OTP expiry in seconds, default 300"
},
"resendAfterSeconds": {
"type": "number",
"description": "Seconds before allowing OTP resend"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "two_factor_sms"
},
"showUI": {
"type": "boolean",
"description": "Whether to show the OTP input UI"
},
"outcomes": {
"type": "object",
"required": [
"verified",
"delivery_failed",
"failed_unverified",
"cancelled",
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Node id on error"
},
"verified": {
"type": "string",
"description": "Node id when OTP verified"
},
"cancelled": {
"type": "string",
"description": "Node id when user cancels"
},
"delivery_failed": {
"type": "string",
"description": "Node id when delivery fails"
},
"failed_unverified": {
"type": "string",
"description": "Node id when max attempts exhausted"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"otpLength": {
"type": "number",
"description": "OTP length 4-8, default 6"
},
"maxAttempts": {
"type": "number",
"description": "Max verification attempts, default 3"
},
"smsTemplate": {
"type": "string"
},
"expirySeconds": {
"type": "number",
"description": "OTP expiry in seconds, default 300"
},
"resendAfterSeconds": {
"type": "number",
"description": "Seconds before allowing OTP resend"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"permissions",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "permissions"
},
"prompt": {
"type": "string",
"description": "Optional message the avatar says (direct speech mode, e.g. 'Say: Please enable your camera.')"
},
"outcomes": {
"type": "object",
"required": [
"permissionsGranted",
"permissionsDenied"
],
"properties": {
"permissionsDenied": {
"type": "string",
"description": "Node id when permissions are denied"
},
"permissionsGranted": {
"type": "string",
"description": "Node id when permissions are granted"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"permissions": {
"type": "object",
"properties": {
"camera": {
"type": "boolean",
"description": "Request camera access"
},
"microphone": {
"type": "boolean",
"description": "Request microphone access"
}
},
"description": "Which permissions to request",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"sourceA",
"sourceB",
"outcomes"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "face_compare"
},
"sourceA": {
"type": "object",
"required": [
"source"
],
"properties": {
"source": {
"enum": [
"sessionVideo",
"faceScan",
"providedData",
"documentPhoto"
],
"type": "string",
"description": "Source of the face image"
},
"providedDataKey": {
"type": "string",
"description": "Required when source is 'providedData' — the key in providedData that holds the image URL"
}
},
"description": "First face image source",
"additionalProperties": false
},
"sourceB": {
"type": "object",
"required": [
"source"
],
"properties": {
"source": {
"$ref": "#/properties/flow/items/anyOf/12/properties/sourceA/properties/source"
},
"providedDataKey": {
"$ref": "#/properties/flow/items/anyOf/12/properties/sourceA/properties/providedDataKey"
}
},
"description": "Second face image source",
"additionalProperties": false
},
"outcomes": {
"type": "object",
"required": [
"match",
"noMatch",
"imageUnavailable"
],
"properties": {
"match": {
"type": "string",
"description": "Node id when faces match"
},
"noMatch": {
"type": "string",
"description": "Node id when faces do not match"
},
"imageUnavailable": {
"type": "string",
"description": "Node id when one or both images could not be obtained"
}
},
"description": "Record mapping each outcome to a target node id",
"additionalProperties": false
},
"similarityThreshold": {
"type": "number",
"description": "0-1, minimum similarity score required for a match"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"request",
"outcome"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "external_call"
},
"outcome": {
"type": "string",
"description": "Node id to advance to after the response is merged into providedData (never branches)"
},
"request": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/url"
},
"vars": {
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/vars"
},
"method": {
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/method"
}
},
"description": "The external endpoint to call and the payload to send",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"rules",
"default"
],
"properties": {
"id": {
"type": "string",
"description": "Unique node identifier"
},
"type": {
"type": "string",
"const": "field_condition"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator",
"outcome"
],
"properties": {
"left": {
"type": "object",
"required": [
"source",
"field"
],
"properties": {
"field": {
"type": "string",
"description": "The field/key name within the source"
},
"source": {
"enum": [
"extractedData",
"providedData"
],
"type": "string",
"description": "Where the value is read from: 'extractedData' (a field from extractionSchema, extracted on demand from the transcript) or 'providedData' (a key set at creation or written by a prior external_call)"
}
},
"description": "Reference to the session value to test",
"additionalProperties": false
},
"right": {
"anyOf": [
{
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/vars/items/properties/value/anyOf/0"
},
{
"$ref": "#/properties/flow/items/anyOf/2/properties/awaitExternal/properties/request/properties/vars/items/properties/value/anyOf/1"
}
],
"description": "Literal or reference to compare against; omit for 'exists'/'notExists'"
},
"outcome": {
"type": "string",
"description": "Node id to route to when this rule matches"
},
"operator": {
"enum": [
"equals",
"notEquals",
"gt",
"lt",
"gte",
"lte",
"exists",
"notExists"
],
"type": "string",
"description": "Comparison operator (omit 'right' for 'exists'/'notExists')"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Rules evaluated top-to-bottom; first match wins"
},
"default": {
"type": "string",
"description": "Node id to route to when no rule matches"
}
},
"additionalProperties": false
}
]
},
"description": "Array of nodes forming the session's directed graph"
},
"zone": {
"enum": [
"us",
"eu"
],
"type": "string",
"description": "Data processing zone"
},
"langs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional whitelist of BCP-47 language codes (from facesign://catalog) the session may use. DEFAULT BEHAVIOUR (recommended): OMIT this parameter entirely — the session then supports every language in the FaceSign catalog, and `uiStrings` must cover every catalog language. ONLY set `langs` when the user EXPLICITLY restricts the language set (e.g. 'Spanish-only demo', 'support English and Russian'). Do NOT narrow to `['en']` just because the user described the demo in English or did not mention languages — that would silently drop multilingual support. Example (explicit restriction): [\"en\", \"es\", \"ru\"]. The set of target languages for `uiStrings` is derived from this list (or the full catalog if omitted)."
},
"avatarId": {
"type": "string",
"description": "Avatar ID from the facesign://catalog resource."
},
"metadata": {
"type": "object",
"description": "Arbitrary metadata to attach",
"additionalProperties": {}
},
"recapHtml": {
"type": "string",
"description": "REQUIRED. Raw HTML/JS for the results/recap page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` (via {{KEY}} or window.t('KEY')). Contract: reads window.__FACESIGN_SESSION__ (session data, re-populated on each poll), window.__FACESIGN_SESSION_ID__, window.__refetchSession() (returns Promise with updated data). The COMMON MISTAKES sections from the `landingHtml` field description apply here too — read them once and follow for both fields. For the complete session data shape (Session, SessionReport, NodeReport types, delayed vs immediate fields), read the `facesign://session-data-types` MCP resource.\n\nSTYLE GUIDE (Results/Recap Page):\nMatch this visual style for consistency with the FaceSign UI.\n\nBackground: Light gray #f5f7fa with subtle gradient to light blue at top.\n\nLayout: Single-column, max-width 900px, centered (margin 0 auto), padding 2rem.\n\nPage header: \"Session summary\" bold 1.6rem. Subtitle with date/time and duration in muted color #888, font-size 0.9rem.\n\nUser info card: White card with rounded photo (80-100px), grid of icon+text pairs for age, gender, location, device. Icons in muted blue #6b7faa.\n\nSection cards: White background, border-radius 12px, box-shadow 0 2px 12px rgba(0,0,0,.05), padding 1.5rem, margin-bottom 1.5rem.\n\nSection headings: Bold 1.15rem, color #1a1a2e, with small emoji/icon prefix (e.g. ✨ AI Analysis, 🔍 Detected Signals, 📋 Transcript). Margin-bottom 1rem.\n\nStatus banners (full-width within card, border-radius 12px, padding 1rem 1.5rem, white text, bold):\n- Verified/success: background #4a9d6e, shield ✓ icon\n- High-risk/warning: background #d97b30, ⚠ warning icon\n\nSignal items: Left border 4px solid, padding-left 1rem, margin-bottom 1rem, background white or tinted.\n- Normal: border-color #059669, light green tint background #f0fdf4\n- Suspicious: border-color #f59e0b, light yellow tint background #fefce8\n- High-risk: border-color #ef4444, light red tint background #fef2f2\n\nStatus badges (inline, pill): border-radius 6px, padding 2px 10px, font-weight 700, font-size 0.8rem, uppercase.\n- RECOGNIZED/NORMAL: background #d1fae5, color #065f46\n- SUSPICIOUS: background #fef3c7, color #92400e\n\nConfidence scores: Right-aligned, font-size 0.85rem, color #aaa.\n\nKey-value grid: Two-column layout. Label: small text, color #888, font-size 0.8rem, uppercase. Value: font-size 0.95rem, color #1a1a2e, below label.\n\nTranscript: Dark background #1e2a3a, border-radius 10px, padding 1.5rem, monospace font. \"CONVERSATION LOG\" header uppercase, small, muted. Each line: timestamp (gray #777), speaker label (FACESIGN: in teal #4db8a4, USER: in green #6bc96f), message text white. Line-height 1.8.\n\nVideo: Centered, border-radius 8px, max-width 100%, dark container background.\n\nFont: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif.\n\n\nBEST PRACTICES FOR STABLE RENDERING (recapHtml):\n\nSession data arrives in two stages: some fields are available immediately when the session ends (user info, AI analysis, transcript), while others require polling. Video AI analysis may take up to 60 seconds; media usually arrives sooner. Naive implementations cause layout jumping (DOM rebuild on each poll) and duplicate network requests.\n\nARCHITECTURE: Split Static vs Dynamic Rendering.\n\nrenderStatic(data) — called ONCE:\nRenders all sections that won't change: user info (age, sex, location, device), aiAnalysis.overallSummary, aiAnalysis.analysis list, transcript, documentImages.\n\nupdateDynamic(data) — called on each poll:\nUpdates ONLY sections whose data arrives asynchronously: nodeReports, videoAIAnalysis, deepfakeDetection, and media (avatarVideo, screenshots).\nIMPORTANT: nodeReports is DELAYED — do NOT render node report data (face compare results, document scan results, etc.) in renderStatic().\nEach dynamic section has its own wrapper element (e.g. <div id=\"video-ai-content\">, <div id=\"node-reports-content\">) so updates replace only that element's innerHTML, leaving the rest untouched.\nTrack completion with boolean flags (videoAIDone, recordingDone, nodeReportsDone). Once a section is populated, skip further updates.\nSet videoAIDone when videoAIAnalysisStatus is either `succeeded` or `failed`. A failed analysis is terminal: replace the spinner with an unavailable message and do not interpret the missing result as clean evidence. If the status is absent, analysis was not requested, so omit the section.\n\nHTML STRUCTURE:\n<!-- Static sections: rendered once -->\n<div id=\"userinfo-card\"></div>\n<div id=\"summary-card\"></div>\n<div id=\"analysis-card\"></div>\n\n<!-- Dynamic sections: inner content updated by polling -->\n<div id=\"video-ai-card\">\n <div class=\"card\">\n <div class=\"card-title\">Video AI Analysis</div>\n <div id=\"video-ai-content\"><!-- spinner initially, replaced when data arrives --></div>\n </div>\n</div>\n\n<div id=\"recording-card\">\n <div class=\"card\">\n <div class=\"card-title\">Session Recording</div>\n <div id=\"recording-content\"><!-- spinner initially, replaced when data arrives --></div>\n </div>\n</div>\n\n<!-- Static section: rendered once -->\n<div id=\"transcript-card\"></div>\n\nPOLLING: Single Entry Point with Guard (IIFE pattern):\nIMPORTANT: Polling MUST be limited — max 30 attempts, max 2 minutes total. Stop polling when limits are reached even if some data hasn't arrived.\n(function() {\n var polling = false;\n var pollCount = 0;\n var MAX_POLLS = 30;\n var startTime = Date.now();\n var MAX_DURATION = 2 * 60 * 1000; // 2 minutes\n var videoAIDone = false;\n var recordingDone = false;\n var nodeReportsDone = false;\n\n function shouldStop() {\n return pollCount >= MAX_POLLS || (Date.now() - startTime) >= MAX_DURATION;\n }\n\n function poll() {\n if (polling) return;\n if (shouldStop()) return;\n polling = true;\n pollCount++;\n if (typeof window.__refetchSession !== 'function') {\n polling = false;\n setTimeout(poll, 2000);\n return;\n }\n window.__refetchSession()\n .then(function(data) {\n polling = false;\n updateDynamic(data);\n if ((!videoAIDone || !recordingDone || !nodeReportsDone) && !shouldStop()) setTimeout(poll, 4000);\n })\n .catch(function() {\n polling = false;\n if (!shouldStop()) setTimeout(poll, 4000);\n });\n }\n\n function init() {\n var data = window.__FACESIGN_SESSION__;\n if (!data) return;\n renderStatic(data);\n var needMore = updateDynamic(data);\n if (needMore) setTimeout(poll, 4000);\n }\n\n if (window.__FACESIGN_SESSION__) {\n init();\n } else {\n var chk = setInterval(function() {\n if (window.__FACESIGN_SESSION__) { clearInterval(chk); init(); }\n }, 500);\n }\n})();\n\nKEY RULES:\n- Call renderStatic() exactly once — avoids DOM rebuild and layout jumps\n- updateDynamic() only touches dedicated container elements — no reflow outside the updated section\n- Use a polling boolean guard — prevents concurrent __refetchSession() calls\n- ALWAYS limit polling — max 30 attempts AND max 2 minutes total. Never poll indefinitely.\n- Use videoAIDone / recordingDone / nodeReportsDone flags — stops updating a section once its data has been rendered\n- For video AI, derive videoAIDone from videoAIAnalysisStatus, not from the presence of videoAIAnalysis alone\n- nodeReports is DELAYED — always render node report data (face compare, document scan, etc.) in updateDynamic(), never in renderStatic()\n- Single init() entry point via IIFE — eliminates duplicate initialization paths\n- Check typeof __refetchSession === 'function' before calling — handles the case where the API isn't injected yet\n- Use setTimeout not setInterval for polling — ensures the next poll starts only after the previous one completes\n- nodeReport.type is lowercase snake_case (\"face_compare\", \"document_scan\") — use case-insensitive comparison\n- Document scan report fields are Microblink nested objects — use a safe-value extractor function (see COMMON MISTAKES)\n- videoAIAnalysis criterion is camelCase — convert to human-readable with toStartCase() (see COMMON MISTAKES)\n\nSUMMARY: Render once, patch selectively, poll safely with limits. Static content is written to the DOM a single time. Dynamic content (nodeReports, videoAIAnalysis, media) targets specific container elements. Polling is serialized with a guard flag and stops as soon as all async data has arrived or limits are reached (max 30 attempts / 2 minutes)."
},
"uiStrings": {
"type": "object",
"description": "REQUIRED. Per-language UI string dictionary: { langId: { key: translatedString } }. You invent the keys to match the {{KEY}} placeholders / window.t('KEY') calls in your landingHtml and recapHtml. Must contain an entry for `en` (ultimate runtime fallback) and for every language in `langs` (or every catalog language if `langs` is omitted). Every per-language dict must share the IDENTICAL set of keys. Example: { \"en\": { \"START\": \"Start\", \"LOADING\": \"Loading...\" }, \"fr\": { \"START\": \"Commencer\", \"LOADING\": \"Chargement...\" } }.",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"defaultLang": {
"type": "string",
"description": "Optional fallback BCP-47 language code used when the end-user's browser language is not in `langs`. DEFAULT BEHAVIOUR: OMIT this parameter. The MCP server falls back to 'en' internally only as a last-resort for UI string lookup; you should not hardcode a default language here unless the user explicitly asks for one. When set, must be one of the codes in `langs` (if `langs` is also set)."
},
"landingHtml": {
"type": "string",
"description": "REQUIRED. Raw HTML/JS for the pre-session landing page. NO CDATA, NO markdown fences. Every visible string MUST come from `uiStrings` — reference them via {{KEY}} placeholders (interpolated at inject time) or via window.t('KEY') (dynamic at runtime). Contract: reads window.__FACESIGN_FLOW__ (the flow array). MUST call window.__startSession(updatedFlow?) to launch the session. The session iframe has its own Start button for audio/video autoplay gesture — the landing page does NOT need one for that purpose.\n\nSTYLE GUIDE (Pre-Session Page):\nMatch this visual style for consistency with the FaceSign UI.\n\nBackground: Light gray #f5f7fa. Full-viewport centered layout (flexbox, min-height: 100vh; min-height: 100dvh — always use dvh with vh fallback for iOS compatibility).\n\nCard: White, border-radius 16px, box-shadow 0 4px 24px rgba(0,0,0,.08), padding 2.5-3rem, max-width 480-600px, centered.\n\nHeadings: Bold, 1.4-1.8rem, color #1a1a2e, centered in card.\n\nInputs: Full-width, padding 14px 16px, border 2px solid #d1d5db, border-radius 12px, font-size 1rem. Focus: border-color #5b7bab. Placeholder color #9ca3af.\n\nPrimary buttons: Background #7b8fb5 (steel-blue), color white, font-weight 600, font-size 1.05rem, border-radius 50px (pill shape), padding 14px, full-width in card. Hover: background #6a7fa5. Disabled: background #c5cdd8, cursor not-allowed.\n\nLinks: Color #4573b8, no underline, underline on hover. Back navigation: \"← Back\" at top-left of card, color #4573b8, font-size 0.95rem.\n\nProfile images: Circular (border-radius 50%), 120-150px diameter, centered, subtle box-shadow.\n\nSpacing: 2.5-3rem card padding, 1.5rem between form groups, 1rem between label and input, 2rem above primary button.\n\nFont: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif.\n\n\nCOMMON MISTAKES TO AVOID (UI/CSS):\n\n1. Never set padding or margin on body\nThe custom HTML is injected into a host page that controls its own layout. Setting padding, margin, or min-height on body will conflict with the host page styles and create unwanted spacing.\n\nWrong:\nbody { padding: 2rem; min-height: 100vh; }\n(Also wrong — using only 100vh without dvh fallback. Always add min-height: 100dvh after 100vh for iOS Safari.)\n\nRight — use a wrapper element instead:\nbody { margin: 0; padding: 0; }\n.wrap { max-width: 860px; margin: 0 auto; padding: 2rem; }\n\nThe same applies to background on body — avoid it unless you are certain the host page does not set its own background.\n\n2. Use HTML entities for emoji, not JS unicode escapes\nWhen building HTML strings in JavaScript (via innerHTML, string concatenation, etc.), JS unicode escapes like \\ud83c\\udfa5 will NOT render as emoji. They only work inside JS string literals that are directly displayed via textContent or similar APIs.\n\nWrong — renders as garbled text:\nh += '<div class=\"title\">\\ud83c\\udfa5 Video AI Analysis</div>';\n\nRight — use HTML numeric entities:\nh += '<div class=\"title\">🎥 Video AI Analysis</div>';\n\nAlso right — use emoji directly in static HTML (outside of JS):\n<div class=\"title\">🎥 Video AI Analysis</div>\n\nCommon emoji HTML entities reference:\n👤 👤 User/person\n🎂 🎂 Birthday cake\n📍 📍 Pin/location\n💻 💻 Computer\n✨ ✨ Sparkles\n🔍 🔍 Search\n🎥 🎥 Camera\n🎬 🎬 Clapper board\n📋 📋 Clipboard\n⚧ ⚧ Gender symbol\n✓ ✓ Checkmark\n\n3. CSS class name collision between landingHtml and recapHtml\nCRITICAL: landingHtml and recapHtml are injected into the SAME host document. If both fragments use the same class names (e.g., .card, .container, .header), styles from one will leak into the other, causing layout breakage.\n\nALWAYS use unique prefixed class names:\n- landingHtml (pre-session/landing page): prefix all classes with .lp- (e.g., .lp-card, .lp-header, .lp-btn)\n- recapHtml (results page): prefix all classes with .r- (e.g., .r-card, .r-header, .r-wrap)\n\nWrong — causes collisions:\n/* in landingHtml */ .card { max-width: 460px; }\n/* in recapHtml */ .card { max-width: 900px; }\n\nRight — namespaced:\n/* in landingHtml */ .lp-card { max-width: 460px; }\n/* in recapHtml */ .r-card { max-width: 900px; }\n\n\nCOMMON MISTAKES TO AVOID (Code/API):\n\n4. window.__startSession race condition\nNEVER call window.__startSession() synchronously in a click handler. The host page may not have injected the function yet. ALWAYS use polling:\n\nfunction waitAndStart(input) {\n var n = 0;\n var iv = setInterval(function() {\n n++;\n if (typeof window.__startSession === 'function') {\n clearInterval(iv);\n window.__startSession(input);\n } else if (n > 100) {\n clearInterval(iv);\n document.body.innerHTML = '<p style=\"text-align:center;padding:2rem;color:red;\">Failed to initialize session. Please refresh.</p>';\n }\n }, 100);\n}\n\nWrong:\nstartBtn.addEventListener('click', function() { window.__startSession(); });\n\nRight:\nstartBtn.addEventListener('click', function() { waitAndStart(); });\n\nFor exported apps, NEVER send window.__FACESIGN_FLOW__ or another graph back to\nthe server. To select a flow declared in export_app, pass its ID:\nwaitAndStart({ flowId: 'enhanced', providedData: { name: nameInput.value } });\n\n5. Permissions are automatic — do NOT add a permissions node by default\nFaceSign automatically requests camera and microphone permissions at session start. Most flows do NOT need a PERMISSIONS node. Only add one in these specific cases:\n(a) The user wants to request microphone and camera permissions separately at different times during the flow (instead of both at once at session start).\n(b) The user wants to move the permission request to the initial page (landingHtml), outside the FaceSign flow itself.\n\n6. nodeReport.type values are lowercase snake_case\nThe API returns nodeReport.type in lowercase snake_case: \"face_compare\", \"document_scan\", \"conversation\", \"permissions\", \"liveness_detection\", etc. — NOT uppercase like \"FACE_COMPARE\".\n\nALWAYS use case-insensitive comparison when looking up node reports:\n\nfunction getNode(r, type) {\n var rr = (r && r.nodeReports) || [];\n var tl = type.toLowerCase();\n for (var i = 0; i < rr.length; i++) {\n if (rr[i].type && rr[i].type.toLowerCase() === tl) return rr[i];\n }\n return null;\n}\n\n// Usage: getNode(report, 'face_compare'), getNode(report, 'document_scan')\n\n7. Microblink document report — nested field structure\nDOCUMENT_SCAN nodeReport.report fields are NOT plain strings. They use Microblink's nested structure:\n firstName: { latin: { value: \"JANICE\" } }\n dateOfBirth: { originalString: { latin: { value: \"04/30/1970\" } } }\n — OR —\n dateOfBirth: { day: 30, month: 4, year: 1970 }\n\nNEVER read fields directly as strings (e.g., dr.firstName will be an object, not \"JANICE\").\n\nALWAYS use this safe-value extractor:\n\nfunction sv(v) {\n if (v == null) return '';\n if (typeof v === 'string') return v;\n if (v.latin && v.latin.value != null) return String(v.latin.value);\n if (v.originalString) return sv(v.originalString);\n if (v.day != null && v.month != null && v.year != null)\n return v.month + '/' + v.day + '/' + v.year;\n return '';\n}\n\n// Usage: sv(dr.firstName) → \"JANICE\", sv(dr.dateOfBirth) → \"04/30/1970\"\n\n8. videoAIAnalysis criterion is camelCase — format for display\nThe criterion field (e.g., \"facialExpressionAndMovement\", \"useOfExternalDevices\") comes in camelCase. Convert to human-readable format:\n\nfunction toStartCase(s) {\n if (!s) return '';\n return s.replace(/([A-Z]+)/g, function(m) { return ' ' + m.toLowerCase(); })\n .trim().replace(/^./, function(c) { return c.toUpperCase(); });\n}\n// \"facialExpressionAndMovement\" → \"Facial expression and movement\"\n\n9. Conversation node: condition vs prompt\nIn CONVERSATION nodes:\n- \"condition\" (in outcomes) = ONLY describes the trigger event for transitioning to the next node (e.g., \"User explicitly agrees to proceed\")\n- \"prompt\" = ALL instructions for the avatar's behavior, including how to greet, how to respond to questions, how to handle objections, and how to persuade\n- User questions or objections during the conversation are handled within the SAME node (continued dialog), NOT via separate outcomes\n- Conversation nodes can have any number of outcomes depending on the use case:\n * Branching nodes (e.g., \"what color?\") → one outcome per branch + a fallback\n * Consent/agreement nodes → typically 2: agreement + fallback after N attempts\n- ALWAYS include a fallback outcome for when the conversation stalls (e.g., \"conversation exceeded N exchanges with no condition met\" or \"user does not want to reply\")\n\nWrong — putting behavior instructions in condition:\n\"condition\": \"User agrees. If they ask questions, answer warmly and ask again\"\n\nRight — behavior in prompt, condition is just the trigger:\n\"prompt\": \"Explain the process. If the user has questions, answer them warmly. Once they're ready, confirm.\"\n\"condition\": \"User explicitly agrees or says they are ready\""
},
"providedData": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
}
},
"description": "Pre-known user data",
"additionalProperties": true
},
"customization": {
"type": "object",
"properties": {
"controls": {
"type": "object",
"properties": {
"buttons": {
"type": "array",
"items": {
"enum": [
"microphone",
"camera",
"captions",
"language",
"close"
],
"type": "string"
},
"description": "Optional exact subset of in-session control buttons. Omit this field for the recommended default panel with all applicable controls. Set it only when the user requests a specialized flow or UI; for example, [\"captions\"] creates a captions-only panel, while an empty array hides the panel. Ignored when showUxControls is false"
},
"autoHide": {
"type": "boolean",
"description": "Whether controls may automatically fade out. Omitted or true preserves the default behavior; false keeps the selected buttons visible. Ignored when showUxControls is false"
},
"showUxControls": {
"type": "boolean",
"description": "Master switch for the in-session control panel. When false the panel is not rendered and every other controls.* setting has no effect"
},
"captionsOpenedByDefault": {
"type": "boolean",
"description": "Start the session with the closed-captions (transcript) panel open. Omitted or false keeps it closed. The user can toggle it with the CC button either way. Set it for accessibility, or when viewers may be reading along in a second language. Ignored when showUxControls is false"
}
},
"additionalProperties": false
},
"permissionsPage": {
"type": "object",
"properties": {
"buttonText": {
"type": "string"
},
"subheading": {
"type": "string"
},
"mainHeading": {
"type": "string"
},
"backgroundType": {
"enum": [
"AVATAR",
"COLOR"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"buttonTextTranslates": {
"type": "object",
"description": "Localized permission-button text, for example { es: 'Continuar' }",
"additionalProperties": {
"type": "string"
}
},
"subheadingTranslates": {
"$ref": "#/properties/customization/properties/permissionsPage/properties/buttonTextTranslates",
"description": "Localized permission-page subheadings"
},
"mainHeadingTranslates": {
"$ref": "#/properties/customization/properties/permissionsPage/properties/buttonTextTranslates",
"description": "Localized permission-page headings"
}
},
"additionalProperties": false
}
},
"description": "UI customization",
"additionalProperties": false
},
"extractionSchema": {
"type": "array",
"items": {
"type": "object",
"required": [
"fieldName",
"type",
"description"
],
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional allowed string values. When set, the LLM normalizes free-form answers (e.g. \"yeah\", \"sure\") into one of the listed values. Recommended for yes/no or fixed-choice questions."
},
"type": {
"enum": [
"string",
"number",
"boolean",
"date"
],
"type": "string",
"description": "Expected value type. `date` is returned as an ISO 8601 string."
},
"fieldName": {
"type": "string",
"description": "Key under which the extracted value appears in session.report.extractedData."
},
"description": {
"type": "string",
"description": "Natural-language hint for the LLM describing what to look for in the transcript. This is the primary extraction signal — be specific (e.g. \"the user's full legal name\" rather than \"name\")."
}
},
"additionalProperties": false
},
"description": "Optional schema describing fields the FaceSign backend should extract from the session transcript using an LLM. Results are populated post-session at `session.report.extractedData` as `{ [fieldName]: string | number | boolean | null }` (null when the transcript did not contain the data — every field is treated as optional). Use this for structured data collection that does NOT need its own dedicated node — e.g. follow-up questions in a single CONVERSATION node where you'd otherwise have to author multiple branching outcomes. The conversation flow itself is unaffected; extraction runs on the final transcript. Render the results in your recapHtml when present."
},
"clientReferenceId": {
"type": "string",
"description": "Your own reference ID for this session"
},
"postSessionLiveness": {
"enum": [
"v1",
"v2"
],
"type": "string",
"description": "Enable post-session liveness assessment with the selected public policy version. The result is available in session.report.postSessionLiveness after the interaction."
},
"videoAIAnalysisEnabled": {
"type": "boolean",
"description": "Enable video AI fraud analysis"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max sessions to return (1-100, default 10)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor from a previous response"
},
"flowId": {
"type": "string",
"description": "Filter sessions by flow ID"
},
"search": {
"type": "string",
"description": "Search term to filter sessions"
},
"sortBy": {
"enum": [
"createdAt",
"status",
"finishedAt"
],
"type": "string",
"description": "Field to sort by"
},
"status": {
"anyOf": [
{
"enum": [
"created",
"inProgress",
"incomplete",
"complete"
],
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/properties/status/anyOf/0"
}
}
],
"description": "Filter by session status"
},
"toDate": {
"type": "number",
"description": "End of date range (Unix timestamp in ms)"
},
"fromDate": {
"type": "number",
"description": "Start of date range (Unix timestamp in ms)"
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction"
},
"clientReferenceId": {
"type": "string",
"description": "Filter by client reference ID"
}
},
"additionalProperties": false
}