Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).
Token-plane projection. No tenant/workspace, no upload refs, no OCR/jurisdiction/fraud detail.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://hub.gominerva.com/docs.json","name":"Minerva Docs","colors":{"primary":"#4e26b1","light":"#beb7fb","dark":"#271362"},"logo":{"light":"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/logo/minerva-dark.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=b6ef1ed1a0b7ff7df81fdbb1c2ac0db4","dark":"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/logo/minerva-light.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=986049de4dbc27a2e833d88aaff85c3c"},"favicon":"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/favicon.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=313cf5bf970aa85c301aadfb9dda68b2","navbar":{"primary":{"type":"button","label":"Go to Minerva App","href":"https://app.gominerva.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/gominerva"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"mailto:support@gominerva.com"},{"anchor":"Trust Page","icon":"shield","href":"https://app.conveyor.com/profile/gominerva"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"minerva-557aeab7","hasAudioNarration":false,"actualSubdomain":"minerva-557aeab7","customDomains":["docs.gominerva.com"],"gitSource":{"type":"gitlab","owner":"minervaai/interfaces","repo":"minerva-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":74271980,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af3e28bde222de6f181f6bc","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":184},{"language":"default","tag":"Admin Actions - Endpoints","count":64},{"language":"default","tag":"Agent Risk Assessments - Endpoints","count":44},{"language":"default","tag":"Identity Verification - Endpoints","count":42},{"language":"default","tag":"Knowledge Hub","count":32},{"language":"default","tag":"Custom Lists","count":29},{"language":"default","tag":"User Guides","count":19},{"language":"default","tag":"Agent Runtime","count":14},{"language":"default","tag":"Themes","count":14},{"language":"default","tag":"API Documentation","count":13}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/capture/exchange-an-invite-for-a-fresh-capture-token","slug":"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token","pageMetadata":{"title":"Exchange an invite for a fresh capture token","description":"Invite-credential auth (the bearer is the `idvi_` invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct `delivery:none` invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\n","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/acquire","href":"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Invite-credential auth (the bearer is the \", _jsx(_components.code, {\n children: \"idvi_\"\n }), \" invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct \", _jsx(_components.code, {\n children: \"delivery:none\"\n }), \" invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Exchange an invite for a fresh capture token","description":"Invite-credential auth (the bearer is the `idvi_` invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct `delivery:none` invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\n","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/acquire","href":"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["capture"],"summary":"Exchange an invite for a fresh capture token","description":"Invite-credential auth (the bearer is the `idvi_` invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct `delivery:none` invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\n","security":["3c7da9bb-dbb0-4c4d-94c7-31fdc8436ad4"],"parameters":["cb3d4ae5-c0b3-4e01-98b6-5331504ea3b7"],"responses":{"200":"183c865e-9f7c-4fa3-9571-d0bfe9d5ba3c","401":"60f76a67-8e0d-4244-bbf4-dd17abfaabef","409":"16bc0462-94b7-4920-850d-92ecf1154a3a"},"method":"post","type":"path","servers":["2d270158-b0b4-4a7f-a4ee-f351d95099b6"],"path":"/sessions/{sessionId}/acquire","baseUrlOptions":["https://api.gominerva.com/idv/v1"],"title":"Exchange an invite for a fresh capture token","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cb3d4ae5-c0b3-4e01-98b6-5331504ea3b7":{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"183c865e-9f7c-4fa3-9571-d0bfe9d5ba3c":{"description":"Acquired","content":{"application/json":{"schema":{"type":"object","required":["session_token","token_expires_at","capture_manifest","step_manifest","progress"],"properties":{"session_token":{"type":"string","description":"Fresh one-time capture token (idvs_...). Returned ONLY here and at create.","example":"idvs_9c1f...redacted","isRequired":true,"uniqueKey":"session_token","typeLabel":"string"},"token_expires_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"token_expires_at","typeLabel":"string\u003cdate-time>"},"capture_manifest":{"type":"object","required":["workflow","required_kinds"],"properties":{"workflow":{"type":"string","description":"Derived legacy label on responses. Custom step manifests that match a preset's capture shape reuse the preset label; capture-free manifests are labeled `custom`.\n","enum":["liveness_and_id","liveness_only","id_only","custom"],"isRequired":true,"uniqueKey":"capture_manifest.workflow","typeLabel":"enum\u003cstring>"},"required_kinds":{"type":"array","description":"Derived from the liveness/id_capture steps: skipped optional capture steps and not-applicable conditional steps contribute nothing, and a declared one-sided document type (passport, sides=auto) drops id_back. Management (application-plane and dashboard) responses always include the kinds of conditional capture steps and ignore skips and declared document types on them, so they never reveal a conditional step's controller answer; token-plane responses reflect applicability, skips and declarations.\n","items":{"type":"string","enum":["liveness_front","liveness_left","liveness_right","id_front","id_back"],"uniqueKey":"capture_manifest.required_kinds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"capture_manifest.required_kinds","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"capture_manifest","typeLabel":"object"},"step_manifest":{"type":"object","description":"The resolved, persisted step manifest (canonical order; config echoed).","required":["steps"],"properties":{"steps":{"type":"array","items":{"type":"object","required":["step_id","type"],"properties":{"step_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique per session.","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].step_id","typeLabel":"string"},"type":{"type":"string","enum":["liveness","id_capture","questionnaire","document_upload"],"isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"description":"false => the consumer may skip the step.","uniqueKey":"step_manifest.steps.items.[INDEX].required","typeLabel":"boolean"},"title":{"type":"string","minLength":1,"maxLength":200,"description":"Optional display override.","uniqueKey":"step_manifest.steps.items.[INDEX].title","typeLabel":"string"},"config":{"type":"object","description":"Type-specific step config. Only the fields for the step type are allowed.","properties":{"accepted_id_types":{"type":"array","maxItems":20,"description":"id_capture only. Empty/omitted = any supported built-in type plus any custom_id_types configured on the same step.\n","items":{"oneOf":[{"type":"string","description":"Id types a consumer can declare or configure in accepted_id_types. Built-ins are listed explicitly; workflow-local custom ids must be defined in the id_capture step's custom_id_types. `unknown` is an inference outcome, not declarable. `passport` is the one-sided built-in type - declaring it drops id_back when sides=auto.\n","enum":["driver_license","government_id","health_card","passport","national_id","permanent_resident_card","residence_permit","other"],"uniqueKey":"step_manifest.steps.items.[INDEX].config.accepted_id_types.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Id types a consumer can declare or configure in accepted_id_types. Built-ins are listed explicitly; workflow-local custom ids must be defined in the id_capture step's custom_id_types. `unknown` is an inference outcome, not declarable. `passport` is the one-sided built-in type - declaring it drops id_back when sides=auto.\n","pattern":"^[a-z0-9_-]{1,64}$","uniqueKey":"step_manifest.steps.items.[INDEX].config.accepted_id_types.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"step_manifest.steps.items.[INDEX].config.accepted_id_types.items.[INDEX]","typeLabel":"enum\u003cstring> | string"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.accepted_id_types","typeLabel":"(enum\u003cstring> | string)[]"},"custom_id_types":{"type":"array","maxItems":20,"description":"id_capture only. Workflow-local document categories that can be referenced from accepted_id_types and declared by the applicant.\n","items":{"type":"object","required":["id_type","label","sides"],"properties":{"id_type":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Workflow-local id type identifier. Must not match a built-in ID type or `unknown`; accepted_id_types can reference it only within the same id_capture step.\n","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].id_type","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":120,"description":"Human-readable document type label shown to applicants and reviewers.","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].label","typeLabel":"string"},"sides":{"type":"string","enum":["one_sided","two_sided"],"description":"Capture side requirement when the custom type is declared.","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].sides","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":1000,"description":"Optional workflow-admin guidance describing the ID, authenticity requirements, and specific details reviewers or the assessment agent should inspect for this custom type.\n","uniqueKey":"step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX]","typeLabel":"object"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.custom_id_types","typeLabel":"object[]"},"sides":{"type":"string","description":"auto adapts to the declared document type; one_sided never demands id_back.","enum":["auto","two_sided","one_sided"],"default":"auto","uniqueKey":"step_manifest.steps.items.[INDEX].config.sides","typeLabel":"enum\u003cstring>"},"questions":{"type":"array","minItems":1,"maxItems":50,"description":"questionnaire only.","items":{"type":"object","required":["question_id","label","type"],"properties":{"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the step.","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].question_id","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","select","multi_select","date","country","boolean"],"isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required","typeLabel":"boolean"},"required_when":{"type":"object","description":"Mutually exclusive with required=true; required defaults to false when this field is present.","required":["question_id","equals"],"properties":{"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required_when.question_id","typeLabel":"string"},"equals":{"type":"boolean","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required_when.equals","typeLabel":"boolean"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required_when","typeLabel":"object"},"visible_when":{"type":"object","description":"Shows this otherwise-optional question only when the earlier, always-shown and required boolean question has the specified value. Mutually exclusive with required=true. If required_when is also present, both fields must contain the same condition.\n","required":["question_id","equals"],"properties":{"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].visible_when.question_id","typeLabel":"string"},"equals":{"type":"boolean","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].visible_when.equals","typeLabel":"boolean"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].visible_when","typeLabel":"object"},"options":{"type":"array","maxItems":50,"description":"Required for select/multi_select; forbidden otherwise.","items":{"type":"object","required":["value","label"],"properties":{"value":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options","typeLabel":"object[]"},"response_fields":{"type":"array","minItems":1,"maxItems":10,"description":"Text/textarea only. Field IDs must be unique and at least one field must be required. Omitted on scalar questions.\n","items":{"type":"object","required":["field_id","label"],"properties":{"field_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].field_id","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Trimmed field label.","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].label","typeLabel":"string"},"required":{"type":"boolean","default":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].required","typeLabel":"boolean"},"answer_type":{"type":"string","enum":["text","date","number"],"description":"Optional. Omission is preserved in stored and returned manifests. Omission and text inherit the parent text/textarea presentation. Every answer cell remains a JSON string, trimmed with the existing ECMAScript whitespace rules. Date requires ASCII YYYY-MM-DD with a valid Gregorian date in years 0001-9999, without a time or timezone. Number requires ASCII -?(0|[1-9][0-9]*)(\\.[0-9]+)? and preserves its sign, precision, zero and trailing zeros without numeric conversion. Exponents, leading plus signs, grouping separators and nonfinite values are invalid. Optional empty cells remain optional.\n","uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].answer_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields","typeLabel":"object[]"},"allow_additional_responses":{"type":"boolean","default":false,"description":"Requires response_fields. Allows the recipient to add or remove response rows.","uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].allow_additional_responses","typeLabel":"boolean"},"max_response_rows":{"type":"integer","minimum":1,"maximum":20,"description":"Fixed groups use 1; repeatable groups use 2-20 (default 20).","uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].max_response_rows","typeLabel":"integer"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.questions","typeLabel":"object[]"},"documents":{"type":"array","minItems":1,"maxItems":5,"description":"document_upload only; the full workflow supports at most five documents.","items":{"type":"object","required":["document_id","label"],"properties":{"document_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the full workflow.","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].document_id","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].label","typeLabel":"string"},"description":{"type":"string","maxLength":1000,"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].description","typeLabel":"string"},"accepted_content_types":{"type":"array","minItems":1,"maxItems":4,"uniqueItems":true,"description":"Defaults to [application/pdf, image/jpeg, image/png] when omitted.","items":{"type":"string","enum":["application/pdf","image/jpeg","image/png","image/webp"],"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].accepted_content_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].accepted_content_types","typeLabel":"enum\u003cstring>[]"},"required":{"type":"boolean","default":true,"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].required","typeLabel":"boolean"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"step_manifest.steps.items.[INDEX].config.documents","typeLabel":"object[]"}},"uniqueKey":"step_manifest.steps.items.[INDEX].config","typeLabel":"object"},"visible_when":{"type":"object","description":"Omitted for unconditional steps.","required":["step_id","question_id","equals"],"properties":{"step_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].visible_when.step_id","typeLabel":"string"},"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].visible_when.question_id","typeLabel":"string"},"equals":{"type":"boolean","isRequired":true,"uniqueKey":"step_manifest.steps.items.[INDEX].visible_when.equals","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"step_manifest.steps.items.[INDEX].visible_when","typeLabel":"object"}},"uniqueKey":"step_manifest.steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"step_manifest.steps","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"step_manifest","typeLabel":"object"},"progress":{"type":"object","description":"Token-plane projection. No tenant/workspace, no upload refs, no OCR/jurisdiction/fraud detail.","required":["status","privacy_contact_email","consent_notice_locale","consent_notice_version","consent_notice_text","consent_notice_digest","capture_manifest","step_manifest","flow_steps","steps"],"properties":{"status":{"type":"string","description":"FLOW axis only since the status split: assessment outcomes live on `review_status` (the gate's recommendation stays on the assessment block) and `assessed` replaces the legacy conflated approved/rejected/requires_review terminal statuses. Terminal flow states are assessed, failed, canceled, deleted.\n","enum":["collecting_artifacts","ready_for_assessment","queued","assessing","assessed","failed","canceled","deleted"],"isRequired":true,"uniqueKey":"progress.status","typeLabel":"enum\u003cstring>"},"privacy_contact_email":{"oneOf":[{"type":"string","description":"Consumer-facing privacy/deletion contact for the consent notice; empty only for legacy/dev sessions.","format":"email","isRequired":true,"uniqueKey":"progress.privacy_contact_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"string","description":"Consumer-facing privacy/deletion contact for the consent notice; empty only for legacy/dev sessions.","maxLength":0,"isRequired":true,"uniqueKey":"progress.privacy_contact_email.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"progress.privacy_contact_email","typeLabel":"string\u003cemail> | string"},"consent_notice_locale":{"type":"string","enum":["en","fr"],"description":"Language of the exact server-authored consent notice returned in this response.","isRequired":true,"uniqueKey":"progress.consent_notice_locale","typeLabel":"enum\u003cstring>"},"consent_notice_version":{"type":"string","description":"Server-authored consent notice version shown before capture starts; empty only when no consent contact is configured.","isRequired":true,"uniqueKey":"progress.consent_notice_version","typeLabel":"string"},"consent_notice_text":{"type":"string","description":"Exact server-authored notice text that the verification page displays and record-consent persists; empty only when no consent contact is configured.","isRequired":true,"uniqueKey":"progress.consent_notice_text","typeLabel":"string"},"consent_notice_digest":{"type":"string","pattern":"^(|sha256:[0-9a-f]{64})$","description":"SHA-256 receipt of the exact consent_notice_text bytes; empty only when the notice is empty.","isRequired":true,"uniqueKey":"progress.consent_notice_digest","typeLabel":"string"},"capture_manifest":{"type":"object","required":["workflow","required_kinds"],"properties":{"workflow":{"type":"string","description":"Derived legacy label on responses. Custom step manifests that match a preset's capture shape reuse the preset label; capture-free manifests are labeled `custom`.\n","enum":["liveness_and_id","liveness_only","id_only","custom"],"isRequired":true,"uniqueKey":"progress.capture_manifest.workflow","typeLabel":"enum\u003cstring>"},"required_kinds":{"type":"array","description":"Derived from the liveness/id_capture steps: skipped optional capture steps and not-applicable conditional steps contribute nothing, and a declared one-sided document type (passport, sides=auto) drops id_back. Management (application-plane and dashboard) responses always include the kinds of conditional capture steps and ignore skips and declared document types on them, so they never reveal a conditional step's controller answer; token-plane responses reflect applicability, skips and declarations.\n","items":{"type":"string","enum":["liveness_front","liveness_left","liveness_right","id_front","id_back"],"uniqueKey":"progress.capture_manifest.required_kinds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"progress.capture_manifest.required_kinds","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"progress.capture_manifest","typeLabel":"object"},"step_manifest":{"type":"object","description":"The resolved, persisted step manifest (canonical order; config echoed).","required":["steps"],"properties":{"steps":{"type":"array","items":{"type":"object","required":["step_id","type"],"properties":{"step_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique per session.","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].step_id","typeLabel":"string"},"type":{"type":"string","enum":["liveness","id_capture","questionnaire","document_upload"],"isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"description":"false => the consumer may skip the step.","uniqueKey":"progress.step_manifest.steps.items.[INDEX].required","typeLabel":"boolean"},"title":{"type":"string","minLength":1,"maxLength":200,"description":"Optional display override.","uniqueKey":"progress.step_manifest.steps.items.[INDEX].title","typeLabel":"string"},"config":{"type":"object","description":"Type-specific step config. Only the fields for the step type are allowed.","properties":{"accepted_id_types":{"type":"array","maxItems":20,"description":"id_capture only. Empty/omitted = any supported built-in type plus any custom_id_types configured on the same step.\n","items":{"oneOf":[{"type":"string","description":"Id types a consumer can declare or configure in accepted_id_types. Built-ins are listed explicitly; workflow-local custom ids must be defined in the id_capture step's custom_id_types. `unknown` is an inference outcome, not declarable. `passport` is the one-sided built-in type - declaring it drops id_back when sides=auto.\n","enum":["driver_license","government_id","health_card","passport","national_id","permanent_resident_card","residence_permit","other"],"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.accepted_id_types.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Id types a consumer can declare or configure in accepted_id_types. Built-ins are listed explicitly; workflow-local custom ids must be defined in the id_capture step's custom_id_types. `unknown` is an inference outcome, not declarable. `passport` is the one-sided built-in type - declaring it drops id_back when sides=auto.\n","pattern":"^[a-z0-9_-]{1,64}$","uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.accepted_id_types.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.accepted_id_types.items.[INDEX]","typeLabel":"enum\u003cstring> | string"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.accepted_id_types","typeLabel":"(enum\u003cstring> | string)[]"},"custom_id_types":{"type":"array","maxItems":20,"description":"id_capture only. Workflow-local document categories that can be referenced from accepted_id_types and declared by the applicant.\n","items":{"type":"object","required":["id_type","label","sides"],"properties":{"id_type":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Workflow-local id type identifier. Must not match a built-in ID type or `unknown`; accepted_id_types can reference it only within the same id_capture step.\n","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].id_type","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":120,"description":"Human-readable document type label shown to applicants and reviewers.","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].label","typeLabel":"string"},"sides":{"type":"string","enum":["one_sided","two_sided"],"description":"Capture side requirement when the custom type is declared.","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].sides","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":1000,"description":"Optional workflow-admin guidance describing the ID, authenticity requirements, and specific details reviewers or the assessment agent should inspect for this custom type.\n","uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.custom_id_types.items.[INDEX]","typeLabel":"object"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.custom_id_types","typeLabel":"object[]"},"sides":{"type":"string","description":"auto adapts to the declared document type; one_sided never demands id_back.","enum":["auto","two_sided","one_sided"],"default":"auto","uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.sides","typeLabel":"enum\u003cstring>"},"questions":{"type":"array","minItems":1,"maxItems":50,"description":"questionnaire only.","items":{"type":"object","required":["question_id","label","type"],"properties":{"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the step.","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].question_id","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","select","multi_select","date","country","boolean"],"isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required","typeLabel":"boolean"},"required_when":{"type":"object","description":"Mutually exclusive with required=true; required defaults to false when this field is present.","required":["question_id","equals"],"properties":{"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required_when.question_id","typeLabel":"string"},"equals":{"type":"boolean","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required_when.equals","typeLabel":"boolean"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].required_when","typeLabel":"object"},"visible_when":{"type":"object","description":"Shows this otherwise-optional question only when the earlier, always-shown and required boolean question has the specified value. Mutually exclusive with required=true. If required_when is also present, both fields must contain the same condition.\n","required":["question_id","equals"],"properties":{"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].visible_when.question_id","typeLabel":"string"},"equals":{"type":"boolean","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].visible_when.equals","typeLabel":"boolean"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].visible_when","typeLabel":"object"},"options":{"type":"array","maxItems":50,"description":"Required for select/multi_select; forbidden otherwise.","items":{"type":"object","required":["value","label"],"properties":{"value":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].options","typeLabel":"object[]"},"response_fields":{"type":"array","minItems":1,"maxItems":10,"description":"Text/textarea only. Field IDs must be unique and at least one field must be required. Omitted on scalar questions.\n","items":{"type":"object","required":["field_id","label"],"properties":{"field_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].field_id","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Trimmed field label.","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].label","typeLabel":"string"},"required":{"type":"boolean","default":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].required","typeLabel":"boolean"},"answer_type":{"type":"string","enum":["text","date","number"],"description":"Optional. Omission is preserved in stored and returned manifests. Omission and text inherit the parent text/textarea presentation. Every answer cell remains a JSON string, trimmed with the existing ECMAScript whitespace rules. Date requires ASCII YYYY-MM-DD with a valid Gregorian date in years 0001-9999, without a time or timezone. Number requires ASCII -?(0|[1-9][0-9]*)(\\.[0-9]+)? and preserves its sign, precision, zero and trailing zeros without numeric conversion. Exponents, leading plus signs, grouping separators and nonfinite values are invalid. Optional empty cells remain optional.\n","uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX].answer_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].response_fields","typeLabel":"object[]"},"allow_additional_responses":{"type":"boolean","default":false,"description":"Requires response_fields. Allows the recipient to add or remove response rows.","uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].allow_additional_responses","typeLabel":"boolean"},"max_response_rows":{"type":"integer","minimum":1,"maximum":20,"description":"Fixed groups use 1; repeatable groups use 2-20 (default 20).","uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX].max_response_rows","typeLabel":"integer"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.questions","typeLabel":"object[]"},"documents":{"type":"array","minItems":1,"maxItems":5,"description":"document_upload only; the full workflow supports at most five documents.","items":{"type":"object","required":["document_id","label"],"properties":{"document_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the full workflow.","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].document_id","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].label","typeLabel":"string"},"description":{"type":"string","maxLength":1000,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].description","typeLabel":"string"},"accepted_content_types":{"type":"array","minItems":1,"maxItems":4,"uniqueItems":true,"description":"Defaults to [application/pdf, image/jpeg, image/png] when omitted.","items":{"type":"string","enum":["application/pdf","image/jpeg","image/png","image/webp"],"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].accepted_content_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].accepted_content_types","typeLabel":"enum\u003cstring>[]"},"required":{"type":"boolean","default":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX].required","typeLabel":"boolean"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config.documents","typeLabel":"object[]"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX].config","typeLabel":"object"},"visible_when":{"type":"object","description":"Omitted for unconditional steps.","required":["step_id","question_id","equals"],"properties":{"step_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].visible_when.step_id","typeLabel":"string"},"question_id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].visible_when.question_id","typeLabel":"string"},"equals":{"type":"boolean","isRequired":true,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].visible_when.equals","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"progress.step_manifest.steps.items.[INDEX].visible_when","typeLabel":"object"}},"uniqueKey":"progress.step_manifest.steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"progress.step_manifest.steps","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"progress.step_manifest","typeLabel":"object"},"flow_steps":{"type":"array","description":"Per-step states in manifest order (v2). The legacy `steps` kind array is unchanged.","items":{"type":"object","description":"Consumer-safe per-step progress. detail carries only capture kinds, answer COUNTS (never values), and manifest document ids; no fraud/OCR/jurisdiction data ever appears on the token plane.\n","required":["step_id","type","required","state","detail"],"properties":{"step_id":{"type":"string","isRequired":true,"uniqueKey":"progress.flow_steps.items.[INDEX].step_id","typeLabel":"string"},"type":{"type":"string","enum":["liveness","id_capture","questionnaire","document_upload"],"isRequired":true,"uniqueKey":"progress.flow_steps.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"progress.flow_steps.items.[INDEX].required","typeLabel":"boolean"},"state":{"type":"string","enum":["pending","in_progress","complete","skipped","not_applicable"],"description":"`skipped` is the consumer's choice on an optional step. `not_applicable` is server-derived for a step whose `visible_when` is not met; it counts as satisfied for submit, and recipients hide the step. Token plane only.\n","isRequired":true,"uniqueKey":"progress.flow_steps.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"detail":{"type":"object","properties":{"captured_kinds":{"type":"array","items":{"type":"string","enum":["liveness_front","liveness_left","liveness_right","id_front","id_back"],"uniqueKey":"progress.flow_steps.items.[INDEX].detail.captured_kinds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"progress.flow_steps.items.[INDEX].detail.captured_kinds","typeLabel":"enum\u003cstring>[]"},"remaining_kinds":{"type":"array","items":{"type":"string","enum":["liveness_front","liveness_left","liveness_right","id_front","id_back"],"uniqueKey":"progress.flow_steps.items.[INDEX].detail.remaining_kinds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"progress.flow_steps.items.[INDEX].detail.remaining_kinds","typeLabel":"enum\u003cstring>[]"},"answered_count":{"type":"integer","minimum":0,"uniqueKey":"progress.flow_steps.items.[INDEX].detail.answered_count","typeLabel":"integer"},"question_count":{"type":"integer","minimum":0,"uniqueKey":"progress.flow_steps.items.[INDEX].detail.question_count","typeLabel":"integer"},"uploaded_document_ids":{"type":"array","items":{"type":"string","uniqueKey":"progress.flow_steps.items.[INDEX].detail.uploaded_document_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"progress.flow_steps.items.[INDEX].detail.uploaded_document_ids","typeLabel":"string[]"},"remaining_document_ids":{"type":"array","items":{"type":"string","uniqueKey":"progress.flow_steps.items.[INDEX].detail.remaining_document_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"progress.flow_steps.items.[INDEX].detail.remaining_document_ids","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"progress.flow_steps.items.[INDEX].detail","typeLabel":"object"}},"uniqueKey":"progress.flow_steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"progress.flow_steps","typeLabel":"object[]"},"steps":{"type":"array","items":{"type":"object","required":["kind","reserved","uploaded"],"properties":{"kind":{"type":"string","enum":["liveness_front","liveness_left","liveness_right","id_front","id_back"],"isRequired":true,"uniqueKey":"progress.steps.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"reserved":{"type":"boolean","isRequired":true,"uniqueKey":"progress.steps.items.[INDEX].reserved","typeLabel":"boolean"},"uploaded":{"type":"boolean","isRequired":true,"uniqueKey":"progress.steps.items.[INDEX].uploaded","typeLabel":"boolean"}},"uniqueKey":"progress.steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"progress.steps","typeLabel":"object[]"},"face_match_performed":{"type":"boolean","uniqueKey":"progress.face_match_performed","typeLabel":"boolean"},"completion":{"type":"object","additionalProperties":false,"required":["action"],"description":"Optional sanitized completion capability. Present only on the authenticated token-plane projection for sessions created with the corresponding application-only override.\n","properties":{"action":{"type":"string","enum":["close_tab","return_link"],"isRequired":true,"uniqueKey":"progress.completion.action","typeLabel":"enum\u003cstring>"},"return_url":{"type":"string","format":"uri","uniqueKey":"progress.completion.return_url","typeLabel":"string\u003curi>"}},"uniqueKey":"progress.completion","typeLabel":"object"}},"isRequired":true,"uniqueKey":"progress","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"session_token":"idvs_9c1f...redacted","token_expires_at":"2023-11-07T05:31:56Z","capture_manifest":{"workflow":"liveness_and_id","required_kinds":["liveness_front"]},"step_manifest":{"steps":[{"step_id":"\u003cstring>","type":"liveness","required":true,"title":"\u003cstring>","config":{"accepted_id_types":["driver_license"],"custom_id_types":[{"id_type":"\u003cstring>","label":"\u003cstring>","sides":"one_sided","description":"\u003cstring>"}],"sides":"auto","questions":[{"question_id":"\u003cstring>","label":"\u003cstring>","type":"text","required":true,"required_when":{"question_id":"\u003cstring>","equals":true},"visible_when":{"question_id":"\u003cstring>","equals":true},"options":[{"value":"\u003cstring>","label":"\u003cstring>"}],"response_fields":[{"field_id":"\u003cstring>","label":"\u003cstring>","required":true,"answer_type":"text"}],"allow_additional_responses":false,"max_response_rows":10}],"documents":[{"document_id":"\u003cstring>","label":"\u003cstring>","description":"\u003cstring>","accepted_content_types":["application/pdf"],"required":true}]},"visible_when":{"step_id":"\u003cstring>","question_id":"\u003cstring>","equals":true}}]},"progress":{"status":"collecting_artifacts","privacy_contact_email":"jsmith@example.com","consent_notice_locale":"en","consent_notice_version":"\u003cstring>","consent_notice_text":"\u003cstring>","consent_notice_digest":"\u003cstring>","capture_manifest":{"workflow":"liveness_and_id","required_kinds":["liveness_front"]},"step_manifest":{"steps":[{"step_id":"\u003cstring>","type":"liveness","required":true,"title":"\u003cstring>","config":{"accepted_id_types":["driver_license"],"custom_id_types":[{"id_type":"\u003cstring>","label":"\u003cstring>","sides":"one_sided","description":"\u003cstring>"}],"sides":"auto","questions":[{"question_id":"\u003cstring>","label":"\u003cstring>","type":"text","required":true,"required_when":{"question_id":"\u003cstring>","equals":true},"visible_when":{"question_id":"\u003cstring>","equals":true},"options":[{"value":"\u003cstring>","label":"\u003cstring>"}],"response_fields":[{"field_id":"\u003cstring>","label":"\u003cstring>","required":true,"answer_type":"text"}],"allow_additional_responses":false,"max_response_rows":10}],"documents":[{"document_id":"\u003cstring>","label":"\u003cstring>","description":"\u003cstring>","accepted_content_types":["application/pdf"],"required":true}]},"visible_when":{"step_id":"\u003cstring>","question_id":"\u003cstring>","equals":true}}]},"flow_steps":[{"step_id":"\u003cstring>","type":"liveness","required":true,"state":"pending","detail":{"captured_kinds":["liveness_front"],"remaining_kinds":["liveness_front"],"answered_count":1,"question_count":1,"uploaded_document_ids":["\u003cstring>"],"remaining_document_ids":["\u003cstring>"]}}],"steps":[{"kind":"liveness_front","reserved":true,"uploaded":true}],"face_match_performed":true,"completion":{"action":"close_tab","return_url":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"60f76a67-8e0d-4244-bbf4-dd17abfaabef":{"description":"Missing or invalid credentials (uniform for token plane, no existence oracle)","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"idv_session_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"idv_session_not_found","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"16bc0462-94b7-4920-850d-92ecf1154a3a":{"description":"Domain-state conflict, such as a concurrent update or an illegal transition (`idv_state_conflict`). `idv_session_unavailable`: the session cannot be changed right now. No change was made. Re-read the session before you retry the request.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"idv_session_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"idv_session_not_found","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3c7da9bb-dbb0-4c4d-94c7-31fdc8436ad4":{"inviteCredential":{"type":"http","scheme":"bearer","bearerFormat":"opaque","description":"`Authorization: Bearer idvi_\u003ccode>`: long-lived invite credential emailed to the end user. Header only; never a query param.","scopes":[],"schemeName":"inviteCredential"}}},"servers":{"2d270158-b0b4-4a7f-a4ee-f351d95099b6":{"url":"https://api.gominerva.com/idv/v1","description":"The production API server for Minerva identity verification"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"opaque","description":"`Authorization: Bearer idvi_\u003ccode>`: long-lived invite credential emailed to the end user. Header only; never a query param.","scopes":[],"schemeName":"inviteCredential"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"`Authorization: Bearer idvi_\u003ccode>`: long-lived invite credential emailed to the end user. Header only; never a query param.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"inviteCredential","name":"Authorization"}],"title":"inviteCredential"}]},"originalFileLocation":"api-reference/idv-svc.json"},"subdomain":"minerva-557aeab7","siteName":"Minerva Docs","title":"Exchange an invite for a fresh capture token - Minerva Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T01:21:43.914Z","originalFileLocation":"api-reference/capture/exchange-an-invite-for-a-fresh-capture-token.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Minerva Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Exchange an invite for a fresh capture token - Minerva Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Minerva Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://minerva-557aeab7.mintlify.site/_mintlify/api/og/v2?division=Capture\u0026amp;title=Exchange+an+invite+for+a+fresh+capture+token\u0026amp;description=Invite-credential+auth+%28the+bearer+is+the+%60idvi_%60+invite+code%2C+NOT+a+capture+token%29.+Validates+the+invite+%28constant-time+HMAC%2C+not+expired%2Fconsumed%2C+capture+win\u0026amp;theme=802683985af28e0bed63a6bd\u0026amp;signature=dc11a4142e9017a8924b6e0961cf13d68e395c14333d8da403473d953d58f8e6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Exchange an invite for a fresh capture token - Minerva Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://minerva-557aeab7.mintlify.site/_mintlify/api/og/v2?division=Capture\u0026amp;title=Exchange+an+invite+for+a+fresh+capture+token\u0026amp;description=Invite-credential+auth+%28the+bearer+is+the+%60idvi_%60+invite+code%2C+NOT+a+capture+token%29.+Validates+the+invite+%28constant-time+HMAC%2C+not+expired%2Fconsumed%2C+capture+win\u0026amp;theme=802683985af28e0bed63a6bd\u0026amp;signature=dc11a4142e9017a8924b6e0961cf13d68e395c14333d8da403473d953d58f8e6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Minerva Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4e26b1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gominerva.com/#organization\",\"name\":\"Minerva Docs\",\"url\":\"https://docs.gominerva.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/logo/minerva-dark.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=b6ef1ed1a0b7ff7df81fdbb1c2ac0db4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gominerva.com#website\",\"name\":\"Minerva Docs\",\"url\":\"https://docs.gominerva.com\",\"publisher\":{\"@id\":\"https://docs.gominerva.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token#webpage\",\"url\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token\",\"name\":\"Exchange an invite for a fresh capture token\",\"description\":\"Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\",\"dateModified\":\"2026-10-28T01:21:43.914Z\",\"isPartOf\":{\"@id\":\"https://docs.gominerva.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Identity Verification - Endpoints\",\"item\":\"https://docs.gominerva.com/api-reference/sessions/create-an-idv-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Exchange an invite for a fresh capture token\",\"item\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token#apireference\",\"headline\":\"Exchange an invite for a fresh capture token\",\"name\":\"Exchange an invite for a fresh capture token\",\"description\":\"Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).\",\"url\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gominerva.com/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token#webpage\"},\"dateModified\":\"2026-10-28T01:21:43.914Z\",\"publisher\":{\"@id\":\"https://docs.gominerva.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gominerva.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Minerva Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Minerva Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token.md","siteName":"Minerva Docs","nav":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"mailto:support@gominerva.com"},{"anchor":"Trust Page","icon":"shield","href":"https://app.conveyor.com/profile/gominerva"}]},"tabs":[{"tab":"Knowledge Hub","pages":[{"title":"Knowledge Hub","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Screening Integration Guide","href":"/api-reference/screening-integration-guide"},{"title":"IDV Integration Guide","href":"/api-reference/idv-integration-guide"},{"title":"Automatic Disposition Guide","tag":"New","href":"/api-reference/automatic-disposition-guide"},{"title":"API Keys","mode":"wide","href":"/api-reference/api-keys"},{"title":"Workspace management \u0026 tenant configuration via API","sidebarTitle":"Workspace Management API","href":"/api-reference/workspace-management-api"},{"title":"Automate custom lists via API","sidebarTitle":"Custom Lists API","href":"/api-reference/custom-lists-api"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"title":"Minerva MCP","mode":"wide","href":"/api-reference/minerva-mcp-guide"},{"title":"Search History","href":"/api-reference/search-history"},{"title":"Profile Groups API","href":"/api-reference/profile-groups"},{"title":"Profile Custom Fields API","href":"/api-reference/profile-custom-fields"},{"title":"Risk Assessment Agents API","tag":"New","href":"/api-reference/risk-assessment-agents"}]},{"group":"Screening - Endpoints","pages":[{"group":"Search","pages":[{"title":"Submit a batch search","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/search","href":"/api-reference/search/submit-a-batch-search"},{"title":"Get batch search results","deprecated":null,"version":null,"openapi":"/api-reference/core.json get /v1/search/{jobid}","href":"/api-reference/search/get-batch-search-results"},{"title":"Search one person or organization","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/search-sync","href":"/api-reference/search/search-one-person-or-organization"},{"title":"Submit a v2 search","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v2/search","href":"/api-reference/search/submit-a-v2-search"},{"title":"List search request history","deprecated":null,"version":null,"openapi":"/api-reference/core.json get /v2/search/requests","href":"/api-reference/search/list-search-request-history"},{"title":"Generate a PDF report","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/reports","href":"/api-reference/search/generate-a-pdf-report"}]},{"group":"Legacy","pages":[{"title":"Search one person or organization (legacy GET)","deprecated":true,"version":null,"openapi":"/api-reference/core.json get /v1/search-sync","href":"/api-reference/legacy/search-one-person-or-organization-legacy-get"}]},{"group":"API to UI Integration","pages":[{"title":"Send an API result to a user","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/sendAPIResultToUser","href":"/api-reference/api-to-ui-integration/send-an-api-result-to-a-user"}]}]},{"group":"Admin Actions - Endpoints","pages":[{"group":"Screening Webhooks","pages":[{"title":"Get screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /webhooks/v2/screening/{webhookId}","href":"/api-reference/screening-webhooks/get-screening-webhook"},{"title":"Delete screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /webhooks/v2/screening/{webhookId}","href":"/api-reference/screening-webhooks/delete-screening-webhook"},{"title":"Update screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /webhooks/v2/screening/{webhookId}","href":"/api-reference/screening-webhooks/update-screening-webhook"},{"title":"Test screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /webhooks/v2/screening/{webhookId}/test","href":"/api-reference/screening-webhooks/test-screening-webhook"},{"title":"List screening webhooks","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /webhooks/v2/screening","href":"/api-reference/screening-webhooks/list-screening-webhooks"},{"title":"Create screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /webhooks/v2/screening","href":"/api-reference/screening-webhooks/create-screening-webhook"}]},{"group":"Custom Lists","pages":[{"title":"Get custom-list entitlements","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/entitlements","href":"/api-reference/custom-lists/get-custom-list-entitlements"},{"title":"Get a workspace custom-list manifest","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/workspaces/{workspaceId}/manifest","href":"/api-reference/custom-lists/get-a-workspace-custom-list-manifest"},{"title":"Activate or deactivate a list in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json put /custom-lists/v2/organizations/{orgId}/workspaces/{workspaceId}/lists/{listId}/activation","href":"/api-reference/custom-lists/activate-or-deactivate-a-list-in-a-workspace"},{"title":"List custom lists","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}","href":"/api-reference/custom-lists/list-custom-lists"},{"title":"Create a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}","href":"/api-reference/custom-lists/create-a-custom-list"},{"title":"Download the generic upload template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/upload-template","href":"/api-reference/custom-lists/download-the-generic-upload-template"},{"title":"Get a custom-list background job","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/jobs/{jobId}","href":"/api-reference/custom-lists/get-a-custom-list-background-job"},{"title":"Get a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/get-a-custom-list"},{"title":"Archive a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/archive-a-custom-list"},{"title":"Update a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/update-a-custom-list"},{"title":"Get list deployment status","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/status","href":"/api-reference/custom-lists/get-list-deployment-status"},{"title":"Get unpublished changes","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/pending-changes","href":"/api-reference/custom-lists/get-unpublished-changes"},{"title":"Publish the working set","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/publish","href":"/api-reference/custom-lists/publish-the-working-set"},{"title":"Discard unpublished changes","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/discard","href":"/api-reference/custom-lists/discard-unpublished-changes"},{"title":"List published versions","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/versions","href":"/api-reference/custom-lists/list-published-versions"},{"title":"List records","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/records","href":"/api-reference/custom-lists/list-records"},{"title":"Add a record","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/records","href":"/api-reference/custom-lists/add-a-record"},{"title":"Archive a record","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /custom-lists/v2/organizations/{orgId}/{listId}/records/{recordId}","href":"/api-reference/custom-lists/archive-a-record"},{"title":"Update a record","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /custom-lists/v2/organizations/{orgId}/{listId}/records/{recordId}","href":"/api-reference/custom-lists/update-a-record"},{"title":"Set a record's status","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json put /custom-lists/v2/organizations/{orgId}/{listId}/records/{recordId}/status","href":"/api-reference/custom-lists/set-a-records-status"},{"title":"List uploads","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads","href":"/api-reference/custom-lists/list-uploads"},{"title":"Upload parsed records","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads","href":"/api-reference/custom-lists/upload-parsed-records"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/file","href":"/api-reference/custom-lists/upload-a-file"},{"title":"Preview parsed records","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/preview","href":"/api-reference/custom-lists/preview-parsed-records"},{"title":"Preview a file","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/preview/file","href":"/api-reference/custom-lists/preview-a-file"},{"title":"Download the list's upload template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads/template","href":"/api-reference/custom-lists/download-the-lists-upload-template"},{"title":"Get an upload","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads/{uploadId}","href":"/api-reference/custom-lists/get-an-upload"},{"title":"Get upload status","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads/{uploadId}/status","href":"/api-reference/custom-lists/get-upload-status"},{"title":"Publish an upload","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/{uploadId}/publish","href":"/api-reference/custom-lists/publish-an-upload"}]},{"group":"CRR Scorecards","pages":[{"title":"List CRR scorecards","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards","href":"/api-reference/crr-scorecards/list-crr-scorecards"},{"title":"Create a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards","href":"/api-reference/crr-scorecards/create-a-crr-scorecard"},{"title":"List scorecard revisions","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}/revisions","href":"/api-reference/crr-scorecards/list-scorecard-revisions"},{"title":"Get a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}","href":"/api-reference/crr-scorecards/get-a-crr-scorecard"},{"title":"Archive a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}","href":"/api-reference/crr-scorecards/archive-a-crr-scorecard"},{"title":"Update a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}","href":"/api-reference/crr-scorecards/update-a-crr-scorecard"},{"title":"Set the default scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}/default","href":"/api-reference/crr-scorecards/set-the-default-scorecard"}]},{"group":"CRR Profile Templates","pages":[{"title":"List CRR profile templates","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates","href":"/api-reference/crr-profile-templates/list-crr-profile-templates"},{"title":"Create a CRR profile template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates","href":"/api-reference/crr-profile-templates/create-a-crr-profile-template"},{"title":"List selectable templates","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/selectable","href":"/api-reference/crr-profile-templates/list-selectable-templates"},{"title":"Get a CRR profile template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}","href":"/api-reference/crr-profile-templates/get-a-crr-profile-template"},{"title":"Update a CRR profile template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}","href":"/api-reference/crr-profile-templates/update-a-crr-profile-template"},{"title":"Activate a template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}/activate","href":"/api-reference/crr-profile-templates/activate-a-template"},{"title":"Archive a template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}/archive","href":"/api-reference/crr-profile-templates/archive-a-template"},{"title":"List template revisions","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}/revisions","href":"/api-reference/crr-profile-templates/list-template-revisions"}]},{"group":"Workspaces","pages":[{"title":"Get a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}","href":"/api-reference/workspaces/get-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}","href":"/api-reference/workspaces/update-a-workspace"},{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}","href":"/api-reference/workspaces/create-a-workspace"}]},{"group":"Workspace Presets","pages":[{"title":"List presets","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/presets","href":"/api-reference/workspace-presets/list-presets"},{"title":"Create a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/presets","href":"/api-reference/workspace-presets/create-a-preset"},{"title":"Delete a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}/presets/{presetId}","href":"/api-reference/workspace-presets/delete-a-preset"},{"title":"Update a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/presets/{presetId}","href":"/api-reference/workspace-presets/update-a-preset"},{"title":"Apply a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/presets/{presetId}/promotions","href":"/api-reference/workspace-presets/apply-a-preset"}]},{"group":"Profile Groups","pages":[{"title":"List profile groups","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups","href":"/api-reference/profile-groups/list-profile-groups"},{"title":"Create a profile group","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups","href":"/api-reference/profile-groups/create-a-profile-group"},{"title":"Delete a profile group","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups/{profileGroupId}","href":"/api-reference/profile-groups/delete-a-profile-group"},{"title":"Update a profile group","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups/{profileGroupId}","href":"/api-reference/profile-groups/update-a-profile-group"}]}]},{"group":"Profiles - Endpoints","pages":[{"group":"Profile Management","pages":[{"title":"Create and screen a profile","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /onboarding/profiles","href":"/api-reference/profile-management/create-and-screen-a-profile"},{"title":"List profiles","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profiles","href":"/api-reference/profile-management/list-profiles"},{"title":"Create a profile","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profiles","href":"/api-reference/profile-management/create-a-profile"},{"title":"Get profile details","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profiles/{profileId}","href":"/api-reference/profile-management/get-profile-details"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json patch /profiles/{profileId}","href":"/api-reference/profile-management/update-a-profile"},{"title":"Add a profile comment","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profiles/{profileId}/comments","href":"/api-reference/profile-management/add-a-profile-comment"},{"title":"Generate a profile audit PDF","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profile-audit-reports/v1/profiles/{profile_id}/pdf","href":"/api-reference/profile-management/generate-a-profile-audit-pdf"},{"title":"List profile groups","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profile-groups","href":"/api-reference/profile-management/list-profile-groups"},{"title":"Create a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profile-groups","href":"/api-reference/profile-management/create-a-profile-group"},{"title":"Get a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profile-groups/{profileGroupId}","href":"/api-reference/profile-management/get-a-profile-group"},{"title":"Archive a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json delete /profile-groups/{profileGroupId}","href":"/api-reference/profile-management/archive-a-profile-group"},{"title":"Update a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json patch /profile-groups/{profileGroupId}","href":"/api-reference/profile-management/update-a-profile-group"}]},{"group":"Potential Matches","pages":[{"title":"Update potential match status","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json patch /v2/search/matches/{match_id}","href":"/api-reference/potential-matches/update-potential-match-status"}]}]},{"group":"Agent Risk Assessments - Endpoints","pages":[{"group":"Configuration","pages":[{"title":"List risk assessment workflows","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /workflows","href":"/api-reference/configuration/list-risk-assessment-workflows"},{"title":"List assessment and task statuses","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /status-definitions","href":"/api-reference/configuration/list-assessment-and-task-statuses"},{"title":"List client risk rating scorecards","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /crr-scorecards","href":"/api-reference/configuration/list-client-risk-rating-scorecards"}]},{"group":"Assessments","pages":[{"title":"List risk assessments","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments","href":"/api-reference/assessments/list-risk-assessments"},{"title":"Create a risk assessment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments","href":"/api-reference/assessments/create-a-risk-assessment"},{"title":"Get a risk assessment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}","href":"/api-reference/assessments/get-a-risk-assessment"},{"title":"Get assessment summary","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/summary","href":"/api-reference/assessments/get-assessment-summary"},{"title":"Get assessment tasks, notes, and interrupts","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/tasks","href":"/api-reference/assessments/get-assessment-tasks-notes-and-interrupts"},{"title":"Update assessment title","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/title","href":"/api-reference/assessments/update-assessment-title"},{"title":"Append assessment uploads","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/uploads","href":"/api-reference/assessments/append-assessment-uploads"},{"title":"Start an assessment agent run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/start","href":"/api-reference/assessments/start-an-assessment-agent-run"},{"title":"Stop an assessment and its latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/stop","href":"/api-reference/assessments/stop-an-assessment-and-its-latest-run"},{"title":"Cancel an assessment and its latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/cancel","href":"/api-reference/assessments/cancel-an-assessment-and-its-latest-run"},{"title":"Conclude an assessment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/conclude","href":"/api-reference/assessments/conclude-an-assessment"}]},{"group":"Review And Collaboration","pages":[{"title":"List assessment comments","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/comments","href":"/api-reference/review-and-collaboration/list-assessment-comments"},{"title":"Add an assessment comment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/comments","href":"/api-reference/review-and-collaboration/add-an-assessment-comment"},{"title":"Update task status","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/tasks/{taskId}/status","href":"/api-reference/review-and-collaboration/update-task-status"},{"title":"Update task details","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/tasks/{taskId}","href":"/api-reference/review-and-collaboration/update-task-details"},{"title":"Append assessment notes","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/notes/append","href":"/api-reference/review-and-collaboration/append-assessment-notes"},{"title":"Replace assessment notes","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json put /assessments/{assessmentId}/notes","href":"/api-reference/review-and-collaboration/replace-assessment-notes"},{"title":"Answer an agent question","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/questions/{questionId}/answer","href":"/api-reference/review-and-collaboration/answer-an-agent-question"},{"title":"Resolve an agent confirmation","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/confirmations/{confirmationId}/resolve","href":"/api-reference/review-and-collaboration/resolve-an-agent-confirmation"}]},{"group":"Relationships Canvas","pages":[{"title":"Get or create the default canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/canvas","href":"/api-reference/relationships-canvas/get-or-create-the-default-canvas"},{"title":"Save the default canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json put /assessments/{assessmentId}/canvas","href":"/api-reference/relationships-canvas/save-the-default-canvas"},{"title":"List assessment canvases","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/canvases","href":"/api-reference/relationships-canvas/list-assessment-canvases"},{"title":"Create a canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/canvases","href":"/api-reference/relationships-canvas/create-a-canvas"},{"title":"Get a canvas by ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/get-a-canvas-by-id"},{"title":"Rename a canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/rename-a-canvas"},{"title":"Delete a canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json delete /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/delete-a-canvas"},{"title":"Save a canvas by ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json put /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/save-a-canvas-by-id"}]},{"group":"Agent Runtime","pages":[{"title":"Get the latest assessment run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/run","href":"/api-reference/agent-runtime/get-the-latest-assessment-run"},{"title":"Get an assessment run by ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/runs/{runId}","href":"/api-reference/agent-runtime/get-an-assessment-run-by-id"},{"title":"List the latest run trajectory","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/trajectory","href":"/api-reference/agent-runtime/list-the-latest-run-trajectory"},{"title":"List run trajectory by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/runs/{runId}/trajectory","href":"/api-reference/agent-runtime/list-run-trajectory-by-run-id"},{"title":"List commands on the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/commands","href":"/api-reference/agent-runtime/list-commands-on-the-latest-run"},{"title":"List run commands by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/runs/{runId}/commands","href":"/api-reference/agent-runtime/list-run-commands-by-run-id"},{"title":"Create a command on the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/commands","href":"/api-reference/agent-runtime/create-a-command-on-the-latest-run"},{"title":"Create a run command by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/commands","href":"/api-reference/agent-runtime/create-a-run-command-by-run-id"},{"title":"Send user input to the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/input","href":"/api-reference/agent-runtime/send-user-input-to-the-latest-run"},{"title":"Send user input to a run by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/input","href":"/api-reference/agent-runtime/send-user-input-to-a-run-by-run-id"},{"title":"Steer the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/steer","href":"/api-reference/agent-runtime/steer-the-latest-run"},{"title":"Steer a run by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/steer","href":"/api-reference/agent-runtime/steer-a-run-by-run-id"},{"title":"Resume the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/resume","href":"/api-reference/agent-runtime/resume-the-latest-run"},{"title":"Resume a run by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/resume","href":"/api-reference/agent-runtime/resume-a-run-by-run-id"}]}]},{"group":"Identity Verification - Endpoints","pages":[{"group":"Sessions","pages":[{"title":"Create an IDV session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions","href":"/api-reference/sessions/create-an-idv-session"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Poll a session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}","href":"/api-reference/sessions/poll-a-session"},{"title":"Send a verification invite","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/invite","href":"/api-reference/sessions/send-a-verification-invite"},{"title":"Cancel a session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/cancel","href":"/api-reference/sessions/cancel-a-session"},{"title":"Public branding for a session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/branding","href":"/api-reference/sessions/public-branding-for-a-session"},{"title":"Public session logo bytes","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/branding/logo","href":"/api-reference/sessions/public-session-logo-bytes"},{"title":"Public session square-logo bytes","description":"The session's COPIED square (1:1) logo (always image/png after the upload re-encode); the QR-centre mark, an INDEPENDENT asset slot from the wide header logo. UNIFORM 404 with the same body when the session is unknown OR has no square logo, not an existence oracle. On hit: `ETag: \"\u003casset_id>\"` and `Cache-Control: public, max-age=31536000, immutable` (safe because a replacement upload mints a new asset id and consumer URLs carry `?v=\u003casset_id>`).\n","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/branding/logo/square","href":"/api-reference/sessions/public-session-square-logo-bytes"}]},{"group":"Capture","pages":[{"title":"Exchange an invite for a fresh capture token","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/acquire","href":"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token"},{"title":"Session-scoped progress for the capture UI","description":"Accepts EITHER a capture token OR an invite credential (the desktop polls on the invite scope while the phone captures). A direct single-use invite remains authorized for this read-only route after its successful acquire, until expiry; it cannot acquire again or authorize another mutation. Minimal progress projection: no tenant/workspace, no upload references, no OCR/jurisdiction/fraud detail. Also returns the resolved capture manifest. Path sessionId must equal the credential's sessionId.\n","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/status","href":"/api-reference/capture/session-scoped-progress-for-the-capture-ui"},{"title":"Record consumer consent","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/consent","href":"/api-reference/capture/record-consumer-consent"},{"title":"Reserve an artifact slot","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/artifacts","href":"/api-reference/capture/reserve-an-artifact-slot"},{"title":"Upload artifact bytes","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /sessions/{sessionId}/artifacts/{artifactId}/object","href":"/api-reference/capture/upload-artifact-bytes"},{"title":"Submit questionnaire answers","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /sessions/{sessionId}/steps/{stepId}/answers","href":"/api-reference/capture/submit-questionnaire-answers"},{"title":"Skip an optional step","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/steps/{stepId}/skip","href":"/api-reference/capture/skip-an-optional-step"},{"title":"Record the document type","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/document-type","href":"/api-reference/capture/record-the-document-type"},{"title":"Submit for assessment","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/submit","href":"/api-reference/capture/submit-for-assessment"}]},{"group":"Review","pages":[{"title":"Apply a human review decision","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/review","href":"/api-reference/review/apply-a-human-review-decision"},{"title":"Get decrypted session data","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/data","href":"/api-reference/review/get-decrypted-session-data"},{"title":"Per-profile review summary","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /profiles/{profileId}/review-summary","href":"/api-reference/review/per-profile-review-summary"}]},{"group":"Workflows","pages":[{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"List workflows (newest first)","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /workflows","href":"/api-reference/workflows/list-workflows-newest-first"},{"title":"Show a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /workflows/{workflowId}","href":"/api-reference/workflows/show-a-workflow"},{"title":"Replace a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /workflows/{workflowId}","href":"/api-reference/workflows/replace-a-workflow"},{"title":"Activate a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows/{workflowId}/activate","href":"/api-reference/workflows/activate-a-workflow"},{"title":"Archive a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows/{workflowId}/archive","href":"/api-reference/workflows/archive-a-workflow"},{"title":"Make a workflow the scope default","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows/{workflowId}/default","href":"/api-reference/workflows/make-a-workflow-the-scope-default"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /workflows/{workflowId}","href":"/api-reference/workflows/delete-a-workflow"}]},{"group":"Themes","pages":[{"title":"Create a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes","href":"/api-reference/themes/create-a-theme"},{"title":"List themes (newest first)","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes","href":"/api-reference/themes/list-themes-newest-first"},{"title":"Show a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes/{themeId}","href":"/api-reference/themes/show-a-theme"},{"title":"Replace a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /themes/{themeId}","href":"/api-reference/themes/replace-a-theme"},{"title":"Activate a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes/{themeId}/activate","href":"/api-reference/themes/activate-a-theme"},{"title":"Archive a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes/{themeId}/archive","href":"/api-reference/themes/archive-a-theme"},{"title":"Make a theme the scope default","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes/{themeId}/default","href":"/api-reference/themes/make-a-theme-the-scope-default"},{"title":"Upload a logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /themes/{themeId}/logo","href":"/api-reference/themes/upload-a-logo"},{"title":"Stream the theme's logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes/{themeId}/logo","href":"/api-reference/themes/stream-the-themes-logo"},{"title":"Remove the theme's logo reference","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /themes/{themeId}/logo","href":"/api-reference/themes/remove-the-themes-logo-reference"},{"title":"Upload the square logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /themes/{themeId}/logo/square","href":"/api-reference/themes/upload-the-square-logo"},{"title":"Stream the theme's square logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes/{themeId}/logo/square","href":"/api-reference/themes/stream-the-themes-square-logo"},{"title":"Remove the theme's square logo reference","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /themes/{themeId}/logo/square","href":"/api-reference/themes/remove-the-themes-square-logo-reference"},{"title":"Delete a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /themes/{themeId}","href":"/api-reference/themes/delete-a-theme"}]}]}]}]},"basePath":"","title":"Exchange an invite for a fresh capture token - Minerva Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}