Applies a saved test scenario for this journey, selected by name (see /test/journeys/{journeyId}/scenarios). The start response then carries test: true and scenario: <name>. The value inline instead takes the scenario from the request body scenario field.
{"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":"6aedf177b24ea02bf4ec6494","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":"API Reference","count":25},{"language":"default","tag":"Release Notes","count":24},{"language":"default","tag":"Account management","count":22}],"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/start-journey","slug":"/docs/go-v2/api-reference/endpoint/start-journey","pageMetadata":{"openapi":"docs/go-v2/openapi-v2.json POST /journey/start","description":"Start a customer verification journey in GBG Go to create a trackable journey instance for an end user.","title":"Start a new journey","href":"/docs/go-v2/api-reference/endpoint/start-journey"},"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: \"Start a customer verification journey in GBG Go to create a trackable journey instance for an 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/start","description":"Start a customer verification journey in GBG Go to create a trackable journey instance for an end user.","title":"Start a new journey","href":"/docs/go-v2/api-reference/endpoint/start-journey"}}},"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":["Journey"],"summary":"Start a new journey","description":"Start a customer verification journey in GBG Go to create a trackable journey instance for an end user.","security":["722f1437-5835-4d92-9c4a-f4429c5e2181"],"parameters":["408fc04a-a8d0-4023-8423-f504659d81f5"],"requestBody":"8a740e83-90a8-4475-881c-2b198d60c9a4","responses":{"201":"09bfde15-3950-4e7e-b674-b0ed76be6e02","400":"853a788b-57df-4a33-bf32-036737ea05ef","401":"ba1dc00d-24bb-41b3-9ff4-3247ea36aa4d","403":"ed288f16-e24e-460d-9e4e-f7a415c8b315","404":"ce161d80-6771-4cdb-a349-cb5f1c2f64fc","422":"ea453f70-5b77-47d9-8642-7db752333ceb","429":"2c22fd98-ac30-4c18-9fa6-e9451ee853d3","500":"e92b657f-7a92-4f32-88b3-17a953bb1c7e","503":"d7212a34-32b1-4850-905a-6f01184038af"},"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/start","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":"Start a new journey","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"408fc04a-a8d0-4023-8423-f504659d81f5":{"schema":{"type":"string","description":"Applies a saved test scenario for this journey, selected by name (see /test/journeys/{journeyId}/scenarios). The start response then carries `test: true` and `scenario: \u003cname>`. The value `inline` instead takes the scenario from the request body `scenario` field.","example":"my-scenario","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Applies a saved test scenario for this journey, selected by name (see /test/journeys/{journeyId}/scenarios). The start response then carries `test: true` and `scenario: \u003cname>`. The value `inline` instead takes the scenario from the request body `scenario` field.","name":"x-gbg-scenario","in":"header"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9_-]+(@[a-zA-Z0-9_.-]+)?$","isRequired":true,"uniqueKey":"resourceId","typeLabel":"string"},"context":{"type":"object","properties":{"config":{"type":"object","properties":{"delivery":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"context.config.delivery","typeLabel":"string"},"branding":{"oneOf":[{}],"uniqueKey":"context.config.branding","typeLabel":"any"},"assisted":{"type":"boolean","description":"Marks this start as operator-completed (assisted) rather than customer-completed, so the two populations can be told apart in downstream telemetry. Accepted and logged but not yet enforced: supplying it does not change validation, routing, execution or the response, and omitting it leaves the request byte-identical to an ordinary start. It is an attribution signal only, and whether anything ever reads it to change behavior is a separate decision that has not been taken.","uniqueKey":"context.config.assisted","typeLabel":"boolean"},"inlineResult":{"type":"boolean","description":"Opt-in synchronous execution: when true, the start call waits for the journey and returns its outcome inline (completed, failed, awaiting-input or pending) instead of returning immediately with just an instanceId. Requires delivery \"api\" and a durable engine; otherwise the request is rejected with 400 before any journey is created. false is accepted and means the same as omitting it. Same name as Captain V1, but the response shape differs: the journey state is nested under \"state\".","uniqueKey":"context.config.inlineResult","typeLabel":"boolean"},"syncWaitSeconds":{"type":"integer","exclusiveMinimum":0,"description":"How many seconds the caller is willing to wait; requires inlineResult: true. Optional: absent means wait up to the platform ceiling, which is the load balancer's idle timeout minus 10 seconds (50 today). Send a smaller value if your own HTTP client gives up sooner. A value above the ceiling is clamped, not rejected, and the clamp is logged.","uniqueKey":"context.config.syncWaitSeconds","typeLabel":"integer"},"linkConfig":{"type":"object","properties":{"ttlMinutes":{"type":"integer","minimum":1,"description":"Lifetime of the delivery link in minutes: the deadline for STARTING a journey, governing the connect secret and therefore how long an unopened link stays usable. It no longer bounds how long an applicant may come BACK — that is resumeExpiryMinutes, which is anchored at first connect and may outlast this. Replaces the deprecated flat deliveryUrlTtlMinutes. Bounded by the operator ceiling at runtime, not here: a value above the ceiling is clamped down to it. A shorter lifetime is always honored exactly as supplied — there is no lower bound, and nothing lengthens a link beyond what was requested.","uniqueKey":"context.config.linkConfig.ttlMinutes","typeLabel":"integer"},"resumeMode":{"type":"string","enum":["off","resume"],"description":"How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.","uniqueKey":"context.config.linkConfig.resumeMode","typeLabel":"enum\u003cstring>"},"resumeExpiryMinutes":{"type":"integer","minimum":1,"description":"Resume-credential lifetime in minutes, ABSOLUTE from the applicant first connecting — not from link issue, and not sliding from last use. Nothing renews it: returning many times neither extends nor shortens it. Valid only when resumeMode is resume; supplying it alongside off is rejected. Clamped downward only. It may fall AFTER the link expires, which is deliberate — the link bounds starting, this bounds coming back. Because nothing renews it, a small value is a total journey budget rather than an idle timeout, and will cut off an applicant who never stopped working.","uniqueKey":"context.config.linkConfig.resumeExpiryMinutes","typeLabel":"integer"},"reminders":{"type":"object","properties":{"intervalMinutes":{"type":"integer","minimum":1,"description":"Minutes between one send of the invite link and the next reminder.","isRequired":true,"uniqueKey":"context.config.linkConfig.reminders.intervalMinutes","typeLabel":"integer"},"maxReminders":{"type":"integer","minimum":0,"maximum":5,"description":"Reminders sent after the first invite, at most 5. 0 turns reminders off.","isRequired":true,"uniqueKey":"context.config.linkConfig.reminders.maxReminders","typeLabel":"integer"}},"required":["intervalMinutes","maxReminders"],"additionalProperties":false,"description":"Reminders for an invite journey: the invite link is sent again every intervalMinutes, at most maxReminders times, until the journey finishes or the link expires (ttlMinutes), whichever comes first. Resolved as ONE unit, not per member: the first tier that sets it (journey start, then delivery, then organization) wins, and an interval from one tier is never combined with a count from another. Absent everywhere means off. A journey without an invite ignores it. Captain refuses an interval below its operator floor with a 400 naming the tier. Frozen at journey start: editing it later does not reach a running journey.","uniqueKey":"context.config.linkConfig.reminders","typeLabel":"object"}},"additionalProperties":false,"description":"Per-journey link lifetime and resume behavior. Every member is optional, and each is resolved independently across the per-journey, delivery, organization and system-default tiers, then clamped down to the operator bounds. All three members reach runtime behavior: ttlMinutes bounds how long the link stays startable, and the resolved resumeMode and resumeExpiryMinutes are frozen onto the delivery-token and connect-secret records, read at connect, and enforced when a resume credential is minted and exchanged. None of the resolved values is echoed on any response — the journey-start log line is where the resolved mode, its tier and any clamp are reported. An absent ttlMinutes falls back to the delivery resource's linkConfig, then to the organization's value, then to the deprecated flat deliveryUrlTtlMinutes, then to the system default.","uniqueKey":"context.config.linkConfig","typeLabel":"object"},"overlay":{"type":"object","properties":{"version":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[\\w-]+$","description":"The overlay revision to apply for this execution. Supply the version returned when the overlay was saved to have the change take effect on this start rather than after the delivery cache expires. Omit it to run the latest overlay, which is the behavior when this member is absent.","isRequired":true,"uniqueKey":"context.config.overlay.version","typeLabel":"string"}},"required":["version"],"additionalProperties":false,"description":"Selects which revision of this organisation configuration overlay this execution runs against. It participates in the delivery cache key, so naming a version guarantees the start is served a graph built from that exact overlay instead of a cached one. Omitting it is a no-op: the latest overlay applies and the request behaves as it did before this member existed.","uniqueKey":"context.config.overlay","typeLabel":"object"}},"required":["delivery"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"context.config.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"context.config","typeLabel":"object"},"subject":{"type":"object","properties":{"identity":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.identity.title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.identity.firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.identity.middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.identity.lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.identity.lastNamesAtBirth","typeLabel":"string[]"},"aliases":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.identity.aliases.items.[INDEX].title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.identity.aliases.items.[INDEX].firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.aliases.items.[INDEX].middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.identity.aliases.items.[INDEX].middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.aliases.items.[INDEX].lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.identity.aliases.items.[INDEX].lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.aliases.items.[INDEX].lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.identity.aliases.items.[INDEX].lastNamesAtBirth","typeLabel":"string[]"},"fullName":{"type":"string","minLength":1,"description":"The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts","uniqueKey":"context.subject.identity.aliases.items.[INDEX].fullName","typeLabel":"string"}},"uniqueKey":"context.subject.identity.aliases.items.[INDEX]","typeLabel":"object"},"description":"Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted","uniqueKey":"context.subject.identity.aliases","typeLabel":"object[]"},"relatedPersons":{"type":"array","items":{"type":"object","properties":{"relationship":{"type":"string","enum":["mother","father","spouse","maternalGrandFather","maternalGrandMother","paternalGrandFather","paternalGrandMother"],"isRequired":true,"uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].relationship","typeLabel":"enum\u003cstring>"},"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX].lastNamesAtBirth","typeLabel":"string[]"}},"required":["relationship"],"uniqueKey":"context.subject.identity.relatedPersons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.identity.relatedPersons","typeLabel":"object[]"},"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":"context.subject.identity.dateOfBirth","typeLabel":"string"},"gender":{"type":"string","minLength":1,"uniqueKey":"context.subject.identity.gender","typeLabel":"string"},"currentAddress":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.identity.currentAddress.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.identity.currentAddress.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.identity.currentAddress.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.identity.currentAddress.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.identity.currentAddress.location","typeLabel":"object"}},"uniqueKey":"context.subject.identity.currentAddress","typeLabel":"object"},"previousAddresses":{"type":"array","items":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].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":"context.subject.identity.previousAddresses.items.[INDEX].country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX].location","typeLabel":"object"},"fromDate":{"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":"context.subject.identity.previousAddresses.items.[INDEX].fromDate","typeLabel":"string"},"toDate":{"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":"context.subject.identity.previousAddresses.items.[INDEX].toDate","typeLabel":"string"}},"uniqueKey":"context.subject.identity.previousAddresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.identity.previousAddresses","typeLabel":"object[]"},"placeOfBirth":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.identity.placeOfBirth.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.identity.placeOfBirth.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.identity.placeOfBirth.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.identity.placeOfBirth.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.identity.placeOfBirth.location","typeLabel":"object"}},"uniqueKey":"context.subject.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":"context.subject.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":"context.subject.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":"context.subject.identity.idNumbers.items.[INDEX].country","typeLabel":"string"}},"required":["type","idNumber"],"uniqueKey":"context.subject.identity.idNumbers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.identity.idNumbers","typeLabel":"object[]"},"phones":{"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":"context.subject.identity.phones.items.[INDEX].type","typeLabel":"string"},"number":{"type":"string","minLength":1,"description":"Phone number, ideally in international format with +(Country Code)","isRequired":true,"uniqueKey":"context.subject.identity.phones.items.[INDEX].number","typeLabel":"string"}},"required":["type","number"],"uniqueKey":"context.subject.identity.phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.identity.phones","typeLabel":"object[]"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other', 'unknown'. Four map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails, 'unknown' -> UnknownEmail (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work', 'other' or 'unknown' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').","isRequired":true,"uniqueKey":"context.subject.identity.emails.items.[INDEX].type","typeLabel":"string"},"email":{"type":"string","minLength":1,"format":"email","description":"Email address","isRequired":true,"uniqueKey":"context.subject.identity.emails.items.[INDEX].email","typeLabel":"string\u003cemail>"}},"required":["type","email"],"uniqueKey":"context.subject.identity.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.identity.emails","typeLabel":"object[]"},"socials":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc","isRequired":true,"uniqueKey":"context.subject.identity.socials.items.[INDEX].type","typeLabel":"string"},"identity":{"type":"string","minLength":1,"description":"the identity used on this platform","isRequired":true,"uniqueKey":"context.subject.identity.socials.items.[INDEX].identity","typeLabel":"string"}},"required":["type","identity"],"uniqueKey":"context.subject.identity.socials.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.identity.socials","typeLabel":"object[]"},"mothersMaidenName":{"type":"string","minLength":1,"description":"The subject's mother's maiden name, used for identity verification","uniqueKey":"context.subject.identity.mothersMaidenName","typeLabel":"string"},"nationality":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"context.subject.identity.nationality","typeLabel":"string"}},"uniqueKey":"context.subject.identity","typeLabel":"object"},"entities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["primary"],"uniqueKey":"context.subject.entities.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].name","typeLabel":"string"},"aliases":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].aliases.items.[INDEX]","typeLabel":"string"},"uniqueKey":"context.subject.entities.items.[INDEX].aliases","typeLabel":"string[]"},"businessType":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].businessType","typeLabel":"string"},"status":{"type":"string","enum":["active","suspended","dormant","dissolved","struckOff","unknown"],"uniqueKey":"context.subject.entities.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"description":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].description","typeLabel":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].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":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].location","typeLabel":"object"},"purpose":{"type":"string","enum":["registered","mailing","site","agent","headquarters"],"uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX].purpose","typeLabel":"enum\u003cstring>"}},"uniqueKey":"context.subject.entities.items.[INDEX].addresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities.items.[INDEX].addresses","typeLabel":"object[]"},"taxIdentifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["TIN","EIN"],"isRequired":true,"uniqueKey":"context.subject.entities.items.[INDEX].taxIdentifiers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"context.subject.entities.items.[INDEX].taxIdentifiers.items.[INDEX].value","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":"context.subject.entities.items.[INDEX].taxIdentifiers.items.[INDEX].country","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"context.subject.entities.items.[INDEX].taxIdentifiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities.items.[INDEX].taxIdentifiers","typeLabel":"object[]"},"companyNumber":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].companyNumber","typeLabel":"string"},"industryClassifications":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","enum":["naics2017","naics2022","sic","mcc"],"isRequired":true,"uniqueKey":"context.subject.entities.items.[INDEX].industryClassifications.items.[INDEX].system","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"context.subject.entities.items.[INDEX].industryClassifications.items.[INDEX].code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].industryClassifications.items.[INDEX].description","typeLabel":"string"}},"required":["system","code"],"uniqueKey":"context.subject.entities.items.[INDEX].industryClassifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities.items.[INDEX].industryClassifications","typeLabel":"object[]"},"registrations":{"type":"array","items":{"type":"object","properties":{"jurisdiction":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].jurisdiction","typeLabel":"string"},"registrationType":{"type":"string","enum":["domestic","foreign","unknown"],"uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registrationType","typeLabel":"enum\u003cstring>"},"fileNumber":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].fileNumber","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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].issueDate","typeLabel":"string"},"registeredAddress":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress.location","typeLabel":"object"}},"uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].registeredAddress","typeLabel":"object"},"agentName":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentName","typeLabel":"string"},"agentAddress":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.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":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress.location","typeLabel":"object"}},"uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX].agentAddress","typeLabel":"object"}},"uniqueKey":"context.subject.entities.items.[INDEX].registrations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities.items.[INDEX].registrations","typeLabel":"object[]"},"corporateStructure":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].corporateStructure","typeLabel":"string"},"persons":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].lastNamesAtBirth","typeLabel":"string[]"},"id":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["primary"],"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"role":{"type":"string","enum":["ultimateBeneficialOwner","director","officer","secretary","shareholder","partner"],"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"position":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].position","typeLabel":"string"},"ownershipPercentage":{"type":"number","minimum":0,"maximum":100,"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].ownershipPercentage","typeLabel":"number"},"nationality":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].nationality","typeLabel":"string"},"dateOfBirth":{"oneOf":[{"type":"string","description":"Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].dateOfBirth.oneOf.0","typeLabel":"string"},{"type":"string","description":"Year and month in ISO 8601 format: YYYY-MM","pattern":"^\\d{4}-\\d{2}$","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].dateOfBirth.oneOf.1","typeLabel":"string"}],"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].dateOfBirth","typeLabel":"string"},"startDate":{"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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].endDate","typeLabel":"string"},"currentAddress":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].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":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress.location","typeLabel":"object"}},"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX].currentAddress","typeLabel":"object"}},"uniqueKey":"context.subject.entities.items.[INDEX].persons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities.items.[INDEX].persons","typeLabel":"object[]"},"incorporationDate":{"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":"context.subject.entities.items.[INDEX].incorporationDate","typeLabel":"string"},"dissolutionDate":{"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":"context.subject.entities.items.[INDEX].dissolutionDate","typeLabel":"string"},"phones":{"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":"context.subject.entities.items.[INDEX].phones.items.[INDEX].type","typeLabel":"string"},"number":{"type":"string","minLength":1,"description":"Phone number, ideally in international format with +(Country Code)","isRequired":true,"uniqueKey":"context.subject.entities.items.[INDEX].phones.items.[INDEX].number","typeLabel":"string"}},"required":["type","number"],"uniqueKey":"context.subject.entities.items.[INDEX].phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities.items.[INDEX].phones","typeLabel":"object[]"},"websites":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"context.subject.entities.items.[INDEX].websites.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"context.subject.entities.items.[INDEX].websites","typeLabel":"string\u003curi>[]"},"headcount":{"type":"integer","minimum":0,"uniqueKey":"context.subject.entities.items.[INDEX].headcount","typeLabel":"integer"},"isNonProfit":{"type":"boolean","uniqueKey":"context.subject.entities.items.[INDEX].isNonProfit","typeLabel":"boolean"}},"uniqueKey":"context.subject.entities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.entities","typeLabel":"object[]"},"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].type","typeLabel":"string"},"oneDBarcode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].oneDBarcode","typeLabel":"string"},"address":{"type":"object","properties":{"addressString":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.addressString","typeLabel":"string"},"extractedAddressString":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.extractedAddressString","typeLabel":"string"},"addressLine1":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.addressLine2","typeLabel":"string"},"locality":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.locality","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.administrativeArea","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].address.postalCode","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].address","typeLabel":"object"},"applicationDate":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].applicationDate","typeLabel":"string"},"applicationNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].applicationNumber","typeLabel":"string"},"dateOfBirth":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].dateOfBirth","typeLabel":"string"},"placeOfBirth":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].placeOfBirth","typeLabel":"string"},"placeOfBirthNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].placeOfBirthNative","typeLabel":"string"},"bloodType":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].bloodType","typeLabel":"string"},"controlNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].controlNumber","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].countryCode","typeLabel":"string"},"countryName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].countryName","typeLabel":"string"},"documentClassCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].documentClassCode","typeLabel":"string"},"documentClassName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].documentClassName","typeLabel":"string"},"documentNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].documentNumber","typeLabel":"string"},"documentSignerCertificate":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].documentSignerCertificate","typeLabel":"string"},"employer":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].employer","typeLabel":"string"},"employerAddress":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].employerAddress","typeLabel":"string"},"entries":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].entries","typeLabel":"string"},"expirationDate":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].expirationDate","typeLabel":"string"},"eyeColor":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].eyeColor","typeLabel":"string"},"fathersName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].fathersName","typeLabel":"string"},"fathersNameNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].fathersNameNative","typeLabel":"string"},"fathersSurname":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].fathersSurname","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].firstName","typeLabel":"string"},"fullName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].fullName","typeLabel":"string"},"fullNameNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].fullNameNative","typeLabel":"string"},"givenName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].givenName","typeLabel":"string"},"givenNameNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].givenNameNative","typeLabel":"string"},"hairColor":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].hairColor","typeLabel":"string"},"height":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].height","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":"context.subject.documents.items.[INDEX].issueDate","typeLabel":"string"},"issuingAuthority":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].issuingAuthority","typeLabel":"string"},"issuingAuthorityNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].issuingAuthorityNative","typeLabel":"string"},"issuingStateCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].issuingStateCode","typeLabel":"string"},"issuingStateName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].issuingStateName","typeLabel":"string"},"licenseClass":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].licenseClass","typeLabel":"string"},"licenseEndorsements":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].licenseEndorsements","typeLabel":"string"},"licenseRestrictions":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].licenseRestrictions","typeLabel":"string"},"mrz":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].mrz","typeLabel":"string"},"mrz1":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].mrz1","typeLabel":"string"},"mrz2":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].mrz2","typeLabel":"string"},"mrz3":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].mrz3","typeLabel":"string"},"middleName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].middleName","typeLabel":"string"},"mothersName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].mothersName","typeLabel":"string"},"mothersNameNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].mothersNameNative","typeLabel":"string"},"mothersSurname":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].mothersSurname","typeLabel":"string"},"nameSuffix":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nameSuffix","typeLabel":"string"},"nationalityCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nationalityCode","typeLabel":"string"},"nationalityName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nationalityName","typeLabel":"string"},"nationalityNameNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nationalityNameNative","typeLabel":"string"},"occupation":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].occupation","typeLabel":"string"},"organDonor":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].organDonor","typeLabel":"boolean"},"passportNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].passportNumber","typeLabel":"string"},"permitNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].permitNumber","typeLabel":"string"},"personalNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].personalNumber","typeLabel":"string"},"photo":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].photo","typeLabel":"string"},"photoCompressed":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].photoCompressed","typeLabel":"string"},"photoEncoding":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].photoEncoding","typeLabel":"string"},"sex":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].sex","typeLabel":"string"},"sexNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].sexNative","typeLabel":"string"},"signature":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].signature","typeLabel":"string"},"signatureCompressed":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].signatureCompressed","typeLabel":"string"},"signatureEncoding":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].signatureEncoding","typeLabel":"string"},"socialSecurityNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].socialSecurityNumber","typeLabel":"string"},"startDate":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].startDate","typeLabel":"string"},"surname":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].surname","typeLabel":"string"},"surnameNative":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].surnameNative","typeLabel":"string"},"visaClass":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].visaClass","typeLabel":"string"},"visaNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].visaNumber","typeLabel":"string"},"weight":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].weight","typeLabel":"string"},"cardNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].cardNumber","typeLabel":"string"},"issuerCountryCode":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"context.subject.documents.items.[INDEX].issuerCountryCode","typeLabel":"string"},"id":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].id","typeLabel":"string"},"category":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].category","typeLabel":"string"},"subtype":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subtype","typeLabel":"string"},"format":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].format","typeLabel":"string"},"device":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].device.type","typeLabel":"string"},"model":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].device.model","typeLabel":"string"},"hasContactlessReader":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].device.hasContactlessReader","typeLabel":"boolean"},"hasMagneticStripeReader":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].device.hasMagneticStripeReader","typeLabel":"boolean"},"hasCamera":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].device.hasCamera","typeLabel":"boolean"},"serialNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].device.serialNumber","typeLabel":"string"},"manufacturer":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].device.manufacturer","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].device","typeLabel":"object"},"side1Image":{"type":"string","minLength":1,"contentMediaType":"image/*","uniqueKey":"context.subject.documents.items.[INDEX].side1Image","typeLabel":"file"},"side2Image":{"type":"string","minLength":1,"contentMediaType":"image/*","uniqueKey":"context.subject.documents.items.[INDEX].side2Image","typeLabel":"file"},"side1Device":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.type","typeLabel":"string"},"model":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.model","typeLabel":"string"},"hasContactlessReader":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.hasContactlessReader","typeLabel":"boolean"},"hasMagneticStripeReader":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.hasMagneticStripeReader","typeLabel":"boolean"},"hasCamera":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.hasCamera","typeLabel":"boolean"},"serialNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.serialNumber","typeLabel":"string"},"manufacturer":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side1Device.manufacturer","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].side1Device","typeLabel":"object"},"side2Device":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.type","typeLabel":"string"},"model":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.model","typeLabel":"string"},"hasContactlessReader":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.hasContactlessReader","typeLabel":"boolean"},"hasMagneticStripeReader":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.hasMagneticStripeReader","typeLabel":"boolean"},"hasCamera":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.hasCamera","typeLabel":"boolean"},"serialNumber":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.serialNumber","typeLabel":"string"},"manufacturer":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].side2Device.manufacturer","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].side2Device","typeLabel":"object"},"chip":{"type":"object","properties":{"lds":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["COM","SOD","DG1","DG2","DG3","DG4","DG5","DG6","DG7","DG8","DG9","DG10","DG11","DG12","DG13","DG14","DG15"],"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].chip.lds.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"data":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].chip.lds.items.[INDEX].data","typeLabel":"string"}},"required":["name","data"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"context.subject.documents.items.[INDEX].chip.lds.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"context.subject.documents.items.[INDEX].chip.lds.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].chip.lds","typeLabel":"object[]"},"auth":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ActiveAuthentication","BasicAccessControl","ChipAuthentication","PassiveAuthentication","SupplementalAccessControl","ExtendedAccessControl","TerminalAuthentication"],"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].chip.auth.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"result":{"type":"string","enum":["Success","Failure","Skipped"],"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].chip.auth.items.[INDEX].result","typeLabel":"enum\u003cstring>"}},"required":["type","result"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"context.subject.documents.items.[INDEX].chip.auth.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"context.subject.documents.items.[INDEX].chip.auth.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].chip.auth","typeLabel":"object[]"}},"required":["lds","auth"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"context.subject.documents.items.[INDEX].chip.additionalProperties","typeLabel":"any"},"uniqueKey":"context.subject.documents.items.[INDEX].chip","typeLabel":"object"},"classification":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"context.subject.documents.items.[INDEX].classification.ids","typeLabel":"string[]"},"category":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.category","typeLabel":"string"},"type":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.type","typeLabel":"string"},"subtype":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.subtype","typeLabel":"string"},"isDoubleSided":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].classification.isDoubleSided","typeLabel":"boolean"},"hasNFC":{"type":"boolean","uniqueKey":"context.subject.documents.items.[INDEX].classification.hasNFC","typeLabel":"boolean"},"year":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.year","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.countryCode","typeLabel":"string"},"countryName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.countryName","typeLabel":"string"},"stateCode":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.stateCode","typeLabel":"string"},"stateName":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].classification.stateName","typeLabel":"string"},"sides":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].classification.sides.items.[INDEX].side","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].classification.sides.items.[INDEX].id","typeLabel":"string"},"documentQuality":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].classification.sides.items.[INDEX].documentQuality","typeLabel":"string"},"documentQualityScore":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].classification.sides.items.[INDEX].documentQualityScore","typeLabel":"number"}},"required":["side","id","documentQuality","documentQualityScore"],"uniqueKey":"context.subject.documents.items.[INDEX].classification.sides.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].classification.sides","typeLabel":"object[]"}},"uniqueKey":"context.subject.documents.items.[INDEX].classification","typeLabel":"object"},"extraction":{"type":"object","properties":{"aggregatedFields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].value","typeLabel":"string"},"source":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].source","typeLabel":"string"},"isNonLatin":{"type":"boolean","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].isNonLatin","typeLabel":"boolean"},"regionOfInterest":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest.imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX].regionOfInterest","typeLabel":"object"}},"required":["label","value","source","isNonLatin"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].extraction.aggregatedFields","typeLabel":"object[]"},"extractedFields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].label","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].value","typeLabel":"string"},"source":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].source","typeLabel":"string"},"isNonLatin":{"type":"boolean","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].isNonLatin","typeLabel":"boolean"},"regionOfInterest":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest.imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX].regionOfInterest","typeLabel":"object"}},"required":["label","value","source","isNonLatin"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX].details","typeLabel":"object[]"}},"required":["label","details"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedFields","typeLabel":"object[]"},"extractedImages":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedImages.items.[INDEX].label","typeLabel":"string"},"side":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedImages.items.[INDEX].side","typeLabel":"string"},"imageID":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedImages.items.[INDEX].imageID","typeLabel":"string"}},"required":["label","side","imageID"],"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedImages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].extraction.extractedImages","typeLabel":"object[]"}},"uniqueKey":"context.subject.documents.items.[INDEX].extraction","typeLabel":"object"},"validation":{"type":"object","properties":{"validationChecks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].name","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].title","typeLabel":"string"},"info":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].info","typeLabel":"string"},"validationResult":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].validationResult","typeLabel":"string"},"resultInfo":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].resultInfo","typeLabel":"string"},"weight":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].weight","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].type","typeLabel":"string"},"regionOfInterests":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX].imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX].regionOfInterests","typeLabel":"object[]"}},"required":["name","title","info","validationResult","resultInfo","weight","type"],"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].validation.validationChecks","typeLabel":"object[]"},"aggregatedValidationChecks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].name","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].title","typeLabel":"string"},"info":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].info","typeLabel":"string"},"validationResult":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].validationResult","typeLabel":"string"},"resultInfo":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].resultInfo","typeLabel":"string"},"weight":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].weight","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].type","typeLabel":"string"},"regionOfInterests":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].side","typeLabel":"string"},"boundingBox":{"type":"object","properties":{"x":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.y","typeLabel":"number"},"width":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.width","typeLabel":"number"},"height":{"type":"number","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox.height","typeLabel":"number"}},"required":["x","y","width","height"],"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].boundingBox","typeLabel":"object"},"spectrum":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].spectrum","typeLabel":"string"},"imageId":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX].imageId","typeLabel":"string"}},"required":["side"],"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX].regionOfInterests","typeLabel":"object[]"}},"required":["name","title","info","validationResult","resultInfo","weight","type"],"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].validation.aggregatedValidationChecks","typeLabel":"object[]"}},"uniqueKey":"context.subject.documents.items.[INDEX].validation","typeLabel":"object"},"subType":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subType","typeLabel":"string"},"number":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].number","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":"context.subject.documents.items.[INDEX].expiryDate","typeLabel":"string"},"cardType":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].cardType","typeLabel":"string"},"expiryMonth":{"type":"string","pattern":"^\\d{4}-\\d{2}$","description":"Year and month in ISO 8601 format: YYYY-MM","uniqueKey":"context.subject.documents.items.[INDEX].expiryMonth","typeLabel":"string"},"cardColour":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].cardColour","typeLabel":"string"},"cardStatus":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].cardStatus","typeLabel":"string"},"subject":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.documents.items.[INDEX].subject.title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.documents.items.[INDEX].subject.firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.documents.items.[INDEX].subject.middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.documents.items.[INDEX].subject.lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.documents.items.[INDEX].subject.lastNamesAtBirth","typeLabel":"string[]"},"aliases":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].lastNamesAtBirth","typeLabel":"string[]"},"fullName":{"type":"string","minLength":1,"description":"The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX].fullName","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases.items.[INDEX]","typeLabel":"object"},"description":"Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted","uniqueKey":"context.subject.documents.items.[INDEX].subject.aliases","typeLabel":"object[]"},"relatedPersons":{"type":"array","items":{"type":"object","properties":{"relationship":{"type":"string","enum":["mother","father","spouse","maternalGrandFather","maternalGrandMother","paternalGrandFather","paternalGrandMother"],"isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].relationship","typeLabel":"enum\u003cstring>"},"title":{"type":"string","minLength":1,"description":"Title of an individual such as Mr, Mrs, Dr, Sir","uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].title","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"description":"A person's name used by their collegues and friends to address them","uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].firstName","typeLabel":"string"},"middleNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].middleNames.items.[INDEX]","typeLabel":"string"},"description":"Any other registered names used by the individual, not aliases","uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].middleNames","typeLabel":"string[]"},"lastNames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].lastNames.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].lastNames","typeLabel":"string[]"},"lastNamesAtBirth":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].lastNamesAtBirth.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Any family names for the individual","uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX].lastNamesAtBirth","typeLabel":"string[]"}},"required":["relationship"],"uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].subject.relatedPersons","typeLabel":"object[]"},"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":"context.subject.documents.items.[INDEX].subject.dateOfBirth","typeLabel":"string"},"gender":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].subject.gender","typeLabel":"string"},"currentAddress":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.currentAddress.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.currentAddress.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress.location","typeLabel":"object"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.currentAddress","typeLabel":"object"},"previousAddresses":{"type":"array","items":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].dependentLocality","typeLabel":"string"},"doubleDependentLocality":{"type":"string","description":"This is an even smaller area within a dependent locality, often used in very detailed addresses.","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].postalCode","typeLabel":"string"},"postBox":{"type":"string","description":"This field contains the post box number associated with a particular delivery point, should one exist.","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].location","typeLabel":"object"},"fromDate":{"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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].fromDate","typeLabel":"string"},"toDate":{"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":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX].toDate","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].subject.previousAddresses","typeLabel":"object[]"},"placeOfBirth":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.lines.items.[INDEX]","typeLabel":"string"},"description":"Unformatted line based address","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.lines","typeLabel":"string[]"},"addressString":{"type":"string","description":"The address as a single line","uniqueKey":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.placeOfBirth.thoroughfare","typeLabel":"string"},"dependentThoroughfare":{"type":"string","description":"The name of a dependent street or block, such as a street within a complex.","uniqueKey":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.placeOfBirth.country","typeLabel":"string"},"superAdministrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.superAdministrativeArea","typeLabel":"string"},"administrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.administrativeArea","typeLabel":"string"},"subAdministrativeArea":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.subAdministrativeArea","typeLabel":"string"},"organization":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.organization","typeLabel":"string"},"location":{"type":"object","properties":{"latitude":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.location.latitude","typeLabel":"string"},"longitude":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.location.longitude","typeLabel":"string"},"geoAccuracy":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.location.geoAccuracy","typeLabel":"string"},"what3words":{"type":"string","description":"A What3words designation associated with this location with '.' separator.","uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.location.what3words","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.placeOfBirth.location","typeLabel":"object"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.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":"context.subject.documents.items.[INDEX].subject.idNumbers.items.[INDEX].country","typeLabel":"string"}},"required":["type","idNumber"],"uniqueKey":"context.subject.documents.items.[INDEX].subject.idNumbers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].subject.idNumbers","typeLabel":"object[]"},"phones":{"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":"context.subject.documents.items.[INDEX].subject.phones.items.[INDEX].type","typeLabel":"string"},"number":{"type":"string","minLength":1,"description":"Phone number, ideally in international format with +(Country Code)","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].subject.phones.items.[INDEX].number","typeLabel":"string"}},"required":["type","number"],"uniqueKey":"context.subject.documents.items.[INDEX].subject.phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].subject.phones","typeLabel":"object[]"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other', 'unknown'. Four map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails, 'unknown' -> UnknownEmail (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work', 'other' or 'unknown' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].subject.emails.items.[INDEX].type","typeLabel":"string"},"email":{"type":"string","minLength":1,"format":"email","description":"Email address","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].subject.emails.items.[INDEX].email","typeLabel":"string\u003cemail>"}},"required":["type","email"],"uniqueKey":"context.subject.documents.items.[INDEX].subject.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].subject.emails","typeLabel":"object[]"},"socials":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].subject.socials.items.[INDEX].type","typeLabel":"string"},"identity":{"type":"string","minLength":1,"description":"the identity used on this platform","isRequired":true,"uniqueKey":"context.subject.documents.items.[INDEX].subject.socials.items.[INDEX].identity","typeLabel":"string"}},"required":["type","identity"],"uniqueKey":"context.subject.documents.items.[INDEX].subject.socials.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.documents.items.[INDEX].subject.socials","typeLabel":"object[]"},"mothersMaidenName":{"type":"string","minLength":1,"description":"The subject's mother's maiden name, used for identity verification","uniqueKey":"context.subject.documents.items.[INDEX].subject.mothersMaidenName","typeLabel":"string"},"nationality":{"type":"string","pattern":"^[A-Z]{2,3}$","description":"Country the address is in. It must be a valid ISO2 or ISO3 country code","uniqueKey":"context.subject.documents.items.[INDEX].subject.nationality","typeLabel":"string"}},"uniqueKey":"context.subject.documents.items.[INDEX].subject","typeLabel":"object"},"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":"context.subject.documents.items.[INDEX].country","typeLabel":"string"},"certificateFormat":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].certificateFormat","typeLabel":"string"},"registrationNumber":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].registrationNumber","typeLabel":"string"},"registrationDate":{"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":"context.subject.documents.items.[INDEX].registrationDate","typeLabel":"string"},"registrationYear":{"type":"string","pattern":"^\\d{4}$","description":"Four-digit calendar year in ISO 8601 format: YYYY","uniqueKey":"context.subject.documents.items.[INDEX].registrationYear","typeLabel":"string"},"partyRole":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].partyRole","typeLabel":"string"},"dateOfEvent":{"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":"context.subject.documents.items.[INDEX].dateOfEvent","typeLabel":"string"},"acquisitionDate":{"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":"context.subject.documents.items.[INDEX].acquisitionDate","typeLabel":"string"},"previousFirstName":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].previousFirstName","typeLabel":"string"},"previousMiddleName":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].previousMiddleName","typeLabel":"string"},"previousSurname":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].previousSurname","typeLabel":"string"},"individualReferenceNumber":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].individualReferenceNumber","typeLabel":"string"},"nameLine1":{"type":"string","minLength":1,"uniqueKey":"context.subject.documents.items.[INDEX].nameLine1","typeLabel":"string"},"nameLine2":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nameLine2","typeLabel":"string"},"nameLine3":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nameLine3","typeLabel":"string"},"nameLine4":{"type":"string","uniqueKey":"context.subject.documents.items.[INDEX].nameLine4","typeLabel":"string"}},"required":["type"],"uniqueKey":"context.subject.documents.items.[INDEX]","typeLabel":"object"},"maxItems":50,"uniqueKey":"context.subject.documents","typeLabel":"object[]"},"biometrics":{"type":"array","items":{"oneOf":[{"type":"object","required":["face1Image","face2Image"],"properties":{"face1Image":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.0.face1Image","typeLabel":"file"},"face2Image":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.0.face2Image","typeLabel":"file"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.0.type","typeLabel":"string"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["selfieImage","anchorImage"],"properties":{"selfieImage":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.1.selfieImage","typeLabel":"file"},"anchorImage":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.1.anchorImage","typeLabel":"file"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.1.type","typeLabel":"string"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["faceImage"],"properties":{"faceImage":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.2.faceImage","typeLabel":"file"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.2.id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.2.type","typeLabel":"string"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["selfieImage"],"properties":{"selfieImage":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.3.selfieImage","typeLabel":"file"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.3.id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.3.type","typeLabel":"string"},"selfieImageEncryption":{"type":"boolean","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.3.selfieImageEncryption","typeLabel":"boolean"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["anchorImage"],"properties":{"anchorImage":{"type":"string","minLength":1,"contentMediaType":"image/*","isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.4.anchorImage","typeLabel":"file"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.4.id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.4.type","typeLabel":"string"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["type","templateReference"],"properties":{"type":{"type":"string","enum":["storedFace"],"isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"templateReference":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.5.templateReference","typeLabel":"string"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.5.id","typeLabel":"string"},"collectionReference":{"type":"string","minLength":1,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.5.collectionReference","typeLabel":"string"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["type","templateReference"],"properties":{"type":{"type":"string","enum":["orphanedStoredFace"],"isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"templateReference":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.6.templateReference","typeLabel":"string"},"id":{"type":"string","uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.6.id","typeLabel":"string"},"collectionReference":{"type":"string","minLength":1,"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.6.collectionReference","typeLabel":"string"}},"uniqueKey":"context.subject.biometrics.items.[INDEX].oneOf.6","typeLabel":"object"}],"uniqueKey":"context.subject.biometrics.items.[INDEX]","typeLabel":"object"},"maxItems":50,"uniqueKey":"context.subject.biometrics","typeLabel":"object[]"},"sessions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","minLength":1,"uniqueKey":"context.subject.sessions.items.[INDEX].type","typeLabel":"string"},"provider":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].provider","typeLabel":"string"},"user":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].user.id","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"context.subject.sessions.items.[INDEX].user.email","typeLabel":"string\u003cemail>"},"domain":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].user.domain","typeLabel":"string"}},"required":["id"],"uniqueKey":"context.subject.sessions.items.[INDEX].user","typeLabel":"object"},"client":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].client.id","typeLabel":"string"},"ip":{"oneOf":[{"type":"string","format":"ip","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].client.ip.oneOf.0","typeLabel":"string\u003cip>"},{"type":"string","format":"ip","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].client.ip.oneOf.1","typeLabel":"string\u003cip>"}],"isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].client.ip","typeLabel":"string\u003cip>"},"address":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].client.address","typeLabel":"string"}},"required":["id","ip","address"],"uniqueKey":"context.subject.sessions.items.[INDEX].client","typeLabel":"object"},"device":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].device.id","typeLabel":"string"},"manufacturer":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].device.manufacturer","typeLabel":"string"},"model":{"type":"object","properties":{"identifier":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].device.model.identifier","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].device.model.name","typeLabel":"string"}},"required":["identifier","name"],"isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].device.model","typeLabel":"object"}},"required":["id","manufacturer","model"],"uniqueKey":"context.subject.sessions.items.[INDEX].device","typeLabel":"object"},"trace":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].trace.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"context.subject.sessions.items.[INDEX].trace","typeLabel":"object"},"span":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].span.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"context.subject.sessions.items.[INDEX].span","typeLabel":"object"},"transaction":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].transaction.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"context.subject.sessions.items.[INDEX].transaction","typeLabel":"object"},"auth":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].id","typeLabel":"string"},"scope":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].scope","typeLabel":"string"},"codeVerifier":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].codeVerifier","typeLabel":"string"},"code":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].code","typeLabel":"string"},"state":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].state","typeLabel":"string"},"redirectUri":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].redirectUri","typeLabel":"string"},"responseType":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].responseType","typeLabel":"string"},"clientId":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].clientId","typeLabel":"string"},"clientSecret":{"type":"string","uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX].clientSecret","typeLabel":"string"}},"required":["id"],"uniqueKey":"context.subject.sessions.items.[INDEX].auth.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.sessions.items.[INDEX].auth","typeLabel":"object[]"}},"uniqueKey":"context.subject.sessions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.sessions","typeLabel":"object[]"},"consent":{"type":"array","items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"context.subject.consent.items.[INDEX].url","typeLabel":"string\u003curi>"},"type":{"type":"string","enum":["rollup","explicit","implicit"],"uniqueKey":"context.subject.consent.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].id","typeLabel":"string"},"version":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].version","typeLabel":"string"},"effectiveDate":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].effectiveDate","typeLabel":"string"},"expiryDate":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].expiryDate","typeLabel":"string"},"terms":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].terms","typeLabel":"string"},"purpose":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].purpose","typeLabel":"string"},"legalBasis":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].legalBasis","typeLabel":"string"},"jurisdiction":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].jurisdiction","typeLabel":"string"},"subject":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].subject","typeLabel":"string"},"signatory":{"type":"string","uniqueKey":"context.subject.consent.items.[INDEX].signatory","typeLabel":"string"}},"uniqueKey":"context.subject.consent.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.consent","typeLabel":"object[]"},"accounts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of account (canonical camelCase, e.g. \"bankAccount\"). Legacy value \"Bank Account\" is still read but new writes emit the canonical form.","isRequired":true,"uniqueKey":"context.subject.accounts.items.[INDEX].type","typeLabel":"string"},"accountNumber":{"type":"string","minLength":1,"description":"Account number in its domestic form. Optional on its own: an account must carry at least one account identifier — `accountNumber` or `iban` — and either alone is enough. Independent of `iban`; when both are supplied they are not cross-checked.","uniqueKey":"context.subject.accounts.items.[INDEX].accountNumber","typeLabel":"string"},"sortCode":{"type":"string","description":"UK sort code","uniqueKey":"context.subject.accounts.items.[INDEX].sortCode","typeLabel":"string"},"routingNumber":{"type":"string","description":"US ABA routing number","uniqueKey":"context.subject.accounts.items.[INDEX].routingNumber","typeLabel":"string"},"iban":{"type":"string","description":"International Bank Account Number, stored exactly as supplied — not format-checked (no ISO 13616 mod-97) at this boundary. Optional on its own: an account must carry at least one account identifier — `accountNumber` or `iban` — and either alone is enough.","uniqueKey":"context.subject.accounts.items.[INDEX].iban","typeLabel":"string"},"bic":{"type":"string","description":"BIC/SWIFT code","uniqueKey":"context.subject.accounts.items.[INDEX].bic","typeLabel":"string"},"accountHolderName":{"type":"string","description":"Name on the account","uniqueKey":"context.subject.accounts.items.[INDEX].accountHolderName","typeLabel":"string"},"bankName":{"type":"string","description":"Name of the financial institution","uniqueKey":"context.subject.accounts.items.[INDEX].bankName","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":"context.subject.accounts.items.[INDEX].country","typeLabel":"string"},"accountType":{"type":"string","description":"Account classification, e.g. current, savings","uniqueKey":"context.subject.accounts.items.[INDEX].accountType","typeLabel":"string"}},"required":["type"],"uniqueKey":"context.subject.accounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.subject.accounts","typeLabel":"object[]"},"kba":{"type":"object","properties":{"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"context.subject.kba.questions.items.[INDEX].id","typeLabel":"integer"},"questionText":{"type":"string","isRequired":true,"uniqueKey":"context.subject.kba.questions.items.[INDEX].questionText","typeLabel":"string"},"choices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"context.subject.kba.questions.items.[INDEX].choices.items.[INDEX].label","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"context.subject.kba.questions.items.[INDEX].choices.items.[INDEX].text","typeLabel":"string"}},"required":["label","text"],"uniqueKey":"context.subject.kba.questions.items.[INDEX].choices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"context.subject.kba.questions.items.[INDEX].choices","typeLabel":"object[]"},"helpText":{"type":"string","uniqueKey":"context.subject.kba.questions.items.[INDEX].helpText","typeLabel":"string"}},"required":["id","questionText","choices"],"uniqueKey":"context.subject.kba.questions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"context.subject.kba.questions","typeLabel":"object[]"},"answers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"context.subject.kba.answers.items.[INDEX].id","typeLabel":"integer"},"choices":{"type":"array","items":{"type":"string","uniqueKey":"context.subject.kba.answers.items.[INDEX].choices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"context.subject.kba.answers.items.[INDEX].choices","typeLabel":"string[]"}},"required":["id","choices"],"uniqueKey":"context.subject.kba.answers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"context.subject.kba.answers","typeLabel":"object[]"}},"required":["questions","answers"],"uniqueKey":"context.subject.kba","typeLabel":"object"},"documentTypeSelection":{"type":"object","properties":{"offered":{"type":"array","items":{"type":"string","enum":["australiaPassport","australiaDrivingLicense","australiaBirthCertificate","australiaCentrelink","australiaCitizenshipCertificate","australiaVisa","australiaMedicare","australiaImmicard","australiaMarriageCertificate","australiaChangeOfNameCertificate","australiaElectoralRoll","newZealandPassport","newZealandDrivingLicense","newZealandBirthCertificate","newZealandCitizenshipCertificate","noneOfThese"],"uniqueKey":"context.subject.documentTypeSelection.offered.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"context.subject.documentTypeSelection.offered","typeLabel":"enum\u003cstring>[]"},"selected":{"type":"string","enum":["australiaPassport","australiaDrivingLicense","australiaBirthCertificate","australiaCentrelink","australiaCitizenshipCertificate","australiaVisa","australiaMedicare","australiaImmicard","australiaMarriageCertificate","australiaChangeOfNameCertificate","australiaElectoralRoll","newZealandPassport","newZealandDrivingLicense","newZealandBirthCertificate","newZealandCitizenshipCertificate","noneOfThese"],"uniqueKey":"context.subject.documentTypeSelection.selected","typeLabel":"enum\u003cstring>"}},"uniqueKey":"context.subject.documentTypeSelection","typeLabel":"object"},"uid":{"type":"string","uniqueKey":"context.subject.uid","typeLabel":"string"}},"uniqueKey":"context.subject","typeLabel":"object"}},"required":["config"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"context","typeLabel":"object"},"scenario":{"type":"object","properties":{"modules":{"type":"object","additionalProperties":{"type":"object","properties":{"outcome":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"scenario.modules.additionalProperties.outcome","typeLabel":"string"},"advice":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"scenario.modules.additionalProperties.advice.additionalProperties","typeLabel":"any"},"uniqueKey":"scenario.modules.additionalProperties.advice","typeLabel":"object"},"subject":{"type":"object","description":"Domain-element values this module override returns in result.subject.","uniqueKey":"scenario.modules.additionalProperties.subject","typeLabel":"object"}},"required":["outcome"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"scenario.modules.additionalProperties.additionalProperties","typeLabel":"any"},"uniqueKey":"scenario.modules.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"scenario.modules","typeLabel":"object"},"defaultOutcome":{"type":"string","uniqueKey":"scenario.defaultOutcome","typeLabel":"string"},"defaultAdvice":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"scenario.defaultAdvice.additionalProperties","typeLabel":"any"},"uniqueKey":"scenario.defaultAdvice","typeLabel":"object"},"defaultSubject":{"type":"object","description":"Fallback subject values applied when a module entry has no subject of its own.","uniqueKey":"scenario.defaultSubject","typeLabel":"object"},"description":{"type":"string","uniqueKey":"scenario.description","typeLabel":"string"}},"required":["modules"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"scenario.additionalProperties","typeLabel":"any"},"uniqueKey":"scenario","typeLabel":"object"}},"required":["resourceId","context"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"resourceId":"\u003cstring>","context":{"config":{"delivery":"\u003cstring>","branding":"\u003cunknown>","assisted":true,"inlineResult":true,"syncWaitSeconds":123,"linkConfig":{"ttlMinutes":2,"resumeExpiryMinutes":2}},"subject":{"identity":{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"],"aliases":[{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"],"fullName":"\u003cstring>"}],"relatedPersons":[{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"]}],"dateOfBirth":"\u003cstring>","gender":"\u003cstring>","currentAddress":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}},"previousAddresses":[{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"},"fromDate":"\u003cstring>","toDate":"\u003cstring>"}],"placeOfBirth":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}},"idNumbers":[{"type":"\u003cstring>","idNumber":"\u003cstring>","country":"\u003cstring>"}],"phones":[{"type":"\u003cstring>","number":"\u003cstring>"}],"emails":[{"type":"\u003cstring>","email":"jsmith@example.com"}],"socials":[{"type":"\u003cstring>","identity":"\u003cstring>"}],"mothersMaidenName":"\u003cstring>","nationality":"\u003cstring>"},"entities":[{"id":"\u003cstring>","type":"primary","name":"\u003cstring>","aliases":["\u003cstring>"],"businessType":"\u003cstring>","description":"\u003cstring>","addresses":[{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}}],"taxIdentifiers":[{"value":"\u003cstring>","country":"\u003cstring>"}],"companyNumber":"\u003cstring>","industryClassifications":[{"code":"\u003cstring>","description":"\u003cstring>"}],"registrations":[{"jurisdiction":"\u003cstring>","fileNumber":"\u003cstring>","issueDate":"\u003cstring>","registeredAddress":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}},"agentName":"\u003cstring>","agentAddress":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}}}],"corporateStructure":"\u003cstring>","persons":[{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"],"id":"\u003cstring>","type":"primary","position":"\u003cstring>","ownershipPercentage":50,"nationality":"\u003cstring>","dateOfBirth":"\u003cstring>","startDate":"\u003cstring>","endDate":"\u003cstring>","currentAddress":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}}}],"incorporationDate":"\u003cstring>","dissolutionDate":"\u003cstring>","phones":[{"type":"\u003cstring>","number":"\u003cstring>"}],"websites":["\u003cstring>"],"headcount":1,"isNonProfit":true}],"documents":[{"type":"\u003cstring>","oneDBarcode":"\u003cstring>","address":{"addressString":"\u003cstring>","extractedAddressString":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","locality":"\u003cstring>","administrativeArea":"\u003cstring>","postalCode":"\u003cstring>"},"applicationDate":"\u003cstring>","applicationNumber":"\u003cstring>","dateOfBirth":"\u003cstring>","placeOfBirth":"\u003cstring>","placeOfBirthNative":"\u003cstring>","bloodType":"\u003cstring>","controlNumber":"\u003cstring>","countryCode":"\u003cstring>","countryName":"\u003cstring>","documentClassCode":"\u003cstring>","documentClassName":"\u003cstring>","documentNumber":"\u003cstring>","documentSignerCertificate":"\u003cstring>","employer":"\u003cstring>","employerAddress":"\u003cstring>","entries":"\u003cstring>","expirationDate":"\u003cstring>","eyeColor":"\u003cstring>","fathersName":"\u003cstring>","fathersNameNative":"\u003cstring>","fathersSurname":"\u003cstring>","firstName":"\u003cstring>","fullName":"\u003cstring>","fullNameNative":"\u003cstring>","givenName":"\u003cstring>","givenNameNative":"\u003cstring>","hairColor":"\u003cstring>","height":"\u003cstring>","issueDate":"\u003cstring>","issuingAuthority":"\u003cstring>","issuingAuthorityNative":"\u003cstring>","issuingStateCode":"\u003cstring>","issuingStateName":"\u003cstring>","licenseClass":"\u003cstring>","licenseEndorsements":"\u003cstring>","licenseRestrictions":"\u003cstring>","mrz":"\u003cstring>","mrz1":"\u003cstring>","mrz2":"\u003cstring>","mrz3":"\u003cstring>","middleName":"\u003cstring>","mothersName":"\u003cstring>","mothersNameNative":"\u003cstring>","mothersSurname":"\u003cstring>","nameSuffix":"\u003cstring>","nationalityCode":"\u003cstring>","nationalityName":"\u003cstring>","nationalityNameNative":"\u003cstring>","occupation":"\u003cstring>","organDonor":true,"passportNumber":"\u003cstring>","permitNumber":"\u003cstring>","personalNumber":"\u003cstring>","photo":"\u003cstring>","photoCompressed":"\u003cstring>","photoEncoding":"\u003cstring>","sex":"\u003cstring>","sexNative":"\u003cstring>","signature":"\u003cstring>","signatureCompressed":"\u003cstring>","signatureEncoding":"\u003cstring>","socialSecurityNumber":"\u003cstring>","startDate":"\u003cstring>","surname":"\u003cstring>","surnameNative":"\u003cstring>","visaClass":"\u003cstring>","visaNumber":"\u003cstring>","weight":"\u003cstring>","cardNumber":"\u003cstring>","issuerCountryCode":"\u003cstring>","id":"\u003cstring>","category":"\u003cstring>","subtype":"\u003cstring>","format":"\u003cstring>","device":{"type":"\u003cstring>","model":"\u003cstring>","hasContactlessReader":true,"hasMagneticStripeReader":true,"hasCamera":true,"serialNumber":"\u003cstring>","manufacturer":"\u003cstring>"},"side1Image":"\u003cstring>","side2Image":"\u003cstring>","side1Device":{"type":"\u003cstring>","model":"\u003cstring>","hasContactlessReader":true,"hasMagneticStripeReader":true,"hasCamera":true,"serialNumber":"\u003cstring>","manufacturer":"\u003cstring>"},"side2Device":{"type":"\u003cstring>","model":"\u003cstring>","hasContactlessReader":true,"hasMagneticStripeReader":true,"hasCamera":true,"serialNumber":"\u003cstring>","manufacturer":"\u003cstring>"},"classification":{"ids":["\u003cstring>"],"category":"\u003cstring>","type":"\u003cstring>","subtype":"\u003cstring>","isDoubleSided":true,"hasNFC":true,"year":"\u003cstring>","countryCode":"\u003cstring>","countryName":"\u003cstring>","stateCode":"\u003cstring>","stateName":"\u003cstring>","sides":[{"side":"\u003cstring>","id":"\u003cstring>","documentQuality":"\u003cstring>","documentQualityScore":123}]},"extraction":{"aggregatedFields":[{"label":"\u003cstring>","value":"\u003cstring>","source":"\u003cstring>","isNonLatin":true}],"extractedFields":[{"label":"\u003cstring>","details":[{"label":"\u003cstring>","value":"\u003cstring>","source":"\u003cstring>","isNonLatin":true}]}],"extractedImages":[{"label":"\u003cstring>","side":"\u003cstring>","imageID":"\u003cstring>"}]},"validation":{"validationChecks":[{"name":"\u003cstring>","title":"\u003cstring>","info":"\u003cstring>","validationResult":"\u003cstring>","resultInfo":"\u003cstring>","weight":"\u003cstring>","type":"\u003cstring>","regionOfInterests":[{"side":"\u003cstring>","spectrum":"\u003cstring>","imageId":"\u003cstring>"}]}],"aggregatedValidationChecks":[{"name":"\u003cstring>","title":"\u003cstring>","info":"\u003cstring>","validationResult":"\u003cstring>","resultInfo":"\u003cstring>","weight":"\u003cstring>","type":"\u003cstring>","regionOfInterests":[{"side":"\u003cstring>","spectrum":"\u003cstring>","imageId":"\u003cstring>"}]}]},"subType":"\u003cstring>","number":"\u003cstring>","expiryDate":"\u003cstring>","cardType":"\u003cstring>","expiryMonth":"\u003cstring>","cardColour":"\u003cstring>","cardStatus":"\u003cstring>","subject":{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"],"aliases":[{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"],"fullName":"\u003cstring>"}],"relatedPersons":[{"title":"\u003cstring>","firstName":"\u003cstring>","middleNames":["\u003cstring>"],"lastNames":["\u003cstring>"],"lastNamesAtBirth":["\u003cstring>"]}],"dateOfBirth":"\u003cstring>","gender":"\u003cstring>","currentAddress":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}},"previousAddresses":[{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"},"fromDate":"\u003cstring>","toDate":"\u003cstring>"}],"placeOfBirth":{"lines":["\u003cstring>"],"addressString":"\u003cstring>","premise":"\u003cstring>","building":"\u003cstring>","subBuilding":"\u003cstring>","thoroughfare":"\u003cstring>","dependentThoroughfare":"\u003cstring>","locality":"\u003cstring>","dependentLocality":"\u003cstring>","doubleDependentLocality":"\u003cstring>","postalCode":"\u003cstring>","postBox":"\u003cstring>","country":"\u003cstring>","superAdministrativeArea":"\u003cstring>","administrativeArea":"\u003cstring>","subAdministrativeArea":"\u003cstring>","organization":"\u003cstring>","location":{"latitude":"\u003cstring>","longitude":"\u003cstring>","geoAccuracy":"\u003cstring>","what3words":"\u003cstring>"}},"idNumbers":[{"type":"\u003cstring>","idNumber":"\u003cstring>","country":"\u003cstring>"}],"phones":[{"type":"\u003cstring>","number":"\u003cstring>"}],"emails":[{"type":"\u003cstring>","email":"jsmith@example.com"}],"socials":[{"type":"\u003cstring>","identity":"\u003cstring>"}],"mothersMaidenName":"\u003cstring>","nationality":"\u003cstring>"},"country":"\u003cstring>","certificateFormat":"\u003cstring>","registrationNumber":"\u003cstring>","registrationDate":"\u003cstring>","registrationYear":"\u003cstring>","partyRole":"\u003cstring>","dateOfEvent":"\u003cstring>","acquisitionDate":"\u003cstring>","previousFirstName":"\u003cstring>","previousMiddleName":"\u003cstring>","previousSurname":"\u003cstring>","individualReferenceNumber":"\u003cstring>","nameLine1":"\u003cstring>","nameLine2":"\u003cstring>","nameLine3":"\u003cstring>","nameLine4":"\u003cstring>"}],"biometrics":[{"face1Image":"\u003cstring>","face2Image":"\u003cstring>","id":"\u003cstring>","type":"\u003cstring>"}],"sessions":[{"id":"\u003cstring>","type":"\u003cstring>","provider":"\u003cstring>","auth":[{"id":"\u003cstring>","scope":"\u003cstring>","codeVerifier":"\u003cstring>","code":"\u003cstring>","state":"\u003cstring>","redirectUri":"\u003cstring>","responseType":"\u003cstring>","clientId":"\u003cstring>","clientSecret":"\u003cstring>"}]}],"consent":[{"url":"\u003cstring>","id":"\u003cstring>","version":"\u003cstring>","effectiveDate":"\u003cstring>","expiryDate":"\u003cstring>","terms":"\u003cstring>","purpose":"\u003cstring>","legalBasis":"\u003cstring>","jurisdiction":"\u003cstring>","subject":"\u003cstring>","signatory":"\u003cstring>"}],"accounts":[{"type":"\u003cstring>","accountNumber":"\u003cstring>","sortCode":"\u003cstring>","routingNumber":"\u003cstring>","iban":"\u003cstring>","bic":"\u003cstring>","accountHolderName":"\u003cstring>","bankName":"\u003cstring>","country":"\u003cstring>","accountType":"\u003cstring>"}],"documentTypeSelection":{"offered":[]},"uid":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"09bfde15-3950-4e7e-b674-b0ed76be6e02":{"description":"Journey started","content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","isRequired":true,"uniqueKey":"instanceId","typeLabel":"string"},"status":{"type":"string","enum":["started","completed","failed","awaiting-input","pending"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"instanceUrl":{"type":"string","uniqueKey":"instanceUrl","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"state":{"type":"object","properties":{"view":{"type":"string","enum":["full"],"isRequired":true,"uniqueKey":"state.view","typeLabel":"enum\u003cstring>"},"instanceId":{"type":"string","isRequired":true,"uniqueKey":"state.instanceId","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"state.status","typeLabel":"string"},"context":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"state.context.additionalProperties","typeLabel":"any"},"uniqueKey":"state.context","typeLabel":"object"},"result":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"state.result.additionalProperties","typeLabel":"any"},"uniqueKey":"state.result","typeLabel":"object"}},"required":["view","instanceId","status"],"uniqueKey":"state","typeLabel":"object"},"test":{"type":"boolean","description":"Present and `true` only when the journey was started as a test scenario.","uniqueKey":"test","typeLabel":"boolean"},"scenario":{"type":"string","description":"The test scenario that was applied: its name, or \"inline\" for a scenario supplied in the request body. Present only together with `test: true`.","example":"inline","uniqueKey":"scenario","typeLabel":"string"}},"required":["instanceId","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"instanceId":"\u003cstring>","status":"started","instanceUrl":"\u003cstring>","message":"\u003cstring>","state":{"view":"full","instanceId":"\u003cstring>","status":"\u003cstring>","context":{},"result":{}},"test":true,"scenario":"inline"}}},"exampleType":"generated"}},"exampleType":"generated"},"853a788b-57df-4a33-bf32-036737ea05ef":{"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"},"ba1dc00d-24bb-41b3-9ff4-3247ea36aa4d":{"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"},"ed288f16-e24e-460d-9e4e-f7a415c8b315":{"description":"Forbidden — test scenarios are disabled on this service, OR test scenarios are not enabled for the requesting organisation (GGO-16240)","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"},"ce161d80-6771-4cdb-a349-cb5f1c2f64fc":{"description":"Delivery / resource 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"},"ea453f70-5b77-47d9-8642-7db752333ceb":{"description":"Test scenario exists but its stored payload is invalid","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"},"2c22fd98-ac30-4c18-9fa6-e9451ee853d3":{"description":"Too many requests — scheduler admission budget exhausted (retry after Retry-After)","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"},"e92b657f-7a92-4f32-88b3-17a953bb1c7e":{"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"},"d7212a34-32b1-4850-905a-6f01184038af":{"description":"Service unavailable","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":{"722f1437-5835-4d92-9c4a-f4429c5e2181":{"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"}}},"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"}]},"originalFileLocation":"docs/go-v2/openapi-v2.json"},"subdomain":"gbg-loqate","siteName":"GBG Documentation","title":"Start a new journey - GBG Documentation","navMaps":{"firstHrefInVersion":{"v1":{"href":"/docs/go-v1/api-reference/endpoint/start-journey","matchLevel":1},"v2":{"href":"/docs/go-v2/api-reference/endpoint/start-journey","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T14:15:56.883Z","originalFileLocation":"docs/go-v2/api-reference/endpoint/start-journey.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=\"Start a customer verification journey in GBG Go to create a trackable journey instance for an 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=\"Start a new journey - GBG Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start a customer verification journey in GBG Go to create a trackable journey instance for an 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/start-journey\">\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=Journey+execution\u0026amp;title=Start+a+new+journey\u0026amp;description=Start+a+customer+verification+journey+in+GBG+Go+to+create+a+trackable+journey+instance+for+an+end+user.\u0026amp;theme=41362d6b25f749ee380918e2\u0026amp;signature=9dd19237df69451ca44d1dfdb300ecdf33a29b06c92f207601c008d79043c541\">\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=\"Start a new journey - GBG Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start a customer verification journey in GBG Go to create a trackable journey instance for an end user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gbg-loqate.mintlify.site/_mintlify/api/og/v2?division=Journey+execution\u0026amp;title=Start+a+new+journey\u0026amp;description=Start+a+customer+verification+journey+in+GBG+Go+to+create+a+trackable+journey+instance+for+an+end+user.\u0026amp;theme=41362d6b25f749ee380918e2\u0026amp;signature=9dd19237df69451ca44d1dfdb300ecdf33a29b06c92f207601c008d79043c541\">\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/start-journey\">\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/start-journey.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/start-journey#webpage\",\"url\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey\",\"name\":\"Start a new journey\",\"description\":\"Start a customer verification journey in GBG Go to create a trackable journey instance for an end user.\",\"dateModified\":\"2026-08-21T14:15:56.883Z\",\"isPartOf\":{\"@id\":\"https://docs.go.gbgplc.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Journey execution\",\"item\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/generate-access-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start a new journey\",\"item\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey#apireference\",\"headline\":\"Start a new journey\",\"name\":\"Start a new journey\",\"description\":\"Start a customer verification journey in GBG Go to create a trackable journey instance for an end user.\",\"url\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey\",\"mainEntityOfPage\":{\"@id\":\"https://docs.go.gbgplc.com/docs/go-v2/api-reference/endpoint/start-journey#webpage\"},\"dateModified\":\"2026-08-21T14:15:56.883Z\",\"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/api-reference/endpoint/start-journey"}]},{"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","description":"Generate an OAuth2 access token by exchanging your GBG Go API client credentials, required for all subsequent API calls.","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","description":"Retrieve the list of tasks assigned to a GBG Go journey instance to determine what actions the customer must complete. Deprecated.","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","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","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":"Start a new journey - 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"]}