Return a 200 status to indicate that the data was received successfully.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"iDenfy Documentation","description":"Integrate identity verification, business verification, AML screening, and fraud prevention into your platform.","colors":{"primary":"#734BFB","light":"#9B7BFC","dark":"#5A2FE0"},"logo":{"light":"https://mintcdn.com/idenfy/aMmsrDpzQlHq3f58/logo/light.svg?fit=max\u0026auto=format\u0026n=aMmsrDpzQlHq3f58\u0026q=85\u0026s=e2c9be61445008ddc363f696904c4607","dark":"https://mintcdn.com/idenfy/aMmsrDpzQlHq3f58/logo/dark.svg?fit=max\u0026auto=format\u0026n=aMmsrDpzQlHq3f58\u0026q=85\u0026s=5649c5028f0d476336c7c409ff09455d"},"favicon":"https://mintcdn.com/idenfy/RiTtnFM9jz4M_Y-0/favicon.ico?fit=max\u0026auto=format\u0026n=RiTtnFM9jz4M_Y-0\u0026q=85\u0026s=7ae1822a59f6abddf043ef7ac3aa640e","api":{"openapi":["openapi/kyc.yaml","openapi/kyb.yaml","openapi/aml.yaml","openapi/bank.yaml","openapi/face-authentication.yaml","openapi/age-estimation.yaml","openapi/bank-card.yaml"],"playground":{"display":"interactive"},"examples":{"languages":["bash","python","javascript","java","php","ruby","csharp","go","kotlin","swift"]}},"appearance":{"default":"system"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://admin.idenfy.com","label":"Dashboard"},{"href":"https://status.idenfy.com/","label":"Status"}],"primary":{"type":"button","label":"Get Started Free","href":"https://idenfy.com/pricing-plans/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/idenfy","github":"https://github.com/idenfy","x":"https://x.com/iDenfy"}},"search":{"prompt":"Search iDenfy docs..."},"seo":{"indexing":"navigable"},"fonts":{"family":"Inter"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":false},"metadata":{"timestamp":false},"navigation":{"global":{"anchors":[{"anchor":"API Reference","icon":"square-terminal","href":"/api-reference"},{"anchor":"Changelog","icon":"list","href":"/changelog"},{"anchor":"Support","icon":"life-ring","href":"https://idenfy-ivs.atlassian.net/servicedesk/customer/portal/1"},{"anchor":"Postman","icon":"rocket","href":"https://www.postman.com/idenfy-developers/idenfy-public-api/collection/gwjcqp9/idenfy-api-requests"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"idenfy","hasAudioNarration":false,"actualSubdomain":"idenfy","customDomains":["documentation.idenfy.com"],"gitSource":{"type":"github","owner":"domantasc","repo":"idenfy_documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0895d6c1a15a18d9d7a3c","collectionId":"b214581c-2474-4266-8d90-c92332452274","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0895d6c1a15a18d9d7a3c"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0895d6c1a15a18d9d7a3c","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Guides","count":137},{"language":"default","tag":"Business Verification","count":102},{"language":"default","tag":"API Reference","count":97},{"language":"default","tag":"API Documentation","count":71},{"language":"default","tag":"AML Screening","count":35},{"language":"default","tag":"ID Verification","count":34},{"language":"default","tag":"Dashboard Settings","count":27},{"language":"default","tag":"Webhooks","count":23},{"language":"default","tag":"SDKs","count":20},{"language":"default","tag":"ID Verification (KYC)","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@idenfy.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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/webhooks/company-review","slug":"/api-reference/webhooks/company-review","pageMetadata":{"title":"Company review","description":"This notification is sent when a company verification is completed.","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyReview","href":"/api-reference/webhooks/company-review","autogeneratedByOpenApi":true},"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: \"This notification is sent when a company verification is completed.\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Company review","description":"This notification is sent when a company verification is completed.","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyReview","href":"/api-reference/webhooks/company-review","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/idenfy/ba72bcb4163466c3/feedback-widget.js"],"openApiReferenceData":{"operation":{"operationId":"companyReview","description":"This notification is sent when a company verification is completed.","summary":"Company review","externalDocs":{"description":"Find info about webhook signing here.","url":"https://documentation.idenfy.com/security/CallbackSigning"},"parameters":["61431a66-49ee-45ed-929d-f4c144788ac7","1e465751-5778-4984-9365-0beccfedf3a9"],"tags":["Webhooks"],"requestBody":"9d9e4eb4-b23a-4cf3-98f1-6d87a97e07aa","responses":{"200":"647f2a7b-f234-41c1-b49a-49895913d7a7"},"method":"post","type":"webhook","servers":["03cb0927-dd7a-43c7-9d4c-f094eeea0931"],"security":[],"path":"companyReview","baseUrlOptions":["https://ivs.idenfy.com"],"title":"Company review","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","java","php","ruby","csharp","go","kotlin","swift"],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example","code":"{\n \"companyName\": \"\u003cstring>\",\n \"statusChangedBy\": {\n \"username\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\"\n },\n \"sanctionsStatusSetBy\": {\n \"username\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\"\n },\n \"amlCheck\": {\n \"statusSetBy\": {\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\"\n },\n \"statusSetAt\": \"2023-11-07T05:31:56Z\",\n \"adverseMedia\": [\n {\n \"title\": \"\u003cstring>\",\n \"url\": \"\u003cstring>\",\n \"text\": \"\u003cstring>\",\n \"score\": \"\u003cstring>\",\n \"type\": \"\u003cstring>\",\n \"publishDate\": \"\u003cstring>\",\n \"status\": \"\u003cstring>\"\n }\n ],\n \"amlCheck\": [\n {\n \"resourceId\": \"\u003cstring>\",\n \"score\": 123,\n \"match\": \"\u003cstring>\",\n \"name\": \"\u003cstring>\",\n \"addresses\": [\n {\n \"geography\": \"\u003cstring>\",\n \"city\": \"\u003cstring>\"\n }\n ],\n \"datasets\": [],\n \"currentSanBodyIds\": [\n 123\n ],\n \"formerSanBodyIds\": [\n 123\n ],\n \"version\": 123\n }\n ]\n },\n \"beneficiaries\": [\n {\n \"pepsStatusSetBy\": {\n \"username\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\"\n },\n \"sanctionsStatusSetBy\": {\n \"username\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\"\n },\n \"newsStatusSetBy\": {\n \"username\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\"\n },\n \"amlCheck\": {\n \"statusSetBy\": {\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\"\n },\n \"statusSetAt\": \"2023-11-07T05:31:56Z\",\n \"adverseMedia\": [\n {\n \"title\": \"\u003cstring>\",\n \"url\": \"\u003cstring>\",\n \"text\": \"\u003cstring>\",\n \"score\": \"\u003cstring>\",\n \"type\": \"\u003cstring>\",\n \"publishDate\": \"\u003cstring>\",\n \"status\": \"\u003cstring>\"\n }\n ],\n \"amlCheck\": [\n {\n \"resourceId\": \"\u003cstring>\",\n \"score\": 123,\n \"match\": \"\u003cstring>\",\n \"name\": \"\u003cstring>\",\n \"addresses\": [\n {\n \"geography\": \"\u003cstring>\",\n \"city\": \"\u003cstring>\"\n }\n ],\n \"nationalities\": [],\n \"datesOfBirth\": [\n \"\u003cstring>\"\n ],\n \"datasets\": [],\n \"currentSanBodyIds\": [\n 123\n ],\n \"formerSanBodyIds\": [\n 123\n ],\n \"version\": 123,\n \"profileImage\": \"\u003cstring>\"\n }\n ]\n },\n \"amlComment\": \"\u003cstring>\",\n \"pepsStatusSetAt\": \"2023-11-07T05:31:56Z\",\n \"sanctionsStatusSetAt\": \"2023-11-07T05:31:56Z\",\n \"negativeNewsComment\": \"\u003cstring>\",\n \"newsStatusSetAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"newsStatusSetBy\": {\n \"username\": \"\u003cstring>\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"\u003cstring>\",\n \"surname\": \"\u003cstring>\"\n },\n \"clientId\": \"\u003cstring>\",\n \"registrationNumber\": \"\u003cstring>\",\n \"denyReason\": \"\u003cstring>\",\n \"soleProprietor\": true,\n \"amlComment\": \"\u003cstring>\",\n \"sanctionsStatusSetAt\": \"2023-11-07T05:31:56Z\",\n \"negativeNewsComment\": \"\u003cstring>\",\n \"newsStatusSetAt\": \"2023-11-07T05:31:56Z\",\n \"externalRef\": \"\u003cstring>\",\n \"relatedClientScanRefs\": [\n \"\u003cstring>\"\n ]\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"61431a66-49ee-45ed-929d-f4c144788ac7":{"in":"header","name":"Idenfy-Event-Type","schema":{"type":"string","enum":["COMPANY_REVIEW"],"isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":true},"1e465751-5778-4984-9365-0beccfedf3a9":{"in":"header","name":"Idenfy-Signature","schema":{"type":"string","description":"Webhook signature","uniqueKey":"","typeLabel":"string"},"description":"Webhook signature"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"companyName","typeLabel":"string"},"statusChangedBy":{"oneOf":[{"type":"object","required":["email","id","name","surname","username"],"properties":{"username":{"type":"string","pattern":"^[\\w.@+-]+$","maxLength":255,"minLength":5,"deprecated":true,"isRequired":true,"uniqueKey":"statusChangedBy.oneOf.0.username","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"statusChangedBy.oneOf.0.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"statusChangedBy.oneOf.0.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"statusChangedBy.oneOf.0.surname","typeLabel":"string"}},"isRequired":true,"uniqueKey":"statusChangedBy.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"statusChangedBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"statusChangedBy","typeLabel":"object | null"},"sanctionsStatusSetBy":{"type":"object","required":["email","id","name","surname","username"],"deprecated":true,"properties":{"username":{"type":"string","pattern":"^[\\w.@+-]+$","maxLength":255,"minLength":5,"deprecated":true,"isRequired":true,"uniqueKey":"sanctionsStatusSetBy.username","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"sanctionsStatusSetBy.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"sanctionsStatusSetBy.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"sanctionsStatusSetBy.surname","typeLabel":"string"}},"isRequired":true,"uniqueKey":"sanctionsStatusSetBy","typeLabel":"object"},"amlCheck":{"type":"object","properties":{"overallStatus":{"enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"type":"string","uniqueKey":"amlCheck.overallStatus","typeLabel":"enum\u003cstring>"},"statusSetBy":{"oneOf":[{"type":"object","required":["email","id","name","surname"],"properties":{"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"amlCheck.statusSetBy.oneOf.0.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"amlCheck.statusSetBy.oneOf.0.surname","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"amlCheck.statusSetBy.oneOf.0.email","typeLabel":"string\u003cemail>"}},"uniqueKey":"amlCheck.statusSetBy.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"amlCheck.statusSetBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"amlCheck.statusSetBy","typeLabel":"object | null"},"statusSetAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"amlCheck.statusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"amlCheck.statusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"amlCheck.statusSetAt","typeLabel":"string\u003cdate-time> | null"},"adverseMedia":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"url":{"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].url","typeLabel":"string"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].text","typeLabel":"string | null"},"score":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].score.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].score","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].type","typeLabel":"string | null"},"publishDate":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].publishDate.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].publishDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].publishDate","typeLabel":"string | null"},"status":{"type":"string","uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].status","typeLabel":"string"},"comment":{"type":"object","properties":{"manager":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager.surname","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager.email","typeLabel":"string\u003cemail>"}},"required":["email","id","name","surname"],"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager","typeLabel":"object"},"content":{"type":"string","maxLength":10000,"isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.content","typeLabel":"string"},"type":{"enum":["ADVERSE_MEDIA","AML_PROFILE"],"type":"string","isRequired":true,"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.type","typeLabel":"enum\u003cstring>"}},"required":["content","created","id","manager","type"],"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment","typeLabel":"object"}},"required":["publishDate","score","text","title","type","url"],"uniqueKey":"amlCheck.adverseMedia.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"amlCheck.adverseMedia.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"text":{"oneOf":[{"type":"string"},{"type":"null"}]},"score":{"oneOf":[{"type":"string"},{"type":"null"}]},"type":{"oneOf":[{"type":"string"},{"type":"null"}]},"publishDate":{"oneOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"comment":{"type":"object","properties":{"manager":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"surname":{"type":"string","maxLength":100},"email":{"type":"string","format":"email","maxLength":254}},"required":["email","id","name","surname"]},"content":{"type":"string","maxLength":10000},"type":{"enum":["ADVERSE_MEDIA","AML_PROFILE"],"type":"string"}},"required":["content","created","id","manager","type"]}},"required":["publishDate","score","text","title","type","url"]},"uniqueKey":"amlCheck.adverseMedia.oneOf.1","typeLabel":"null"}],"uniqueKey":"amlCheck.adverseMedia","typeLabel":"object[] | null"},"amlCheck":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"resourceId":{"type":"string","description":"The resource ID can be used to retrieve the full profile or the PDF of the business.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].resourceId","typeLabel":"string"},"score":{"type":"integer","description":"The match score of the profile.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].score","typeLabel":"integer"},"match":{"type":"string","description":"The name of the profile that has been matched in the search.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].match","typeLabel":"string"},"name":{"type":"string","description":"The primary name of the profile.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].name","typeLabel":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"geography":{"type":"string","description":"An upper-case two-letter ISO-3166-2 code of a country or dependent territory of the profile address or profile nationality.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses.items.[INDEX].geography","typeLabel":"string"},"city":{"type":"string","description":"The city name of the profile address.","uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses.items.[INDEX].city","typeLabel":"string"}},"required":["geography"],"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses.items.[INDEX]","typeLabel":"object"},"description":"The list of profile addresses.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses","typeLabel":"object[]"},"datasets":{"type":"array","items":{"enum":["PEP","PEP_LINKED","SAN","SAN_CURRENT","SAN_FORMER","INS","RRE","POI","REL","SOE","SOE_CURRENT","SOE_FORMER"],"type":"string","uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].datasets.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The profile datasets\n * PEP - (Deprecated - ignore)\n * PEP_LINKED - Only linked PEPs (PEP by Association)\n * SAN - (Deprecated - ignore)\n * SAN_CURRENT - Only current Sanctions\n * SAN_FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * SOE - (Deprecated - ignore)\n * SOE_CURRENT - Only current SOE\n * SOE_FORMER - Only former SOE.\n","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].datasets","typeLabel":"enum\u003cstring>[]"},"currentSanBodyIds":{"type":"array","items":{"type":"integer","uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].currentSanBodyIds.items.[INDEX]","typeLabel":"integer"},"description":"The list of IDs of all sanctioning bodies, that are currently sanctioning the given profile. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].currentSanBodyIds","typeLabel":"integer[]"},"formerSanBodyIds":{"type":"array","items":{"type":"integer","uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].formerSanBodyIds.items.[INDEX]","typeLabel":"integer"},"description":"The list of IDs of all sanctioning bodies, that were sanctioning the given profile in the past, but do not currently sanction them. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint.","isRequired":true,"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].formerSanBodyIds","typeLabel":"integer[]"},"version":{"type":"integer","description":"The version number can be used by clients to detect when a profile has been changed by our research team.","uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX].version","typeLabel":"integer"}},"required":["addresses","currentSanBodyIds","datasets","formerSanBodyIds","match","name","resourceId","score"],"uniqueKey":"amlCheck.amlCheck.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"amlCheck.amlCheck.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"version":{"type":"integer","description":"The version number can be used by clients to detect when a profile has been changed by our research team."},"resourceId":{"type":"string","description":"The resource ID can be used to retrieve the full profile or the PDF of the business."},"score":{"type":"integer","description":"The match score of the profile."},"match":{"type":"string","description":"The name of the profile that has been matched in the search."},"name":{"type":"string","description":"The primary name of the profile."},"addresses":{"type":"array","items":{"type":"object","properties":{"geography":{"type":"string","description":"An upper-case two-letter ISO-3166-2 code of a country or dependent territory of the profile address or profile nationality."},"city":{"type":"string","description":"The city name of the profile address."}},"required":["geography"]},"description":"The list of profile addresses."},"datasets":{"type":"array","items":{"enum":["PEP","PEP_LINKED","SAN","SAN_CURRENT","SAN_FORMER","INS","RRE","POI","REL","SOE","SOE_CURRENT","SOE_FORMER"],"type":"string"},"description":"The profile datasets\n * PEP - (Deprecated - ignore)\n * PEP_LINKED - Only linked PEPs (PEP by Association)\n * SAN - (Deprecated - ignore)\n * SAN_CURRENT - Only current Sanctions\n * SAN_FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * SOE - (Deprecated - ignore)\n * SOE_CURRENT - Only current SOE\n * SOE_FORMER - Only former SOE.\n"},"currentSanBodyIds":{"type":"array","items":{"type":"integer"},"description":"The list of IDs of all sanctioning bodies, that are currently sanctioning the given profile. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."},"formerSanBodyIds":{"type":"array","items":{"type":"integer"},"description":"The list of IDs of all sanctioning bodies, that were sanctioning the given profile in the past, but do not currently sanction them. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."}},"required":["addresses","currentSanBodyIds","datasets","formerSanBodyIds","match","name","resourceId","score"]},"uniqueKey":"amlCheck.amlCheck.oneOf.1","typeLabel":"null"}],"uniqueKey":"amlCheck.amlCheck","typeLabel":"object[] | null"}},"required":["id"],"isRequired":true,"uniqueKey":"amlCheck","typeLabel":"object"},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"pepsStatusSetBy":{"type":"object","required":["email","id","name","surname","username"],"deprecated":true,"properties":{"username":{"type":"string","pattern":"^[\\w.@+-]+$","maxLength":255,"minLength":5,"deprecated":true,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetBy.username","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetBy.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetBy.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetBy.surname","typeLabel":"string"}},"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetBy","typeLabel":"object"},"sanctionsStatusSetBy":{"type":"object","required":["email","id","name","surname","username"],"deprecated":true,"properties":{"username":{"type":"string","pattern":"^[\\w.@+-]+$","maxLength":255,"minLength":5,"deprecated":true,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetBy.username","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetBy.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetBy.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetBy.surname","typeLabel":"string"}},"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetBy","typeLabel":"object"},"newsStatusSetBy":{"type":"object","required":["email","id","name","surname","username"],"deprecated":true,"properties":{"username":{"type":"string","pattern":"^[\\w.@+-]+$","maxLength":255,"minLength":5,"deprecated":true,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetBy.username","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetBy.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetBy.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetBy.surname","typeLabel":"string"}},"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetBy","typeLabel":"object"},"amlCheck":{"type":"object","properties":{"overallStatus":{"enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"type":"string","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.overallStatus","typeLabel":"enum\u003cstring>"},"statusSetBy":{"oneOf":[{"type":"object","required":["email","id","name","surname"],"properties":{"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetBy.oneOf.0.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetBy.oneOf.0.surname","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetBy.oneOf.0.email","typeLabel":"string\u003cemail>"}},"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetBy.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetBy","typeLabel":"object | null"},"statusSetAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.statusSetAt","typeLabel":"string\u003cdate-time> | null"},"adverseMedia":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"url":{"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].url","typeLabel":"string"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].text","typeLabel":"string | null"},"score":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].score.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].score","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].type","typeLabel":"string | null"},"publishDate":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].publishDate.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].publishDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].publishDate","typeLabel":"string | null"},"status":{"type":"string","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].status","typeLabel":"string"},"comment":{"type":"object","properties":{"manager":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager.surname","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager.email","typeLabel":"string\u003cemail>"}},"required":["email","id","name","surname"],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.manager","typeLabel":"object"},"content":{"type":"string","maxLength":10000,"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.content","typeLabel":"string"},"type":{"enum":["ADVERSE_MEDIA","AML_PROFILE"],"type":"string","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment.type","typeLabel":"enum\u003cstring>"}},"required":["content","created","id","manager","type"],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX].comment","typeLabel":"object"}},"required":["publishDate","score","text","title","type","url"],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"title":{"oneOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"text":{"oneOf":[{"type":"string"},{"type":"null"}]},"score":{"oneOf":[{"type":"string"},{"type":"null"}]},"type":{"oneOf":[{"type":"string"},{"type":"null"}]},"publishDate":{"oneOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"comment":{"type":"object","properties":{"manager":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"surname":{"type":"string","maxLength":100},"email":{"type":"string","format":"email","maxLength":254}},"required":["email","id","name","surname"]},"content":{"type":"string","maxLength":10000},"type":{"enum":["ADVERSE_MEDIA","AML_PROFILE"],"type":"string"}},"required":["content","created","id","manager","type"]}},"required":["publishDate","score","text","title","type","url"]},"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.adverseMedia","typeLabel":"object[] | null"},"amlCheck":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"resourceId":{"type":"string","description":"The resource ID can be used to retrieve the full profile or the PDF of the Individual.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].resourceId","typeLabel":"string"},"score":{"type":"integer","description":"The match score of the profile.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].score","typeLabel":"integer"},"match":{"type":"string","description":"The name of the profile that has been matched in the search.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].match","typeLabel":"string"},"name":{"type":"string","description":"The primary name of the profile.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].name","typeLabel":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"geography":{"type":"string","description":"An upper-case two-letter ISO-3166-2 code of a country or dependent territory of the profile address or profile nationality.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses.items.[INDEX].geography","typeLabel":"string"},"city":{"type":"string","description":"The city name of the profile address.","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses.items.[INDEX].city","typeLabel":"string"}},"required":["geography"],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses.items.[INDEX]","typeLabel":"object"},"description":"The list of profile addresses and nationalities.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].addresses","typeLabel":"object[]"},"nationalities":{"type":"array","items":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CK","CR","CI","HR","CU","CW","CY","CZ","CD","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VA","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].nationalities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of the individual's nationalities.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].nationalities","typeLabel":"enum\u003cstring>[]"},"datesOfBirth":{"type":"array","items":{"type":"string","description":"Date in either YYYY-MM-DD or YYYY-MM or YYYY ISO format.","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].datesOfBirth.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].datesOfBirth","typeLabel":"string[]"},"datasets":{"type":"array","items":{"enum":["PEP_CURRENT","PEP_FORMER","PEP_LINKED","SAN_CURRENT","SAN_FORMER","INS","RRE","DD","POI","REL","GRI"],"type":"string","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].datasets.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The profile datasets\n * PEP_CURRENT - Only current PEPs\n * PEP_FORMER - Only former PEPs\n * PEP_LINKED - Only linked PEPs (PEP by Association)\n * SAN_CURRENT - Only current Sanctions\n * SAN_FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * DD - Disqualified Director\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * GRI - Gambling Risk Intelligence.\n","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].datasets","typeLabel":"enum\u003cstring>[]"},"currentSanBodyIds":{"type":"array","items":{"type":"integer","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].currentSanBodyIds.items.[INDEX]","typeLabel":"integer"},"description":"The list of IDs of all sanctioning bodies, that are currently sanctioning the given profile. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].currentSanBodyIds","typeLabel":"integer[]"},"formerSanBodyIds":{"type":"array","items":{"type":"integer","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].formerSanBodyIds.items.[INDEX]","typeLabel":"integer"},"description":"The list of IDs of all sanctioning bodies, that were sanctioning the given profile in the past, but do not currently sanction them. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint.","isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].formerSanBodyIds","typeLabel":"integer[]"},"version":{"type":"integer","description":"The version number can be used by clients to detect when a profile has changed.","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].version","typeLabel":"integer"},"gender":{"type":"string","description":"Gender (for individuals), if known.","enum":["MALE","FEMALE"],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].gender","typeLabel":"enum\u003cstring>"},"profileImage":{"type":"string","description":"The primary profile image.","uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].profileImage","typeLabel":"string"},"pepTier":{"type":"string","description":"Defines the PEP tier of the individual. Where PEP Tier 1 indicates senior roles, PEP Tier 2 - middle-ranking, and PEP Tier 3 - junior officials.","enum":["PEP_TIER_1","PEP_TIER_2","PEP_TIER_3"],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX].pepTier","typeLabel":"enum\u003cstring>"}},"required":["addresses","currentSanBodyIds","datasets","datesOfBirth","formerSanBodyIds","match","name","nationalities","resourceId","score"],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"version":{"type":"integer","description":"The version number can be used by clients to detect when a profile has changed."},"resourceId":{"type":"string","description":"The resource ID can be used to retrieve the full profile or the PDF of the Individual."},"score":{"type":"integer","description":"The match score of the profile."},"match":{"type":"string","description":"The name of the profile that has been matched in the search."},"name":{"type":"string","description":"The primary name of the profile."},"addresses":{"type":"array","items":{"type":"object","properties":{"geography":{"type":"string","description":"An upper-case two-letter ISO-3166-2 code of a country or dependent territory of the profile address or profile nationality."},"city":{"type":"string","description":"The city name of the profile address."}},"required":["geography"]},"description":"The list of profile addresses and nationalities."},"nationalities":{"type":"array","items":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CK","CR","CI","HR","CU","CW","CY","CZ","CD","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VA","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"description":"List of the individual's nationalities."},"datesOfBirth":{"type":"array","items":{"type":"string","description":"Date in either YYYY-MM-DD or YYYY-MM or YYYY ISO format."}},"gender":{"type":"string","description":"Gender (for individuals), if known.","enum":["MALE","FEMALE"]},"profileImage":{"type":"string","description":"The primary profile image."},"datasets":{"type":"array","items":{"enum":["PEP_CURRENT","PEP_FORMER","PEP_LINKED","SAN_CURRENT","SAN_FORMER","INS","RRE","DD","POI","REL","GRI"],"type":"string"},"description":"The profile datasets\n * PEP_CURRENT - Only current PEPs\n * PEP_FORMER - Only former PEPs\n * PEP_LINKED - Only linked PEPs (PEP by Association)\n * SAN_CURRENT - Only current Sanctions\n * SAN_FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * DD - Disqualified Director\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * GRI - Gambling Risk Intelligence.\n"},"currentSanBodyIds":{"type":"array","items":{"type":"integer"},"description":"The list of IDs of all sanctioning bodies, that are currently sanctioning the given profile. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."},"formerSanBodyIds":{"type":"array","items":{"type":"integer"},"description":"The list of IDs of all sanctioning bodies, that were sanctioning the given profile in the past, but do not currently sanction them. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."},"pepTier":{"type":"string","description":"Defines the PEP tier of the individual. Where PEP Tier 1 indicates senior roles, PEP Tier 2 - middle-ranking, and PEP Tier 3 - junior officials.","enum":["PEP_TIER_1","PEP_TIER_2","PEP_TIER_3"]}},"required":["addresses","currentSanBodyIds","datasets","datesOfBirth","formerSanBodyIds","match","name","nationalities","resourceId","score"]},"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].amlCheck.amlCheck","typeLabel":"object[] | null"}},"required":["id"],"isRequired":true,"uniqueKey":"beneficiaries.items.[INDEX].amlCheck","typeLabel":"object"},"amlComment":{"oneOf":[{"type":"string","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].amlComment.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].amlComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].amlComment","typeLabel":"string | null"},"pepsCheckStatus":{"type":"string","description":"Always `NOT_CHECKED` for `COMPANY` beneficiaries because company AML can't have PEPs flags.","enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsCheckStatus","typeLabel":"enum\u003cstring>"},"pepsStatusSetAt":{"oneOf":[{"type":"string","format":"date-time","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].pepsStatusSetAt","typeLabel":"string\u003cdate-time> | null"},"sanctionsCheckStatus":{"type":"string","enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsCheckStatus","typeLabel":"enum\u003cstring>"},"sanctionsStatusSetAt":{"oneOf":[{"type":"string","format":"date-time","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].sanctionsStatusSetAt","typeLabel":"string\u003cdate-time> | null"},"negativeNewsComment":{"oneOf":[{"type":"string","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].negativeNewsComment.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].negativeNewsComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].negativeNewsComment","typeLabel":"string | null"},"negativeNewsStatus":{"type":"string","enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].negativeNewsStatus","typeLabel":"enum\u003cstring>"},"newsStatusSetAt":{"oneOf":[{"type":"string","format":"date-time","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","deprecated":true,"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaries.items.[INDEX].newsStatusSetAt","typeLabel":"string\u003cdate-time> | null"}},"required":["amlCheck","beneficiaryCheck","id","negativeNewsCheck","newsStatusSetBy","pepsStatusSetBy","sanctionsStatusSetBy","scanRef"],"uniqueKey":"beneficiaries.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"beneficiaries","typeLabel":"object[]"},"newsStatusSetBy":{"type":"object","required":["email","id","name","surname","username"],"deprecated":true,"properties":{"username":{"type":"string","pattern":"^[\\w.@+-]+$","maxLength":255,"minLength":5,"deprecated":true,"isRequired":true,"uniqueKey":"newsStatusSetBy.username","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"newsStatusSetBy.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"newsStatusSetBy.name","typeLabel":"string"},"surname":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"newsStatusSetBy.surname","typeLabel":"string"}},"isRequired":true,"uniqueKey":"newsStatusSetBy","typeLabel":"object"},"clientId":{"type":"string","description":"A unique string identifying a client on your side.","maxLength":100,"isRequired":true,"uniqueKey":"clientId","typeLabel":"string"},"registrationNumber":{"oneOf":[{"type":"string","maxLength":100,"uniqueKey":"registrationNumber.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"uniqueKey":"registrationNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"registrationNumber","typeLabel":"string | null"},"approvalStatus":{"oneOf":[{"type":"string","description":"Review approval status.","enum":["APPROVED","DENIED"],"uniqueKey":"approvalStatus.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"approvalStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"approvalStatus","typeLabel":"enum\u003cstring> | null"},"denyReason":{"oneOf":[{"type":"string","description":"The reason why this KYB form was denied.","maxLength":64,"uniqueKey":"denyReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason why this KYB form was denied.","maxLength":64,"uniqueKey":"denyReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"denyReason","typeLabel":"string | null"},"soleProprietor":{"type":"boolean","uniqueKey":"soleProprietor","typeLabel":"boolean"},"amlComment":{"oneOf":[{"type":"string","description":"DEPRECATED","deprecated":true,"uniqueKey":"amlComment.oneOf.0","typeLabel":"string"},{"type":"null","description":"DEPRECATED","deprecated":true,"uniqueKey":"amlComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"amlComment","typeLabel":"string | null"},"sanctionsCheckStatus":{"type":"string","description":"DEPRECATED","enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"deprecated":true,"uniqueKey":"sanctionsCheckStatus","typeLabel":"enum\u003cstring>"},"sanctionsStatusSetAt":{"oneOf":[{"type":"string","format":"date-time","description":"DEPRECATED","deprecated":true,"uniqueKey":"sanctionsStatusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"DEPRECATED","deprecated":true,"uniqueKey":"sanctionsStatusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sanctionsStatusSetAt","typeLabel":"string\u003cdate-time> | null"},"negativeNewsComment":{"oneOf":[{"type":"string","description":"DEPRECATED","deprecated":true,"uniqueKey":"negativeNewsComment.oneOf.0","typeLabel":"string"},{"type":"null","description":"DEPRECATED","deprecated":true,"uniqueKey":"negativeNewsComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"negativeNewsComment","typeLabel":"string | null"},"negativeNewsStatus":{"type":"string","description":"DEPRECATED","enum":["NOT_CHECKED","NO_FLAGS","FALSE_POSITIVE","TRUE_POSITIVE","FLAGS_FOUND"],"deprecated":true,"uniqueKey":"negativeNewsStatus","typeLabel":"enum\u003cstring>"},"newsStatusSetAt":{"oneOf":[{"type":"string","format":"date-time","description":"DEPRECATED","deprecated":true,"uniqueKey":"newsStatusSetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"DEPRECATED","deprecated":true,"uniqueKey":"newsStatusSetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"newsStatusSetAt","typeLabel":"string\u003cdate-time> | null"},"externalRef":{"oneOf":[{"type":"string","description":"Any additional value chosen by you.","maxLength":40,"uniqueKey":"externalRef.oneOf.0","typeLabel":"string"},{"type":"null","description":"Any additional value chosen by you.","maxLength":40,"uniqueKey":"externalRef.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalRef","typeLabel":"string | null"},"relatedClientScanRefs":{"oneOf":[{"type":"array","items":{"type":"string","title":"Scan refs","pattern":"^[^,]+$","maxLength":40,"uniqueKey":"relatedClientScanRefs.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"relatedClientScanRefs.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","title":"Scan refs","pattern":"^[^,]+$","maxLength":40},"uniqueKey":"relatedClientScanRefs.oneOf.1","typeLabel":"null"}],"uniqueKey":"relatedClientScanRefs","typeLabel":"string[] | null"}},"required":["amlCheck","beneficiaries","clientId","companyCheck","companyName","id","negativeNewsCheck","newsStatusSetBy","sanctionsStatusSetBy","shareholderCheck","statusChangedBy"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"companyName":"\u003cstring>","statusChangedBy":{"username":"\u003cstring>","email":"jsmith@example.com","name":"\u003cstring>","surname":"\u003cstring>"},"sanctionsStatusSetBy":{"username":"\u003cstring>","email":"jsmith@example.com","name":"\u003cstring>","surname":"\u003cstring>"},"amlCheck":{"statusSetBy":{"name":"\u003cstring>","surname":"\u003cstring>","email":"jsmith@example.com"},"statusSetAt":"2023-11-07T05:31:56Z","adverseMedia":[{"title":"\u003cstring>","url":"\u003cstring>","text":"\u003cstring>","score":"\u003cstring>","type":"\u003cstring>","publishDate":"\u003cstring>","status":"\u003cstring>"}],"amlCheck":[{"resourceId":"\u003cstring>","score":123,"match":"\u003cstring>","name":"\u003cstring>","addresses":[{"geography":"\u003cstring>","city":"\u003cstring>"}],"datasets":[],"currentSanBodyIds":[123],"formerSanBodyIds":[123],"version":123}]},"beneficiaries":[{"pepsStatusSetBy":{"username":"\u003cstring>","email":"jsmith@example.com","name":"\u003cstring>","surname":"\u003cstring>"},"sanctionsStatusSetBy":{"username":"\u003cstring>","email":"jsmith@example.com","name":"\u003cstring>","surname":"\u003cstring>"},"newsStatusSetBy":{"username":"\u003cstring>","email":"jsmith@example.com","name":"\u003cstring>","surname":"\u003cstring>"},"amlCheck":{"statusSetBy":{"name":"\u003cstring>","surname":"\u003cstring>","email":"jsmith@example.com"},"statusSetAt":"2023-11-07T05:31:56Z","adverseMedia":[{"title":"\u003cstring>","url":"\u003cstring>","text":"\u003cstring>","score":"\u003cstring>","type":"\u003cstring>","publishDate":"\u003cstring>","status":"\u003cstring>"}],"amlCheck":[{"resourceId":"\u003cstring>","score":123,"match":"\u003cstring>","name":"\u003cstring>","addresses":[{"geography":"\u003cstring>","city":"\u003cstring>"}],"nationalities":[],"datesOfBirth":["\u003cstring>"],"datasets":[],"currentSanBodyIds":[123],"formerSanBodyIds":[123],"version":123,"profileImage":"\u003cstring>"}]},"amlComment":"\u003cstring>","pepsStatusSetAt":"2023-11-07T05:31:56Z","sanctionsStatusSetAt":"2023-11-07T05:31:56Z","negativeNewsComment":"\u003cstring>","newsStatusSetAt":"2023-11-07T05:31:56Z"}],"newsStatusSetBy":{"username":"\u003cstring>","email":"jsmith@example.com","name":"\u003cstring>","surname":"\u003cstring>"},"clientId":"\u003cstring>","registrationNumber":"\u003cstring>","denyReason":"\u003cstring>","soleProprietor":true,"amlComment":"\u003cstring>","sanctionsStatusSetAt":"2023-11-07T05:31:56Z","negativeNewsComment":"\u003cstring>","newsStatusSetAt":"2023-11-07T05:31:56Z","externalRef":"\u003cstring>","relatedClientScanRefs":["\u003cstring>"]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"647f2a7b-f234-41c1-b49a-49895913d7a7":{"description":"Return a 200 status to indicate that the data was received successfully.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"03cb0927-dd7a-43c7-9d4c-f094eeea0931":{"url":"https://ivs.idenfy.com"}}},"originalFileLocation":"openapi/kyb.yaml"},"subdomain":"idenfy","siteName":"iDenfy Documentation","title":"Company review - iDenfy Documentation","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T10:38:56.135Z","originalFileLocation":"api-reference/webhooks/company-review.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This notification is sent when a company verification is completed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"iDenfy 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/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_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/idenfy/v3kxyxus7demIOg3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Company review - iDenfy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"This notification is sent when a company verification is completed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"iDenfy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://documentation.idenfy.com/api-reference/webhooks/company-review\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://idenfy.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Company+review\u0026amp;description=This+notification+is+sent+when+a+company+verification+is+completed.\u0026amp;theme=010a455f13e463755e9c7867\u0026amp;signature=a0fb3de474dcc97f4de0944a941bca257b6b9b64564c331f312d9b52f16a414e\">\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=\"Company review - iDenfy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This notification is sent when a company verification is completed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://idenfy.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Company+review\u0026amp;description=This+notification+is+sent+when+a+company+verification+is+completed.\u0026amp;theme=010a455f13e463755e9c7867\u0026amp;signature=a0fb3de474dcc97f4de0944a941bca257b6b9b64564c331f312d9b52f16a414e\">\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/idenfy/v3kxyxus7demIOg3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"iDenfy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#734BFB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://documentation.idenfy.com/api-reference/webhooks/company-review\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/company-review.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://documentation.idenfy.com/#organization\",\"name\":\"iDenfy Documentation\",\"url\":\"https://documentation.idenfy.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/idenfy/aMmsrDpzQlHq3f58/logo/light.svg?fit=max\u0026auto=format\u0026n=aMmsrDpzQlHq3f58\u0026q=85\u0026s=e2c9be61445008ddc363f696904c4607\"}},{\"@type\":\"WebSite\",\"@id\":\"https://documentation.idenfy.com#website\",\"name\":\"iDenfy Documentation\",\"url\":\"https://documentation.idenfy.com\",\"publisher\":{\"@id\":\"https://documentation.idenfy.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review#webpage\",\"url\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review\",\"name\":\"Company review\",\"description\":\"This notification is sent when a company verification is completed.\",\"dateModified\":\"2026-10-13T10:38:56.135Z\",\"isPartOf\":{\"@id\":\"https://documentation.idenfy.com#website\"},\"breadcrumb\":{\"@id\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Business Verification\",\"item\":\"https://documentation.idenfy.com/api-reference/gov-orders/list-gov-ordered-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Company review\",\"item\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review#apireference\",\"headline\":\"Company review\",\"name\":\"Company review\",\"description\":\"This notification is sent when a company verification is completed.\",\"url\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review\",\"mainEntityOfPage\":{\"@id\":\"https://documentation.idenfy.com/api-reference/webhooks/company-review#webpage\"},\"dateModified\":\"2026-10-13T10:38:56.135Z\",\"publisher\":{\"@id\":\"https://documentation.idenfy.com/#organization\"},\"isPartOf\":{\"@id\":\"https://documentation.idenfy.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"iDenfy Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"iDenfy Documentation","nav":{"global":{"anchors":[{"anchor":"API Reference","icon":"square-terminal","href":"/api-reference"},{"anchor":"Changelog","icon":"list","href":"/changelog"},{"anchor":"Support","icon":"life-ring","href":"https://idenfy-ivs.atlassian.net/servicedesk/customer/portal/1"},{"anchor":"Postman","icon":"rocket","href":"https://www.postman.com/idenfy-developers/idenfy-public-api/collection/gwjcqp9/idenfy-api-requests"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/resources/supported-documents"}]},{"tab":"API Documentation","pages":[{"title":"API Documentation","href":"/quickstart"}]},{"tab":"Compliance","pages":[{"title":"Compliance","href":"/guides/compliance/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","icon":"house","pages":[{"title":"API Reference","icon":"square-terminal","href":"/api-reference/overview"}]},{"group":"Identity Verification","icon":"id-card","pages":[{"group":"KYC Token","pages":[{"title":"Generate KYC token","deprecated":null,"version":null,"openapi":"/openapi/kyc.yaml post /api/v2/token","href":"/api-reference/kyc-token/generate-kyc-token"}]},{"group":"KYC Verifications","pages":[{"title":"List identifications","deprecated":null,"version":null,"openapi":"/openapi/kyc.yaml get /kyc/identifications/","href":"/api-reference/kyc-verifications/list-identifications"},{"title":"Request additional information from client","deprecated":null,"version":null,"openapi":"/openapi/kyc.yaml post /kyc/identifications/{scanRef}/request-information/","href":"/api-reference/kyc-verifications/request-additional-information-from-client"}]},{"group":"KYC Blocklist","pages":[{"title":"Add identification to blocklist","deprecated":null,"version":null,"openapi":"/openapi/kyc.yaml post /kyc/identifications/{scanRef}/blocklists/{blocklistSource}/","href":"/api-reference/kyc-blocklist/add-identification-to-blocklist"},{"title":"Remove identification from blocklist","deprecated":null,"version":null,"openapi":"/openapi/kyc.yaml delete /kyc/identifications/{scanRef}/blocklists/{blocklistSource}/","href":"/api-reference/kyc-blocklist/remove-identification-from-blocklist"}]},{"group":"POA","pages":[{"title":"Create POA check","deprecated":null,"version":null,"openapi":"/openapi/kyc.yaml post /api/v2/poa-checks/","href":"/api-reference/poa/create-poa-check"}]},{"group":"Webhooks","pages":[{"title":"Identification","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook identification","href":"/api-reference/webhooks/identification"},{"title":"Identification auto finished","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook identificationAutoFinished","href":"/api-reference/webhooks/identification-auto-finished"},{"title":"Identification manual finished","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook identificationManualFinished","href":"/api-reference/webhooks/identification-manual-finished"},{"title":"Identification expired","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook identificationExpired","href":"/api-reference/webhooks/identification-expired"},{"title":"Identification cancelled","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook identificationCancelled","href":"/api-reference/webhooks/identification-cancelled"},{"title":"Identification resubmitted","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook identificationResubmitted","href":"/api-reference/webhooks/identification-resubmitted"},{"title":"Document expiration","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook documentExpiration","href":"/api-reference/webhooks/document-expiration"},{"title":"Video call finished","version":null,"deprecated":null,"openapi":"/openapi/kyc.yaml webhook videoCallFinished","href":"/api-reference/webhooks/video-call-finished"}]}]},{"group":"Business Verification","icon":"building","pages":[{"group":"GOV Orders","pages":[{"title":"List GOV ordered documents","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /api/v2/gov-ordered-documents/","href":"/api-reference/gov-orders/list-gov-ordered-documents"},{"title":"Retrieve GOV ordered document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /api/v2/gov-ordered-documents/{id}/","href":"/api-reference/gov-orders/retrieve-gov-ordered-document"},{"title":"Retrieve available documents to order","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /api/v2/gov-ordered-documents/available-documents/","href":"/api-reference/gov-orders/retrieve-available-documents-to-order"},{"title":"Order GOV document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /api/v2/gov-ordered-documents/document-order/","href":"/api-reference/gov-orders/order-gov-document"}]},{"group":"SOS Reports","pages":[{"title":"List SOS filing documents","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /api/v2/sos-filing-documents/","href":"/api-reference/sos-reports/list-sos-filing-documents"},{"title":"Order SOS filing document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /api/v2/sos-filing-documents/","href":"/api-reference/sos-reports/order-sos-filing-document"},{"title":"Retrieve SOS filing document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /api/v2/sos-filing-documents/{id}/","href":"/api-reference/sos-reports/retrieve-sos-filing-document"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/companies/","href":"/api-reference/companies/list-companies"},{"title":"Retrieve all company info","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/companies/{id}/","href":"/api-reference/companies/retrieve-all-company-info"},{"title":"Delete company","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml delete /kyb/companies/{id}/","href":"/api-reference/companies/delete-company"},{"title":"Change company status","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/companies/{id}/change-status/","href":"/api-reference/companies/change-company-status"},{"title":"Generate company PDF","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/companies/{id}/pdf/","href":"/api-reference/companies/generate-company-pdf"},{"title":"Re-run company automation","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/companies/{id}/automation/","href":"/api-reference/companies/re-run-company-automation"}]},{"group":"KYB Forms","pages":[{"title":"List KYB forms","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/","href":"/api-reference/kyb-forms/list-kyb-forms"},{"title":"Create new KYB form","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/forms/","href":"/api-reference/kyb-forms/create-new-kyb-form"},{"title":"Retrieve KYB form info","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{id}/","href":"/api-reference/kyb-forms/retrieve-kyb-form-info"},{"title":"Update KYB form info","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml put /kyb/forms/{id}/","href":"/api-reference/kyb-forms/update-kyb-form-info"},{"title":"Partially update KYB form info","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml patch /kyb/forms/{id}/","href":"/api-reference/kyb-forms/partially-update-kyb-form-info"},{"title":"Submit KYB form","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/forms/{id}/submit/","href":"/api-reference/kyb-forms/submit-kyb-form"}]},{"group":"Beneficiaries","pages":[{"title":"List beneficiaries","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/beneficiaries/","href":"/api-reference/beneficiaries/list-beneficiaries"},{"title":"Add new beneficiary","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/forms/{companyId}/beneficiaries/","href":"/api-reference/beneficiaries/add-new-beneficiary"},{"title":"Retrieve beneficiary","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/beneficiaries/{id}/","href":"/api-reference/beneficiaries/retrieve-beneficiary"},{"title":"Update beneficiary","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml put /kyb/forms/{companyId}/beneficiaries/{id}/","href":"/api-reference/beneficiaries/update-beneficiary"},{"title":"Delete beneficiary","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml delete /kyb/forms/{companyId}/beneficiaries/{id}/","href":"/api-reference/beneficiaries/delete-beneficiary"},{"title":"Partially update beneficiary","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml patch /kyb/forms/{companyId}/beneficiaries/{id}/","href":"/api-reference/beneficiaries/partially-update-beneficiary"}]},{"group":"KYB Documents","pages":[{"title":"List beneficiary documents","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/","href":"/api-reference/kyb-documents/list-beneficiary-documents"},{"title":"Add new beneficiary document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/","href":"/api-reference/kyb-documents/add-new-beneficiary-document"},{"title":"Retrieve beneficiary document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/{id}/","href":"/api-reference/kyb-documents/retrieve-beneficiary-document"},{"title":"Update beneficiary document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml put /kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/{id}/","href":"/api-reference/kyb-documents/update-beneficiary-document"},{"title":"Delete beneficiary document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml delete /kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/{id}/","href":"/api-reference/kyb-documents/delete-beneficiary-document"},{"title":"Partially update beneficiary document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml patch /kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/{id}/","href":"/api-reference/kyb-documents/partially-update-beneficiary-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/documents/","href":"/api-reference/kyb-documents/list-documents"},{"title":"Add new document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/forms/{companyId}/documents/","href":"/api-reference/kyb-documents/add-new-document"},{"title":"Retrieve document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/documents/{id}/","href":"/api-reference/kyb-documents/retrieve-document"},{"title":"Update document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml put /kyb/forms/{companyId}/documents/{id}/","href":"/api-reference/kyb-documents/update-document"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml delete /kyb/forms/{companyId}/documents/{id}/","href":"/api-reference/kyb-documents/delete-document"},{"title":"Partially update document","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml patch /kyb/forms/{companyId}/documents/{id}/","href":"/api-reference/kyb-documents/partially-update-document"}]},{"group":"KYB Questionnaires","pages":[{"title":"List questionnaires","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/questionnaires/","href":"/api-reference/kyb-questionnaires/list-questionnaires"},{"title":"Retrieve questionnaire","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/questionnaires/{id}/","href":"/api-reference/kyb-questionnaires/retrieve-questionnaire"},{"title":"Retrieve questionnaire answers","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/questionnaires/{id}/answers/","href":"/api-reference/kyb-questionnaires/retrieve-questionnaire-answers"},{"title":"Update questionnaire answers","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml put /kyb/forms/{companyId}/questionnaires/{id}/answers/","href":"/api-reference/kyb-questionnaires/update-questionnaire-answers"},{"title":"Delete questionnaire answers","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml delete /kyb/forms/{companyId}/questionnaires/{id}/answers/","href":"/api-reference/kyb-questionnaires/delete-questionnaire-answers"},{"title":"Retrieve all questionnaires' answers","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/forms/{companyId}/questionnaires/answers/detail/","href":"/api-reference/kyb-questionnaires/retrieve-all-questionnaires-answers"}]},{"group":"KYB Token","pages":[{"title":"Retrieve KYB session info","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /kyb/info/","href":"/api-reference/kyb-token/retrieve-kyb-session-info"},{"title":"Generate KYB form token","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /kyb/tokens/","href":"/api-reference/kyb-token/generate-kyb-form-token"},{"title":"Update KYB form token","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml put /kyb/tokens/{tokenString}/","href":"/api-reference/kyb-token/update-kyb-form-token"},{"title":"Partially update KYB form token","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml patch /kyb/tokens/{tokenString}/","href":"/api-reference/kyb-token/partially-update-kyb-form-token"}]},{"group":"Registry Center Checks","pages":[{"title":"List registry center checks","deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml get /api/v2/registry-center-checks/","href":"/api-reference/registry-center-checks/list-registry-center-checks"},{"title":"Create registry center check","description":null,"deprecated":null,"version":null,"openapi":"/openapi/kyb.yaml post /api/v2/registry-center-checks/","href":"/api-reference/registry-center-checks/create-registry-center-check"}]},{"group":"Webhooks","pages":[{"title":"Company review","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyReview","href":"/api-reference/webhooks/company-review"},{"title":"Company delete","description":"This notification is sent when a company is deleted.","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyDelete","href":"/api-reference/webhooks/company-delete"},{"title":"Company aml review","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyAmlReview","href":"/api-reference/webhooks/company-aml-review"},{"title":"Company info request","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyInfoRequest","href":"/api-reference/webhooks/company-info-request"},{"title":"Company expiration","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companyExpiration","href":"/api-reference/webhooks/company-expiration"},{"title":"Company submit","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook companySubmit","href":"/api-reference/webhooks/company-submit"},{"title":"Gov ordered document","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook govOrderedDocument","href":"/api-reference/webhooks/gov-ordered-document"},{"title":"Sos report","version":null,"deprecated":null,"openapi":"/openapi/kyb.yaml webhook sosReport","href":"/api-reference/webhooks/sos-report"}]}]},{"group":"AML Screening","icon":"shield-check","pages":[{"group":"AML Checks","pages":[{"title":"Create AML check","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml post /aml/checks/","href":"/api-reference/aml-checks/create-aml-check"},{"title":"Generate AML check PDF","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml post /aml/checks/{id}/pdf/","href":"/api-reference/aml-checks/generate-aml-check-pdf"},{"title":"Retrieve AML check profile","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml get /aml/checks/{id}/profiles/{profileId}/","href":"/api-reference/aml-checks/retrieve-aml-check-profile"},{"title":"Generate AML check profile PDF","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml post /aml/checks/{id}/profiles/{profileId}/pdf/","href":"/api-reference/aml-checks/generate-aml-check-profile-pdf"}]},{"group":"AML Monitorings","pages":[{"title":"List AML monitorings","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml get /aml/monitorings/","href":"/api-reference/aml-monitorings/list-aml-monitorings"},{"title":"Create AML monitoring","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml post /aml/monitorings/","href":"/api-reference/aml-monitorings/create-aml-monitoring"},{"title":"Retrieve AML monitoring","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml get /aml/monitorings/{id}/","href":"/api-reference/aml-monitorings/retrieve-aml-monitoring"},{"title":"Delete AML monitoring","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml delete /aml/monitorings/{id}/","href":"/api-reference/aml-monitorings/delete-aml-monitoring"},{"title":"Partially update AML monitoring","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml patch /aml/monitorings/{id}/","href":"/api-reference/aml-monitorings/partially-update-aml-monitoring"},{"title":"Start/Stop AML monitoring","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml post /aml/monitorings/{id}/{action}/","href":"/api-reference/aml-monitorings/startstop-aml-monitoring"},{"title":"Generate AML Monitoring PDF","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml post /aml/monitorings/{id}/pdf/","href":"/api-reference/aml-monitorings/generate-aml-monitoring-pdf"},{"title":"Delete AML check profile","deprecated":null,"version":null,"openapi":"/openapi/aml.yaml delete /aml/monitorings/{id}/profiles/{profileId}/","href":"/api-reference/aml-monitorings/delete-aml-check-profile"}]},{"group":"Webhooks","pages":[{"title":"Aml monitoring","version":null,"deprecated":null,"openapi":"/openapi/aml.yaml webhook amlMonitoring","href":"/api-reference/webhooks/aml-monitoring"},{"title":"Aml monitoring expiration","version":null,"deprecated":null,"openapi":"/openapi/aml.yaml webhook amlMonitoringExpiration","href":"/api-reference/webhooks/aml-monitoring-expiration"}]}]},{"group":"Bank Verification","icon":"building-columns","pages":[{"group":"Bank","pages":[{"title":"Generate bank verification token","deprecated":null,"version":null,"openapi":"/openapi/bank.yaml post /bank/tokens/","href":"/api-reference/bank/generate-bank-verification-token"},{"title":"List bank verification account transactions","deprecated":null,"version":null,"openapi":"/openapi/bank.yaml get /bank/verifications/{verificationId}/accounts/{accountId}/transactions/","href":"/api-reference/bank/list-bank-verification-account-transactions"}]},{"group":"Webhooks","pages":[{"title":"Bank verification","version":null,"deprecated":null,"openapi":"/openapi/bank.yaml webhook bankVerification","href":"/api-reference/webhooks/bank-verification"},{"title":"Account check","version":null,"deprecated":null,"openapi":"/openapi/bank.yaml webhook accountCheck","href":"/api-reference/webhooks/account-check"}]}]},{"group":"Face Authentication","icon":"face-smile","pages":[{"group":"Face Auth Sessions","pages":[{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/face-authentication.yaml get /api/v2/facial-authentication-sessions/","href":"/api-reference/face-auth-sessions/list-sessions"},{"title":"Retrieve session","deprecated":null,"version":null,"openapi":"/openapi/face-authentication.yaml get /api/v2/facial-authentication-sessions/{tokenString}/","href":"/api-reference/face-auth-sessions/retrieve-session"}]},{"group":"Webhooks","pages":[{"title":"Facial authentication","version":null,"deprecated":null,"openapi":"/openapi/face-authentication.yaml webhook facialAuthentication","href":"/api-reference/webhooks/facial-authentication"}]}]},{"group":"Age Estimation","icon":"cake-candles","pages":[{"group":"Age Estimation","pages":[{"title":"Create session","deprecated":null,"version":null,"openapi":"/openapi/age-estimation.yaml post /age-estimation/token/","href":"/api-reference/age-estimation/create-session"}]},{"group":"Webhooks","pages":[{"title":"Age estimation result","version":null,"deprecated":null,"openapi":"/openapi/age-estimation.yaml webhook ageEstimationResult","href":"/api-reference/webhooks/age-estimation-result"}]}]},{"group":"Bank Card Verification","icon":"credit-card","pages":[{"group":"Bank Card Verification","pages":[{"title":"Create session","deprecated":null,"version":null,"openapi":"/openapi/bank-card.yaml post /bank-card/tokens/","href":"/api-reference/bank-card-verification/create-session"}]},{"group":"Webhooks","pages":[{"title":"Bank card verification completed","version":null,"deprecated":null,"openapi":"/openapi/bank-card.yaml webhook bankCardVerificationCompleted","href":"/api-reference/webhooks/bank-card-verification-completed"}]}]}]}]},"title":"Company review - iDenfy Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}