Response profile. Omit or 'full' for the full response (default, unchanged). 'slim' returns the compact, typed customer-facing shape. Any other value returns 400.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"GBG Documentation","colors":{"primary":"#4D4DFF","light":"#7878FF","dark":"#4D4DFF"},"logo":{"light":"https://mintcdn.com/gbg-loqate/sjraMdPLPALUqj3-/images/logo/gbg-logo.svg?fit=max\u0026auto=format\u0026n=sjraMdPLPALUqj3-\u0026q=85\u0026s=d0c979ecdf20524de2314bb87e294371","dark":"https://mintcdn.com/gbg-loqate/sjraMdPLPALUqj3-/images/logo/gbg-logo-white.svg?fit=max\u0026auto=format\u0026n=sjraMdPLPALUqj3-\u0026q=85\u0026s=6d011aecdbc2a8e0ea344158a7d707be"},"favicon":"https://mintcdn.com/gbg-loqate/wtQrQDGWEOTCei9M/images/gbg_favicon.png?fit=max\u0026auto=format\u0026n=wtQrQDGWEOTCei9M\u0026q=85\u0026s=d5c632e94264d4d3686317bb4ef521df","appearance":{"default":"light"},"background":{"color":{"dark":"#0F0F1A"}},"navbar":{"links":[{"href":"https://www.gbgplc.com/en/contact/customer-support-enquiry/","label":"Support"},{"href":"https://www.gbgplc.com/en/blog/","label":"Blog"}],"primary":{"type":"button","label":"Platform login","href":"https://platform.go.gbgplc.com"}},"footer":{"socials":{"x":"https://twitter.com/gbgplc","facebook":"https://www.facebook.com/GBGplc","linkedin":"https://www.linkedin.com/company/gb-group"}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{},"contextual":{"options":["copy","view","mcp","add-mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gbg-loqate","hasAudioNarration":false,"actualSubdomain":"gbg-loqate","customDomains":["docs.go.gbgplc.com"],"gitSource":{"type":"github","owner":"gbgplc-internal","repo":"identity-gbggo-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af20442bb870c50d51c825d","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Documentation","count":313},{"language":"default","tag":"Platform","count":179},{"language":"default","tag":"SDKs","count":114},{"language":"default","tag":"Modules","count":79},{"language":"default","tag":"Digital IDs","count":65},{"language":"default","tag":"Digital ID providers","count":64},{"language":"default","tag":"Guides","count":50},{"language":"default","tag":"Europe","count":35},{"language":"default","tag":"API Reference","count":25},{"language":"default","tag":"Release Notes","count":24}],"searchSettings":{"showContentSnippets":true,"maxResults":6,"isFiltersEnabled":true}},"assistantConfig":{"deflection":{"enabled":false,"type":"link","email":"chisom.uma@gbgplc.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"docs/styles.css","href":"/_mintlify/custom/gbg-loqate/5e3c332b44d16f07/docs/styles.css"},{"filePath":"snippets/home.css","content":"#navbar-transition-willow,#navbar-transition{background-color:#FFF}.dark #navbar-transition-willow,.dark #navbar-transition{background-color:rgb(var(--background-dark)/.75)}[data-theme=\"dark\"] .docs-container::before,.dark .docs-container::before{content:\"\";position:fixed;width:300px;height:300px;border-radius:50%;background:radial-gradient(\n circle,\n rgba(77, 77, 255, 0.1) 0%,\n transparent 70%\n );z-index:-1;animation:float 15s ease-in-out infinite alternate}[data-theme=\"dark\"] .docs-container::after,.dark .docs-container::after{content:\"\";position:fixed;width:250px;height:250px;border-radius:50%;background:radial-gradient(\n circle,\n rgba(110, 108, 255, 0.08) 0%,\n transparent 70%\n );z-index:-1;animation:float 20s ease-in-out infinite alternate-reverse}@keyframes float{0%{transform:translate(0, 0)}100%{transform:translate(40px, 20px)}}:root{--gbg-primary: #4d4dff;--gbg-primary-light: #6e6cff;--gbg-dark-blue: #0f1023;--gbg-card-bg: #fff;--gbg-text: #333;--gbg-secondary-text: #666;--gbg-border: #eaeaea;--gbg-card-bg-dark: #0F0F1A;--gbg-dark-bg: #0F0F1A;--gbg-dark-bg-gradient-start: #0F0F1A;--gbg-dark-bg-gradient-end: #171839;--gbg-text-dark: #f1f1f3;--gbg-secondary-text-dark: #b6b7c5;--gbg-border-dark: rgba(110, 108, 255, 0.2)}[data-theme=\"dark\"],.dark{--gbg-card-bg: var(--gbg-card-bg-dark);--gbg-text: var(--gbg-text-dark);--gbg-secondary-text: var(--gbg-secondary-text-dark);--gbg-border: var(--gbg-border-dark)}[data-theme=\"dark\"] .docs-container,.dark .docs-container{background-color:var(#0F0F1A)}.docs-container{font-family:\"DM Sans\", -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto,\n Oxygen, Ubuntu, Cantarell, \"Open Sans\", \"Helvetica Neue\", sans-serif;color:var(--gbg-text);max-width:100%;margin:25px;padding:0}[data-theme=\"dark\"] .docs-container,.dark .docs-container{background:linear-gradient(\n 135deg,\n var(--gbg-dark-bg-gradient-start) 0%,\n var(--gbg-dark-bg-gradient-end) 100%\n );color:var(--gbg-text-dark)}.home-announcement{display:flex;align-items:flex-start;gap:12px;margin:0 0 32px 0;padding:16px 20px;border:1px solid rgba(16, 185, 129, 0.3);border-radius:12px;background:rgba(16, 185, 129, 0.08);font-size:0.9375rem;line-height:1.5}.home-announcement .home-announcement-icon{flex-shrink:0;font-size:1.25rem;line-height:1.4}.home-announcement-title{font-weight:600;margin:0 0 4px 0}.home-announcement-title-normal{font-weight:400}.home-announcement-body{margin:0;color:var(--gray-700, #374151)}.dark .home-announcement-body{color:var(--gray-300, #d1d5db)}.home-announcement-body a{font-weight:600;text-decoration:underline;color:#059669}.dark .home-announcement-body a{color:#34d399}.hero-section{background:linear-gradient(135deg, #4d4dff 0%, #2828bd 100%);color:white;position:relative;overflow:hidden;padding:0;margin:-24px -24px 32px -24px}.hero-section::before{content:\"\";position:absolute;top:0;right:0;width:400px;height:400px;background:radial-gradient(\n circle,\n rgba(255, 255, 255, 0.1) 0%,\n transparent 70%\n );z-index:1}.hero-section::after{content:\"\";position:absolute;bottom:-100px;left:-100px;width:300px;height:300px;border-radius:50%;border:1px solid rgba(255, 255, 255, 0.1);z-index:1}.grid-background{position:absolute;top:0;left:0;width:100%;height:100%;z-index:1;opacity:0.6}.grid-lines-horizontal{position:absolute;top:0;left:0;width:100%;height:100%;background-image:linear-gradient(\n to bottom,\n rgba(255, 255, 255, 0.15) 1px,\n transparent 1px\n );background-size:100% 80px}.grid-lines-vertical{position:absolute;top:0;left:0;width:100%;height:100%;background-image:linear-gradient(\n to right,\n rgba(255, 255, 255, 0.15) 1px,\n transparent 1px\n );background-size:80px 100%}.bg-decoration{position:absolute;opacity:0.1}.circle-1{width:300px;height:300px;border-radius:50%;border:2px solid white;top:-150px;right:10%}.circle-2{width:200px;height:200px;border-radius:50%;border:2px solid white;bottom:-100px;left:5%}.circle-3{width:150px;height:150px;background:rgba(255, 255, 255, 0.2);border-radius:50%;top:30%;right:30%;filter:blur(30px)}.dot-grid{width:200px;height:100px;background-image:radial-gradient(\n rgba(255, 255, 255, 0.4) 1px,\n transparent 1px\n );background-size:20px 20px;top:50%;left:15%}.hero-container{display:flex;padding:44px 32px;max-width:1200px;margin:0 auto;position:relative;z-index:2;min-height:0;align-items:center}.hero-content{flex:1;max-width:60%}.hero-content h1{font-size:1.75rem;font-weight:600;margin-bottom:0.5rem;line-height:1.2;color:white}.hero-content p{font-size:1rem;line-height:1.4;margin-bottom:1rem;color:rgba(255, 255, 255, 0.9)}.inline-link{color:white;text-decoration:underline;font-weight:500}.hero-buttons{display:flex;flex-wrap:wrap;gap:16px}.btn-primary,.btn-secondary{display:inline-block;padding:10px 24px;border-radius:4px;font-size:1rem;font-weight:500;cursor:pointer;transition:all 0.2s ease;text-decoration:none}.btn-primary{background-color:white;color:var(--gbg-primary);border:none}.btn-primary:hover{background-color:rgba(255, 255, 255, 0.9);transform:translateY(-2px)}.btn-secondary{background-color:transparent;color:white;border:1px solid white}.btn-secondary:hover{background-color:rgba(255, 255, 255, 0.1);transform:translateY(-2px)}.hero-graphic{flex:1;display:flex;justify-content:flex-end;align-items:center;max-width:25%}.accent-shape{max-width:180px;width:100%;height:auto;filter:drop-shadow(0 10px 20px rgba(0, 0, 0, 0.3))}.cards-container{max-width:1200px;margin:64px auto 64px auto;padding:0 32px;position:relative;z-index:2}[data-theme=\"dark\"] .card-content,.dark .card-content{color:white}.cards-row{display:grid;grid-template-columns:repeat(auto-fit, minmax(300px, 1fr));gap:24px;margin-bottom:24px}.cards-row-centered{grid-template-columns:minmax(300px, calc(50% - 12px));justify-content:center}.card{background-color:#1a1a1a;border:1px solid var(--gbg-border);border-radius:8px;padding:24px;display:flex;align-items:flex-start;justify-content:space-between;transition:all 0.3s ease;text-decoration:none;color:#ffffff;cursor:pointer}.card:hover{box-shadow:0 4px 12px rgba(0, 0, 0, 0.1);transform:translateY(-2px);border-color:var(--gbg-primary-light)}[data-theme=\"dark\"] .card,.dark .card{background:linear-gradient(\n 145deg,\n rgba(23, 24, 57, 0.9) 0%,\n rgba(15, 16, 35, 0.9) 100%\n );border-color:rgba(77, 77, 255, 0.2);box-shadow:0 8px 32px rgba(0, 0, 0, 0.2), 0 0 0 1px rgba(77, 77, 255, 0.1);backdrop-filter:blur(4px);-webkit-backdrop-filter:blur(4px)}[data-theme=\"dark\"] .card:hover,.dark .card:hover{border-color:var(--gbg-primary);box-shadow:0 8px 32px rgba(77, 77, 255, 0.15),\n 0 0 0 1px rgba(77, 77, 255, 0.4);background:linear-gradient(\n 145deg,\n rgba(30, 31, 72, 0.9) 0%,\n rgba(23, 24, 57, 0.9) 100%\n );transform:translateY(-3px)}.cards-row{display:grid;grid-template-columns:repeat(auto-fit, minmax(300px, 1fr));gap:24px;margin-bottom:24px}.card{background-color:var(--gbg-card-bg);border:1px solid var(--gbg-border);border-radius:8px;padding:24px;display:flex;align-items:flex-start;justify-content:space-between;transition:all 0.3s ease;text-decoration:none;color:var(--gbg-text);cursor:pointer}.card:hover{box-shadow:0 4px 12px rgba(0, 0, 0, 0.1);transform:translateY(-2px);border-color:var(--gbg-primary-light)}.card-content{flex:1}.card h2{font-size:1.25rem;font-weight:600;margin-top:0;margin-bottom:12px;color:var(--gbg-text)}.card p{font-size:1rem;color:var(--gbg-secondary-text);margin:0;line-height:1.5}.arrow-icon{display:flex;align-items:center;justify-content:center;margin-left:16px;transition:transform 0.2s ease}.card:hover .arrow-icon{transform:translateX(4px)}[data-theme=\"dark\"] .arrow-icon svg path,.dark .arrow-icon svg path{stroke:var(--gbg-primary-light);stroke-width:2.5}.roles-container{background-color:#f8f9fa;padding:64px 32px;margin:0 -24px;position:relative;overflow:hidden}[data-theme=\"dark\"] .roles-container,.dark .roles-container{background:linear-gradient(\n to bottom,\n rgba(15, 16, 35, 0.7),\n rgba(23, 24, 57, 0.7)\n );border-top:1px solid rgba(77, 77, 255, 0.1);border-bottom:1px solid rgba(77, 77, 255, 0.1);position:relative}[data-theme=\"dark\"] .roles-container::before,.dark .roles-container::before{content:\"\";position:absolute;top:0;left:0;width:100%;height:100%;background-image:url(\"data:image/svg+xml,%3Csvg width='60' height='60' viewBox='0 0 60 60' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M54.627 0l.83.828-1.415 1.415L51.8 0h2.827zM5.373 0l-.83.828L5.96 2.243 8.2 0H5.374zM48.97 0l3.657 3.657-1.414 1.414L46.143 0h2.828zM11.03 0L7.372 3.657 8.787 5.07 13.857 0H11.03zm32.284 0L49.8 6.485 48.384 7.9l-7.9-7.9h2.83zM16.686 0L10.2 6.485 11.616 7.9l7.9-7.9h-2.83zm20.97 0l9.315 9.314-1.414 1.414L34.828 0h2.83zM22.344 0L13.03 9.314l1.414 1.414L25.172 0h-2.83zM32 0l12.142 12.142-1.414 1.414L30 .828 17.272 13.556l-1.414-1.414L28 0h4zM.284 0l28 28-1.414 1.414L0 2.544V0h.284zM0 5.373l25.456 25.455-1.414 1.415L0 8.2V5.374zm0 5.656l22.627 22.627-1.414 1.414L0 13.86v-2.83zm0 5.656l19.8 19.8-1.415 1.413L0 19.514v-2.83zm0 5.657l16.97 16.97-1.414 1.415L0 25.172v-2.83zM0 28l14.142 14.142-1.414 1.414L0 30.828V28zm0 5.657L11.314 44.97 9.9 46.386l-9.9-9.9v-2.828zm0 5.657L8.485 47.8 7.07 49.212 0 42.143v-2.83zm0 5.657l5.657 5.657-1.414 1.415L0 47.8v-2.83zm0 5.657l2.828 2.83-1.414 1.413L0 53.456v-2.83zM54.627 60L30 35.373 5.373 60H8.2L30 38.2 51.8 60h2.827zm-5.656 0L30 41.03 11.03 60h2.828L30 43.858 46.142 60h2.83zm-5.656 0L30 46.686 16.686 60h2.83L30 49.515 40.485 60h2.83zm-5.657 0L30 52.343 22.344 60h2.83L30 55.172 34.828 60h2.83zM32 60l-2-2-2 2h4zM59.716 0l-28 28 1.414 1.414L60 2.544V0h-.284zM60 5.373L34.544 30.828l1.414 1.415L60 8.2V5.374zm0 5.656L37.373 33.656l1.414 1.414L60 13.86v-2.83zm0 5.656l-19.8 19.8 1.415 1.413L60 19.514v-2.83zm0 5.657l-16.97 16.97 1.414 1.415L60 25.172v-2.83zM60 28L45.858 42.142l1.414 1.414L60 30.828V28zm0 5.657L48.686 44.97l1.415 1.415 9.9-9.9v-2.828zm0 5.657L51.515 47.8l1.414 1.413 7.07-7.07v-2.83zm0 5.657l-5.657 5.657 1.414 1.415L60 47.8v-2.83zm0 5.657l-2.828 2.83 1.414 1.413L60 53.456v-2.83zM39.9 16.385l1.414-1.414 1.413 1.414-1.414 1.414-1.414-1.414zm-4.243 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.242 4.243l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.243 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm16.97-16.97l1.414-1.415 1.414 1.414-1.414 1.414-1.414-1.414zm-4.242 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.243 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.242 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.243 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm16.97-16.97l1.415-1.414 1.414 1.414-1.414 1.414-1.414-1.414zM20.97 16.385l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.242 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.243 4.243l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm16.97-16.97l1.414-1.415 1.414 1.414-1.414 1.414-1.414-1.414zm-4.242 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zM16.727 20.97l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.243 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414zm-4.242 4.242l1.414-1.414 1.414 1.414-1.414 1.414-1.414-1.414z' fill='%235551F7' fill-opacity='0.05' fill-rule='evenodd'/%3E%3C/svg%3E\");opacity:0.3;z-index:-1}.roles-container h2{font-size:1.75rem;text-align:center;margin-bottom:40px;color:var(--gbg-text)}.roles-grid{display:grid;grid-template-columns:repeat(auto-fit, minmax(300px, 1fr));gap:32px;max-width:1200px;margin:0 auto}.roles-compare{position:relative;z-index:1;margin:32px 0 0;text-align:center;font-size:1rem}.roles-compare a{color:var(--gbg-primary);font-weight:600;text-decoration:none;border-bottom:1px solid transparent}.roles-compare a:hover{border-bottom-color:var(--gbg-primary)}.dark .roles-compare a,[data-theme=\"dark\"] .roles-compare a{color:var(--gbg-primary-light)}.role-card{background-color:white;border-radius:8px;padding:24px;text-decoration:none;color:var(--gbg-text);transition:all 0.3s ease;border:1px solid var(--gbg-border)}[data-theme=\"dark\"] .role-card,.dark .role-card{background:linear-gradient(\n 145deg,\n rgba(23, 24, 57, 0.9) 0%,\n rgba(15, 16, 35, 0.9) 100%\n );border-color:rgba(77, 77, 255, 0.2);box-shadow:0 8px 32px rgba(0, 0, 0, 0.2), 0 0 0 1px rgba(77, 77, 255, 0.1)}[data-theme=\"dark\"] .role-card:hover,.dark .role-card:hover{border-color:var(--gbg-primary);box-shadow:0 8px 32px rgba(77, 77, 255, 0.15),\n 0 0 0 1px rgba(77, 77, 255, 0.4);background:linear-gradient(\n 145deg,\n rgba(30, 31, 72, 0.9) 0%,\n rgba(23, 24, 57, 0.9) 100%\n )}.role-card:hover{transform:translateY(-5px);box-shadow:0 8px 16px rgba(0, 0, 0, 0.1);border-color:var(--gbg-primary-light)}.role-icon{width:48px;height:48px;border-radius:8px;margin-bottom:16px;background-color:rgba(77, 77, 255, 0.1);position:relative}.business-icon::before,.developer-icon::before,.sdk-icon::before,.invite-icon::before{content:\"\";position:absolute;width:24px;height:24px;top:12px;left:12px;background-size:contain;background-repeat:no-repeat;background-position:center}.business-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M3 3v18h18'/%3E%3Cpath d='M18.4 9l-1.2 1.3L13 7.2l-3.2 3.2-3.5-3.6'/%3E%3C/svg%3E\")}.developer-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpolyline points='16 18 22 12 16 6'/%3E%3Cpolyline points='8 6 2 12 8 18'/%3E%3C/svg%3E\")}.invite-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect x='2' y='4' width='20' height='16' rx='2'/%3E%3Cpath d='M22 7l-10 6L2 7'/%3E%3C/svg%3E\")}.sdk-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M21 16V8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73l7 4a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16z'/%3E%3Cpolyline points='3.27 6.96 12 12.01 20.73 6.96'/%3E%3Cline x1='12' y1='22.08' x2='12' y2='12'/%3E%3C/svg%3E\")}.role-card h3{font-size:1.25rem;font-weight:600;margin-bottom:8px}.role-card p{color:var(--gbg-secondary-text);margin:0;line-height:1.5}.resources-container{padding:64px 32px;max-width:1200px;margin:0 auto}.resources-container h2{font-size:1.75rem;text-align:center;margin-bottom:40px;color:var(--gbg-text)}.resources-grid{display:grid;grid-template-columns:repeat(auto-fit, minmax(250px, 1fr));gap:24px}.resource-card{background-color:white;border-radius:8px;padding:24px;text-decoration:none;color:var(--gbg-text);transition:all 0.3s ease;border:1px solid var(--gbg-border)}[data-theme=\"dark\"] .resource-card,.dark .resource-card{background:linear-gradient(\n 145deg,\n rgba(23, 24, 57, 0.9) 0%,\n rgba(15, 16, 35, 0.9) 100%\n );border-color:rgba(77, 77, 255, 0.2);box-shadow:0 8px 32px rgba(0, 0, 0, 0.2), 0 0 0 1px rgba(77, 77, 255, 0.1)}[data-theme=\"dark\"] .resource-card:hover,.dark .resource-card:hover{border-color:var(--gbg-primary);box-shadow:0 8px 32px rgba(77, 77, 255, 0.15),\n 0 0 0 1px rgba(77, 77, 255, 0.4);background:linear-gradient(\n 145deg,\n rgba(30, 31, 72, 0.9) 0%,\n rgba(23, 24, 57, 0.9) 100%\n )}.resource-card:hover{transform:translateY(-5px);box-shadow:0 8px 16px rgba(0, 0, 0, 0.1);border-color:var(--gbg-primary-light)}.resource-icon{width:40px;height:40px;border-radius:8px;margin-bottom:16px;background-color:rgba(77, 77, 255, 0.1);position:relative}.intro-icon::before,.api-icon::before,.glossary-icon::before{content:\"\";position:absolute;width:20px;height:20px;top:10px;left:10px;background-size:contain;background-repeat:no-repeat;background-position:center}.intro-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='12' cy='12' r='10'/%3E%3Cpath d='M12 16v-4'/%3E%3Cpath d='M12 8h.01'/%3E%3C/svg%3E\")}.api-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M20 21v-2a4 4 0 0 0-4-4H8a4 4 0 0 0-4 4v2'/%3E%3Ccircle cx='12' cy='7' r='4'/%3E%3C/svg%3E\")}.glossary-icon::before{background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='%234D4DFF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M4 19.5A2.5 2.5 0 0 1 6.5 17H20'/%3E%3Cpath d='M6.5 2H20v20H6.5A2.5 2.5 0 0 1 4 19.5v-15A2.5 2.5 0 0 1 6.5 2z'/%3E%3C/svg%3E\")}.resource-card h3{font-size:1.1rem;font-weight:600;margin-bottom:8px}.resource-card p{color:var(--gbg-secondary-text);margin:0;font-size:0.95rem;line-height:1.5}@media (max-width: 1024px){.hero-container{flex-direction:column;padding:48px 24px}.hero-content{margin-bottom:32px;max-width:100%}.hero-graphic{display:none}}@media (max-width: 768px){.hero-content h1{font-size:2rem}.cards-row{grid-template-columns:1fr}.roles-grid,.resources-grid{grid-template-columns:1fr}.btn-primary,.btn-secondary{width:100%;text-align:center}.hero-buttons{flex-direction:column}.cards-container{padding-left:0;padding-right:0}}"}],"page":{"pagePath":"docs/go-v2/api-reference/endpoint/fetch-interaction","slug":"/docs/go-v2/api-reference/endpoint/fetch-interaction","pageMetadata":{"openapi":"docs/go-v2/openapi-v2.json POST /journey/interaction/fetch","description":"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.","title":"Fetch current interaction","href":"/docs/go-v2/api-reference/endpoint/fetch-interaction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.\"\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":{"openapi":"docs/go-v2/openapi-v2.json POST /journey/interaction/fetch","description":"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.","title":"Fetch current interaction","href":"/docs/go-v2/api-reference/endpoint/fetch-interaction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/gbg-loqate/293515cd2d489c0c/snippets/provider-table-filter.js","/_mintlify/custom/gbg-loqate/1c8d6feb511774df/snippets/accordion-filter.js","/_mintlify/custom/gbg-loqate/f106a1b53209ff36/snippets/variant-filter.js","/_mintlify/custom/gbg-loqate/0cf71182b52d97af/snippets/equalize-cards.js","/_mintlify/custom/gbg-loqate/10f02796bc1bbc84/docs/tutorials-cards.js","/_mintlify/custom/gbg-loqate/c1327c1678226ee6/snippets/tutorials-cards.js","/_mintlify/custom/gbg-loqate/dfc6f001abd008d9/snippets/onetrust.js","/_mintlify/custom/gbg-loqate/0d29bf22d5381f30/snippets/move-version-toggle.js"],"openApiReferenceData":{"operation":{"tags":["Interaction"],"summary":"Fetch current interaction","description":"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.","security":["276a08b4-d2b2-4cd8-b102-d896fa4a852f","5812ad09-9ab9-45b0-ac6b-f6d528b0f2dd"],"parameters":["c4a0e17d-42f6-4088-bb81-8b3483b56d5f"],"requestBody":"fff21dce-a99b-4833-b530-a81ad71d279a","responses":{"200":"3b688658-c3ac-4772-bf12-e33c300dec90","400":"8eb8812d-f54e-4bfb-b17d-05d46ce365c5","401":"5e6ea8eb-fac7-460a-afc1-657f26cadc6b","403":"53624647-216e-4c58-b6d4-b147aaa252ea","404":"379d2287-4e77-4b29-8544-31efe3d8342e","500":"25c9130f-eccf-459f-a3d4-e438de4a7c4e","503":"ab63747b-4ef4-41cf-869e-eeec0898186e"},"method":"post","type":"path","servers":["32836bf1-c77a-48ab-b719-58578bd1979a","c2f0c553-ef8b-4ef5-a288-fa36d20a1b5f","0e56965b-aba0-4bcf-a3e3-3d3ee0297e66","f2f24910-b485-4701-8f72-da2caa3c5888"],"path":"/journey/interaction/fetch","baseUrlOptions":["https://eu.platform.go.gbgplc.com/v2/captain/","https://us.platform.go.gbgplc.com/v2/captain/","https://au.platform.go.gbgplc.com/v2/captain/","https://api.auth.gbgplc.com/as/token.oauth2"],"title":"Fetch current interaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c4a0e17d-42f6-4088-bb81-8b3483b56d5f":{"schema":{"type":"string","description":"Response profile. Omit or 'full' for the full response (default, unchanged). 'slim' returns the compact, typed customer-facing shape. Any other value returns 400.","example":"slim","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Response profile. Omit or 'full' for the full response (default, unchanged). 'slim' returns the compact, typed customer-facing shape. Any other value returns 400.","name":"view","in":"query"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","minLength":16,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$","description":"Journey Instance Id, a unique identifier for a started journey instance.","isRequired":true,"uniqueKey":"instanceId","typeLabel":"string"},"scope":{"type":"string","enum":["subject","reviewer"],"uniqueKey":"scope","typeLabel":"enum\u003cstring>"}},"required":["instanceId"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"instanceId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3b688658-c3ac-4772-bf12-e33c300dec90":{"description":"Interaction state (full by default; slim with ?view=slim)","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["view","instanceId","journey"],"properties":{"view":{"type":"string","enum":["full"],"isRequired":true,"uniqueKey":"oneOf.0.view","typeLabel":"enum\u003cstring>"},"instanceId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.instanceId","typeLabel":"string"},"journey":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.journey.status","typeLabel":"string"}},"required":["status"],"isRequired":true,"uniqueKey":"oneOf.0.journey","typeLabel":"object"},"interactionId":{"type":"string","uniqueKey":"oneOf.0.interactionId","typeLabel":"string"},"interaction":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.interaction.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.interaction","typeLabel":"object"},"context":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.context.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.context","typeLabel":"object"},"instructions":{"oneOf":[{}],"uniqueKey":"oneOf.0.instructions","typeLabel":"any"},"outstanding":{"oneOf":[{}],"uniqueKey":"oneOf.0.outstanding","typeLabel":"any"},"outstandingGroups":{"type":"array","items":{"type":"object","properties":{"elementId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.outstandingGroups.items.[INDEX].elementId","typeLabel":"string"},"cardinality":{"type":"string","example":"at-least-one","description":"How many of `refs` are needed. Only 'at-least-one' today; more values may be added.","isRequired":true,"uniqueKey":"oneOf.0.outstandingGroups.items.[INDEX].cardinality","typeLabel":"string"},"refs":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.outstandingGroups.items.[INDEX].refs.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.0.outstandingGroups.items.[INDEX].refs","typeLabel":"string[]"}},"required":["elementId","cardinality","refs"],"uniqueKey":"oneOf.0.outstandingGroups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.outstandingGroups","typeLabel":"object[]"},"processing":{"type":"boolean","uniqueKey":"oneOf.0.processing","typeLabel":"boolean"},"result":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.result.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.result","typeLabel":"object"},"joinedDevice":{"type":"object","properties":{"connected":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.joinedDevice.connected","typeLabel":"boolean"}},"required":["connected"],"uniqueKey":"oneOf.0.joinedDevice","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["view","instanceId","journey"],"properties":{"view":{"type":"string","enum":["slim"],"isRequired":true,"uniqueKey":"oneOf.1.view","typeLabel":"enum\u003cstring>"},"instanceId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.instanceId","typeLabel":"string"},"journey":{"type":"object","properties":{"status":{"type":"string","enum":["InProgress","Completed","Failed","Paused"],"isRequired":true,"uniqueKey":"oneOf.1.journey.status","typeLabel":"enum\u003cstring>"}},"required":["status"],"isRequired":true,"uniqueKey":"oneOf.1.journey","typeLabel":"object"},"interactionId":{"type":"string","uniqueKey":"oneOf.1.interactionId","typeLabel":"string"},"interaction":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.interaction.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1.interaction","typeLabel":"object"},"processing":{"type":"boolean","uniqueKey":"oneOf.1.processing","typeLabel":"boolean"},"outstanding":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.outstanding.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.outstanding","typeLabel":"string[]"},"outstandingGroups":{"type":"array","items":{"type":"object","properties":{"elementId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.outstandingGroups.items.[INDEX].elementId","typeLabel":"string"},"cardinality":{"type":"string","example":"at-least-one","description":"How many of `refs` are needed. Only 'at-least-one' today; more values may be added.","isRequired":true,"uniqueKey":"oneOf.1.outstandingGroups.items.[INDEX].cardinality","typeLabel":"string"},"refs":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.outstandingGroups.items.[INDEX].refs.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.1.outstandingGroups.items.[INDEX].refs","typeLabel":"string[]"}},"required":["elementId","cardinality","refs"],"uniqueKey":"oneOf.1.outstandingGroups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.outstandingGroups","typeLabel":"object[]"},"instructions":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.instructions.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.instructions","typeLabel":"string[]"},"result":{"type":"object","properties":{"outcome":{"type":"string","uniqueKey":"oneOf.1.result.outcome","typeLabel":"string"},"status":{"type":"string","enum":["pending","complete","error","timeout"],"description":"Headline result state, and the AUTHORITATIVE signal for whether the journey succeeded. `complete` means the journey finished. A `complete` journey may still list `errors`: a module step failed (e.g. a data source was unavailable) and the journey continued past it, as configured (on a state fetch each failed step is also marked on `steps[]`). `error` means it ended in failure — for example a module reported a terminal error (journeys run without per-step module error handling, which includes every journey on engine 2), a module that could not be found or routed at all, a step whose output broke its declared contract, or the platform abandoning the journey before it could finish (a deadlock, an interaction or execution timeout, or a spin). Abandonment is reported as `error` rather than as a distinct value. `pending` is reported for a running journey once its state has materialized. `timeout` is part of this range but is not currently emitted at journey level — an elapsed deadline surfaces as `error`. When `status` disagrees with `outcome` or `outcomeClassification`, `status` wins: a journey can pass an evaluation and then fail before finishing, leaving a positive classification beside `status: \"error\"`. Both are true — the evaluation did pass — but the journey did not complete, so do not read a positive classification as success. Note also that an `error` caused by abandonment is generally NOT retryable — a deadlocked journey deadlocks again — even though the accompanying error advises a retry; start a new journey instead.","uniqueKey":"oneOf.1.result.status","typeLabel":"enum\u003cstring>"},"outcomeClassification":{"oneOf":[{"type":"string","enum":["positive","negative","neutral",null],"uniqueKey":"oneOf.1.result.outcomeClassification.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["positive","negative","neutral",null],"uniqueKey":"oneOf.1.result.outcomeClassification.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.result.outcomeClassification","typeLabel":"enum\u003cstring> | null"},"errors":{"type":"array","items":{"type":"object","required":["code","name","problem","action"],"properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"oneOf.1.result.errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.result.errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.result.errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.result.errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"oneOf.1.result.errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"cause":{"type":"object","properties":{"code":{"type":"string","description":"The module's own error code, as emitted (e.g. `5012`, `BD10003`). Present only when the module emitted a structured code; look it up in the module or GBG Errors Catalog documentation.","uniqueKey":"oneOf.1.result.errors.items.[INDEX].cause.code","typeLabel":"string"},"correlationId":{"type":"string","description":"The upstream service's trace id for the failed request (e.g. SIP's `gbg-correlation-id`), taken from the same error as `code`.","uniqueKey":"oneOf.1.result.errors.items.[INDEX].cause.correlationId","typeLabel":"string"},"moduleId":{"type":"string","description":"The module the failed step ran. On an interaction fetch, which carries no step history, `cause` has only `moduleId`/`variantId`; the module code and correlation id are on the state fetch.","uniqueKey":"oneOf.1.result.errors.items.[INDEX].cause.moduleId","typeLabel":"string"},"variantId":{"type":"string","description":"The module variant (configuration) the step ran.","uniqueKey":"oneOf.1.result.errors.items.[INDEX].cause.variantId","typeLabel":"string"}},"uniqueKey":"oneOf.1.result.errors.items.[INDEX].cause","typeLabel":"object"}},"uniqueKey":"oneOf.1.result.errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"description":"Customer-safe errors. Failed module steps are listed as they happen, so `errors` can appear while the journey is still `pending`. For an `error`/`timeout` journey the first entry describes the journey failure. One further entry is listed per failed module step (codes 5021 step failed, 5022 step timed out, 5023 step could not be started), on a `complete` journey too, in step order. On a state fetch the failed steps carry the same entry on `steps[].error`.","uniqueKey":"oneOf.1.result.errors","typeLabel":"object[]"},"data":{"type":"object","properties":{"identity":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"oneOf.1.result.data.identity.title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"oneOf.1.result.data.identity.firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.result.data.identity.middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"oneOf.1.result.data.identity.middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.result.data.identity.lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"oneOf.1.result.data.identity.lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.result.data.identity.lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"oneOf.1.result.data.identity.lastNamesAtBirth","typeLabel":"string[]"},"dateOfBirth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601","uniqueKey":"oneOf.1.result.data.identity.dateOfBirth","typeLabel":"string"},"gender":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.result.data.identity.gender","typeLabel":"string"},"currentAddress":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"oneOf.1.result.data.identity.currentAddress.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"oneOf.1.result.data.identity.currentAddress.addressString","typeLabel":"string"},"premise":{"type":"string","description":"The number identifying the property's delivery point on its street — \"128\", \"30A\", \"8-12\". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.premise","typeLabel":"string"},"building":{"type":"string","description":"The name of the building, complex, or named property — \"Landmark House\", \"The Shard\". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.building","typeLabel":"string"},"subBuilding":{"type":"string","description":"The unit within the property, such as a flat, apartment or suite number — \"FLAT 1\", \"SUITE 212\".","uniqueKey":"oneOf.1.result.data.identity.currentAddress.subBuilding","typeLabel":"string"},"thoroughfare":{"type":"string","description":"This field holds the most common street or block data element within a country. For instance, USA Street","uniqueKey":"oneOf.1.result.data.identity.currentAddress.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.dependentThoroughfare","typeLabel":"string"},"locality":{"type":"string","description":"This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality","uniqueKey":"oneOf.1.result.data.identity.currentAddress.locality","typeLabel":"string"},"dependentLocality":{"type":"string","description":"This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.doubleDependentLocality","typeLabel":"string"},"postalCode":{"type":"string","description":"This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US","uniqueKey":"oneOf.1.result.data.identity.currentAddress.postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.postBox","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"oneOf.1.result.data.identity.currentAddress.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.currentAddress.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"oneOf.1.result.data.identity.currentAddress.location.what3words","typeLabel":"string"}},"uniqueKey":"oneOf.1.result.data.identity.currentAddress.location","typeLabel":"object"}},"uniqueKey":"oneOf.1.result.data.identity.currentAddress","typeLabel":"object"},"placeOfBirth":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.addressString","typeLabel":"string"},"premise":{"type":"string","description":"The number identifying the property's delivery point on its street — \"128\", \"30A\", \"8-12\". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.premise","typeLabel":"string"},"building":{"type":"string","description":"The name of the building, complex, or named property — \"Landmark House\", \"The Shard\". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.building","typeLabel":"string"},"subBuilding":{"type":"string","description":"The unit within the property, such as a flat, apartment or suite number — \"FLAT 1\", \"SUITE 212\".","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.subBuilding","typeLabel":"string"},"thoroughfare":{"type":"string","description":"This field holds the most common street or block data element within a country. For instance, USA Street","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.dependentThoroughfare","typeLabel":"string"},"locality":{"type":"string","description":"This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.locality","typeLabel":"string"},"dependentLocality":{"type":"string","description":"This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.doubleDependentLocality","typeLabel":"string"},"postalCode":{"type":"string","description":"This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.postBox","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.location.what3words","typeLabel":"string"}},"uniqueKey":"oneOf.1.result.data.identity.placeOfBirth.location","typeLabel":"object"}},"uniqueKey":"oneOf.1.result.data.identity.placeOfBirth","typeLabel":"object"},"idNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of phone number, such as landline, mobile, fax, unknown etc","isRequired":true,"uniqueKey":"oneOf.1.result.data.identity.idNumbers.items.[INDEX].type","typeLabel":"string"},"idNumber":{"type":"string","minLength":1,"description":"ID number eg, National Insurance Number in UK, Social Securtiy Number in US","isRequired":true,"uniqueKey":"oneOf.1.result.data.identity.idNumbers.items.[INDEX].idNumber","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"oneOf.1.result.data.identity.idNumbers.items.[INDEX].country","typeLabel":"string"}},"required":["type","idNumber"],"uniqueKey":"oneOf.1.result.data.identity.idNumbers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.identity.idNumbers","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.result.data.identity","typeLabel":"object"},"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].type","typeLabel":"string"},"category":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].category","typeLabel":"string"},"subType":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].subType","typeLabel":"string"},"format":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].format","typeLabel":"string"},"number":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].number","typeLabel":"string"},"issueDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].issueDate","typeLabel":"string"},"expiryDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].expiryDate","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].country","typeLabel":"string"},"classification":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.ids","typeLabel":"string[]"},"category":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.category","typeLabel":"string"},"type":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.type","typeLabel":"string"},"subtype":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.subtype","typeLabel":"string"},"isDoubleSided":{"type":"boolean","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.isDoubleSided","typeLabel":"boolean"},"hasNFC":{"type":"boolean","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.hasNFC","typeLabel":"boolean"},"year":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.year","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.countryCode","typeLabel":"string"},"countryName":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.countryName","typeLabel":"string"},"stateCode":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.stateCode","typeLabel":"string"},"stateName":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.stateName","typeLabel":"string"},"sides":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.sides.items.[INDEX].side","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.sides.items.[INDEX].id","typeLabel":"string"},"documentQuality":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.sides.items.[INDEX].documentQuality","typeLabel":"string"},"documentQualityScore":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.sides.items.[INDEX].documentQualityScore","typeLabel":"number"}},"required":["side","id","documentQuality","documentQualityScore"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.sides.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification.sides","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].classification","typeLabel":"object"},"extraction":{"type":"object","properties":{"aggregatedFields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].value","typeLabel":"string"},"source":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].source","typeLabel":"string"},"isNonLatin":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].isNonLatin","typeLabel":"boolean"},"regionOfInterest":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest","typeLabel":"object"}},"required":["label","value","source","isNonLatin"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.aggregatedFields","typeLabel":"object[]"},"extractedFields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].label","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].value","typeLabel":"string"},"source":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].source","typeLabel":"string"},"isNonLatin":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].isNonLatin","typeLabel":"boolean"},"regionOfInterest":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest","typeLabel":"object"}},"required":["label","value","source","isNonLatin"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details","typeLabel":"object[]"}},"required":["label","details"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction.extractedFields","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].extraction","typeLabel":"object"},"validation":{"type":"object","properties":{"validationChecks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].name","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].title","typeLabel":"string"},"validationResult":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].validationResult","typeLabel":"string"},"weight":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].weight","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].type","typeLabel":"string"},"regionOfInterests":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests","typeLabel":"object[]"}},"required":["name","title","validationResult","weight","type"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.validationChecks","typeLabel":"object[]"},"aggregatedValidationChecks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].name","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].title","typeLabel":"string"},"validationResult":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].validationResult","typeLabel":"string"},"weight":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].weight","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].type","typeLabel":"string"},"regionOfInterests":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests","typeLabel":"object[]"}},"required":["name","title","validationResult","weight","type"],"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation.aggregatedValidationChecks","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX].validation","typeLabel":"object"}},"uniqueKey":"oneOf.1.result.data.documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.result.data.documents","typeLabel":"object[]"}},"description":"Verified-output slice (OQ-A). May be transiently ABSENT on a journey already reporting `status: complete`: the certified view materializes just after the completion signal, so a client reading `data` the instant it sees `complete` may need to re-poll once. Absent `data` means \"not yet available\", not \"no verified data\". (Read-after-write closure tracked in GGO-16738.)","uniqueKey":"oneOf.1.result.data","typeLabel":"object"}},"uniqueKey":"oneOf.1.result","typeLabel":"object"},"joinedDevice":{"type":"object","properties":{"connected":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.joinedDevice.connected","typeLabel":"boolean"}},"required":["connected"],"uniqueKey":"oneOf.1.joinedDevice","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"view":"full","instanceId":"\u003cstring>","journey":{"status":"\u003cstring>"},"interactionId":"\u003cstring>","interaction":{},"context":{},"instructions":"\u003cunknown>","outstanding":"\u003cunknown>","outstandingGroups":[{"elementId":"\u003cstring>","cardinality":"at-least-one","refs":["\u003cstring>"]}],"processing":true,"result":{},"joinedDevice":{"connected":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"8eb8812d-f54e-4bfb-b17d-05d46ce365c5":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"}},"required":["code","name","problem","action"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","name":"\u003cstring>","problem":"\u003cstring>","action":"\u003cstring>","location":"Path"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5e6ea8eb-fac7-460a-afc1-657f26cadc6b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"}},"required":["code","name","problem","action"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","name":"\u003cstring>","problem":"\u003cstring>","action":"\u003cstring>","location":"Path"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"53624647-216e-4c58-b6d4-b147aaa252ea":{"description":"Forbidden: the token lacks the permission or scope for this read","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"}},"required":["code","name","problem","action"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","name":"\u003cstring>","problem":"\u003cstring>","action":"\u003cstring>","location":"Path"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"379d2287-4e77-4b29-8544-31efe3d8342e":{"description":"Instance not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"}},"required":["code","name","problem","action"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","name":"\u003cstring>","problem":"\u003cstring>","action":"\u003cstring>","location":"Path"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"25c9130f-eccf-459f-a3d4-e438de4a7c4e":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"}},"required":["code","name","problem","action"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","name":"\u003cstring>","problem":"\u003cstring>","action":"\u003cstring>","location":"Path"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ab63747b-4ef4-41cf-869e-eeec0898186e":{"description":"Service unavailable (retryable)","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{4}$","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].name","typeLabel":"string"},"problem":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].problem","typeLabel":"string"},"action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"errors.items.[INDEX].action","typeLabel":"string"},"location":{"type":"string","enum":["Path","Authorization","Header","Query String","Request","Body","Service","Flow"],"uniqueKey":"errors.items.[INDEX].location","typeLabel":"enum\u003cstring>"}},"required":["code","name","problem","action"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","name":"\u003cstring>","problem":"\u003cstring>","action":"\u003cstring>","location":"Path"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"276a08b4-d2b2-4cd8-b102-d896fa4a852f":{"CustomerAccess":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start","scopes":[],"schemeName":"CustomerAccess"}},"5812ad09-9ab9-45b0-ac6b-f6d528b0f2dd":{"InteractionAccess":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"End-User JWT token for end-user scoped operations. Required for: interaction/fetch, interaction/submit, device/validate","scopes":[],"schemeName":"InteractionAccess"}}},"servers":{"32836bf1-c77a-48ab-b719-58578bd1979a":{"url":"https://eu.platform.go.gbgplc.com/v2/captain/"},"c2f0c553-ef8b-4ef5-a288-fa36d20a1b5f":{"url":"https://us.platform.go.gbgplc.com/v2/captain/"},"0e56965b-aba0-4bcf-a3e3-3d3ee0297e66":{"url":"https://au.platform.go.gbgplc.com/v2/captain/"},"f2f24910-b485-4701-8f72-da2caa3c5888":{"url":"https://api.auth.gbgplc.com/as/token.oauth2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start","scopes":[],"schemeName":"CustomerAccess"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"CustomerAccess","name":"Authorization"}],"title":"CustomerAccess"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"End-User JWT token for end-user scoped operations. Required for: interaction/fetch, interaction/submit, device/validate","scopes":[],"schemeName":"InteractionAccess"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"End-User JWT token for end-user scoped operations. Required for: interaction/fetch, interaction/submit, device/validate","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"InteractionAccess","name":"Authorization"}],"title":"InteractionAccess"}]},"originalFileLocation":"docs/go-v2/openapi-v2.json"},"subdomain":"gbg-loqate","siteName":"GBG Documentation","title":"Fetch current interaction - GBG Documentation","navMaps":{"firstHrefInVersion":{"v1":{"href":"/docs/go-v1/homepage","matchLevel":4},"v2":{"href":"/docs/go-v2/api-reference/endpoint/fetch-interaction","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T14:15:56.882Z","originalFileLocation":"docs/go-v2/api-reference/endpoint/fetch-interaction.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=\"light\"}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=\"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GBG Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_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/gbg-loqate/Usv5rPNC1nZFbzku/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Fetch current interaction - GBG Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GBG Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gbg-loqate.mintlify.site/_mintlify/api/og/v2?division=Interaction+journey+execution\u0026amp;title=Fetch+current+interaction\u0026amp;description=Fetch+the+current+interaction+in+a+GBG+Go+journey+to+determine+which+domain+elements+to+collect+from+the+end+user.\u0026amp;theme=41362d6b25f749ee380918e2\u0026amp;signature=86ef83d63a48aa946a6f09a7051dc5b2a405fd4d967a29ec58bf13141645f768\">\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=\"Fetch current interaction - GBG Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gbg-loqate.mintlify.site/_mintlify/api/og/v2?division=Interaction+journey+execution\u0026amp;title=Fetch+current+interaction\u0026amp;description=Fetch+the+current+interaction+in+a+GBG+Go+journey+to+determine+which+domain+elements+to+collect+from+the+end+user.\u0026amp;theme=41362d6b25f749ee380918e2\u0026amp;signature=86ef83d63a48aa946a6f09a7051dc5b2a405fd4d967a29ec58bf13141645f768\">\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/gbg-loqate/Usv5rPNC1nZFbzku/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GBG Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4D4DFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/go-v2/api-reference/endpoint/fetch-interaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.go.gbgplc.com/#organization\",\"name\":\"GBG Documentation\",\"url\":\"https://docs.go.gbgplc.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gbg-loqate/sjraMdPLPALUqj3-/images/logo/gbg-logo.svg?fit=max\u0026auto=format\u0026n=sjraMdPLPALUqj3-\u0026q=85\u0026s=d0c979ecdf20524de2314bb87e294371\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.go.gbgplc.com#website\",\"name\":\"GBG Documentation\",\"url\":\"https://docs.go.gbgplc.com\",\"publisher\":{\"@id\":\"https://docs.go.gbgplc.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction#webpage\",\"url\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction\",\"name\":\"Fetch current interaction\",\"description\":\"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.\",\"dateModified\":\"2026-08-21T14:15:56.882Z\",\"isPartOf\":{\"@id\":\"https://docs.go.gbgplc.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"GBG Documentation\",\"item\":\"https://docs.go.gbgplc.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Fetch current interaction\",\"item\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction#apireference\",\"headline\":\"Fetch current interaction\",\"name\":\"Fetch current interaction\",\"description\":\"Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.\",\"url\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/fetch-interaction#webpage\"},\"dateModified\":\"2026-08-21T14:15:56.882Z\",\"publisher\":{\"@id\":\"https://docs.go.gbgplc.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.go.gbgplc.com#website\"}}]}\u003c/script>","siteName":"GBG Documentation","nav":{"global":null,"versions":[{"version":"v1","pages":[{"title":"v1","href":"/docs/go-v1/homepage"}]},{"version":"v2","tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs/go-v2/homepage"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Introduction","public":true,"pages":[{"title":"API reference overview","sidebarTitle":"Overview","icon":"code-simple","href":"/docs/go-v2/api-reference/overview"},{"title":"User data input schema","icon":"database","href":"/docs/go-v2/api-reference/schema"},{"title":"Response advice schema","icon":"arrow-turn-down-left","href":"/docs/go-v2/api-reference/response-schema"},{"title":"Response Codes","icon":"binary-slash","href":"/docs/go-v2/api-reference/api-errors"}]},{"group":"Migration","public":true,"pages":[{"title":"V1 to v2 migration guide","icon":"arrow-right-arrow-left","href":"/docs/go-v2/migration/v1-to-v2-migration-guide"}]},{"group":"Journey execution","public":true,"pages":[{"openapi":"docs/go-v2/openapi-v2.json POST /as/token.oauth2","title":"Generate access token","href":"/docs/go-v2/api-reference/endpoint/generate-access-token"},{"openapi":"docs/go-v2/openapi-v2.json POST /journey/start","title":"Start a new journey","href":"/docs/go-v2/api-reference/endpoint/start-journey"},{"openapi":"docs/go-v2/openapi-v2.json POST /journey/task/list","deprecated":true,"title":null,"href":"/docs/go-v2/api-reference/endpoint/retrieve-tasks"},{"title":"List schema","openapi":"docs/go-v2/openapi-v2.json POST /journey/task/list/schema","deprecated":true,"href":"/docs/go-v2/api-reference/endpoint/retrieve-tasks-with-their-schema"},{"title":"List schema task","openapi":"docs/go-v2/openapi-v2.json POST /journey/task/schema","deprecated":true,"href":"/docs/go-v2/api-reference/endpoint/retrieve-task-schema"},{"openapi":"docs/go-v2/openapi-v2.json POST /journey/task/update","deprecated":true,"title":null,"href":"/docs/go-v2/api-reference/endpoint/submit-task-data"},{"openapi":"docs/go-v2/openapi-v2.json POST /journey/state/fetch","version":"2.0","description":"Fetch the current state of a GBG Go journey instance to track progress, outcomes, and completion status.","title":"Fetch journey state","href":"/docs/go-v2/api-reference/endpoint/fetch-journey-state"}]},{"group":"Interaction journey execution","public":true,"pages":[{"openapi":"docs/go-v2/openapi-v2.json POST /journey/interaction/fetch","title":"Fetch current interaction","href":"/docs/go-v2/api-reference/endpoint/fetch-interaction"},{"openapi":"docs/go-v2/openapi-v2.json POST /journey/interaction/submit","description":"Submit collected end-user data for the current interaction to advance a GBG Go journey toward completion.","title":"Submit interaction data","href":"/docs/go-v2/api-reference/endpoint/submit-interaction"}]}]},{"tab":"SDKs","icon":"cube","pages":[{"title":"SDKs","href":"/docs/go-v2/developer-integration/sdks/overview"}]},{"tab":"Release Notes","icon":"tag","pages":[{"title":"Release Notes","href":"/docs/go-v2/release-note/release-note-home"}]}]}]},"basePath":"","title":"Fetch current interaction - GBG Documentation","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D9ithiIZ.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}