{ "status": "failed", "message": "Authentication credentials were not provided."}
Use this endpoint to control which steps run during the Verify Customer call. Changes apply to all subsequent onboarding requests for your branch.
Both ivs and aml are enabled by default. Disabling ivs will also cause AML screening to be skipped, since screening depends on a verified name being returned from the identity check.
Endpoint
POST /api/onboarding/settings
Request
Headers
Header
Value
Required
x-access-token
Your API key
Yes
Content-Type
application/json
Yes
Body Parameters
Parameter
Type
Required
Description
ivs
boolean
No
Enable or disable identity verification
aml
boolean
No
Enable or disable AML screening
You can update one or both settings in a single call. Omitted fields retain their current value.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Adhere by Smartcomply","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=728c06a1bc2c8bb258aa32e95598d984","dark":"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo-dark.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=7f344999eff7e329fb404dabcc810f20"},"favicon":"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=728c06a1bc2c8bb258aa32e95598d984","navbar":{"links":[{"href":"https://docs.adhere.smartcomply.com/changelog","label":"What's New"},{"href":"https://documenter.getpostman.com/view/55164637/2sBXwjxET7","label":"Postman Collection"},{"href":"https://docs.adhere.smartcomply.com/pages/support","label":"Get Help"}],"primary":{"type":"button","label":"Dashboard","href":"https://adhere-app.smartcomply.com"}},"banner":{"content":"Adhere v3 is live — faster identity verification across Nigeria, Ghana, Kenya, Rwanda \u0026 Uganda. [Explore what's new →](/introduction)","dismissible":true},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"fr","href":"fr/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smartcomply-f420ec6b","hasAudioNarration":false,"actualSubdomain":"smartcomply-f420ec6b","customDomains":["docs.smartcomply.com"],"gitSource":{"type":"github","owner":"anitajallas","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af28e49f307e97d77e8410a","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"en","tag":"API Reference","count":186},{"language":"en","tag":"Onboarding Suite","count":130},{"language":"en","tag":"KYC","count":92},{"language":"fr","tag":"Référence API","count":84},{"language":"en","tag":"Nigeria","count":77},{"language":"fr","tag":"Suite d'intégration","count":59},{"language":"en","tag":"Credit Report","count":43},{"language":"fr","tag":"KYC","count":43},{"language":"fr","tag":"Nigeria","count":33},{"language":"en","tag":"Individual","count":32},{"language":"en","tag":"Fraud \u0026 Transaction Monitoring","count":31},{"language":"en","tag":"Data Verification","count":28},{"language":"fr","tag":"Vérification des données","count":28},{"language":"en","tag":"Kenya","count":22},{"language":"fr","tag":"Rapport de crédit","count":15},{"language":"en","tag":"Document Verification","count":12},{"language":"fr","tag":"Vérification de documents","count":12},{"language":"fr","tag":"Kenya","count":11},{"language":"fr","tag":"Individuel","count":11},{"language":"fr","tag":"Fraude et surveillance des transactions","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"v3/onboarding/update_settings","slug":"/v3/onboarding/update_settings","pageMetadata":{"title":"Update Onboarding Settings","sidebarTitle":"Update Settings","description":"Enable or disable identity verification and AML screening for your branch.","openapi":"POST /api/onboarding/settings","href":"/v3/onboarding/update_settings"},"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: \"Enable or disable identity verification and AML screening for your branch.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,Note,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Use this endpoint to control which steps run during the `,_jsx(_components.a,{href:`/v3/onboarding/verify_customer`,children:`Verify Customer`}),` call. Changes apply to all subsequent onboarding requests for your branch.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Both `,_jsx(_components.code,{children:`ivs`}),` and `,_jsx(_components.code,{children:`aml`}),` are enabled by default. Disabling `,_jsx(_components.code,{children:`ivs`}),` will also cause AML screening to be skipped, since screening depends on a verified name being returned from the identity check.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /api/onboarding/settings`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(Heading,{level:`3`,id:`headers`,children:`Headers`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header`}),_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`x-access-token`})}),_jsx(_components.td,{children:`Your API key`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Content-Type`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`application/json`})}),_jsx(_components.td,{children:`Yes`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ivs`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Enable or disable identity verification`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`aml`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Enable or disable AML screening`})]})]})]}),`\n`,_jsx(_components.p,{children:`You can update one or both settings in a single call. Omitted fields retain their current value.`}),`\n`,_jsx(Heading,{level:`3`,id:`example`,children:`Example`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://adhere-api.smartcomply.com/api/onboarding/settings`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-access-token: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"aml\": false }'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://adhere-api.smartcomply.com/api/onboarding/settings\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-access-token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aml\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`False`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(response.json())`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Node.js`,numberOfLines:`9`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://adhere-api.smartcomply.com/api/onboarding/settings\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-access-token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`aml:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }),`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` data`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`\"success\"`}),` on a successful update.`]})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:_jsx(_components.code,{children:`\"Settings saved\"`})})}),`\n`,_jsxs(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:[_jsx(_components.p,{children:`The full settings state after the update.`}),_jsxs(Expandable,{title:`data fields`,defaultOpen:true,children:[_jsx(ResponseField,{name:`ivs`,type:`boolean`,id:`param-ivs`,children:_jsx(_components.p,{children:`Current state of identity verification.`})}),_jsx(ResponseField,{name:`aml`,type:`boolean`,id:`param-aml`,children:_jsx(_components.p,{children:`Current state of AML screening.`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`200-ok`,children:`200 OK`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Settings saved\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ivs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"aml\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP Status`}),_jsx(_components.th,{children:`Message`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Authorization token is missing\"`})}),_jsxs(_components.td,{children:[`No `,_jsx(_components.code,{children:`x-access-token`}),` header`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Authorization failed\"`})}),_jsx(_components.td,{children:`Token not recognised or expired`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Invalid value for ivs\"`})}),_jsx(_components.td,{children:`Value must be a boolean`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Invalid value for aml\"`})}),_jsx(_components.td,{children:`Value must be a boolean`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Onboarding Settings","sidebarTitle":"Update Settings","description":"Enable or disable identity verification and AML screening for your branch.","openapi":"POST /api/onboarding/settings","href":"/v3/onboarding/update_settings"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint","slug":"endpoint","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[{"title":"Headers","slug":"headers","depth":3,"children":[]},{"title":"Body Parameters","slug":"body-parameters","depth":3,"children":[]},{"title":"Example","slug":"example","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"200 OK","slug":"200-ok","depth":3,"children":[]},{"title":"Error Responses","slug":"error-responses","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customer Onboarding"],"summary":"Update Onboarding Settings","operationId":"updateOnboardingSettings","description":"Enable or disable identity verification and AML screening for your branch.","requestBody":"0c860847-3f7c-49fc-935d-28933ef108e3","responses":{"200":"6929e6d3-1a19-44aa-924d-e7a12c42cd35","401":"73721e33-aa19-4664-a71e-022c551fc9da"},"method":"post","type":"path","servers":["4d594af0-162a-4f85-90a5-59769137c775"],"security":["0ff7b1c0-8eb4-4bcd-a861-868cb012a971"],"path":"/api/onboarding/settings","baseUrlOptions":["https://adhere-api.smartcomply.com"],"title":"Update Onboarding Settings","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ivs":{"type":"boolean","description":"Enable or disable identity verification","uniqueKey":"ivs","typeLabel":"boolean"},"aml":{"type":"boolean","description":"Enable or disable AML screening","uniqueKey":"aml","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ivs":true,"aml":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6929e6d3-1a19-44aa-924d-e7a12c42cd35":{"description":"Settings saved","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"73721e33-aa19-4664-a71e-022c551fc9da":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"failed","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"Authentication credentials were not provided.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","message":"Authentication credentials were not provided."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0ff7b1c0-8eb4-4bcd-a861-868cb012a971":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-access-token","description":"Your Adhere API secret key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"4d594af0-162a-4f85-90a5-59769137c775":{"url":"https://adhere-api.smartcomply.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-access-token","description":"Your Adhere API secret key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-access-token","type":"string","description":"Your Adhere API secret key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-access-token"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"smartcomply-f420ec6b","siteName":"Adhere by Smartcomply","title":"Update Onboarding Settings - Adhere by Smartcomply","navMaps":{"firstHrefInVersion":{"v3":{"href":"/v3/onboarding/update_settings","matchLevel":0},"v2":{"href":"/introduction","matchLevel":2},"v1":{"href":"/introduction","matchLevel":2}},"firstHrefInLanguage":{"en":{"href":"/v3/onboarding/update_settings","matchLevel":0},"fr":{"href":"/fr/v3/onboarding/update_settings","matchLevel":1}}},"lastModified":"2026-05-24T22:29:08.244Z","originalFileLocation":"v3/onboarding/update_settings.mdx","locale":"en"},"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=\"Enable or disable identity verification and AML screening for your branch.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Adhere by Smartcomply\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Onboarding Settings - Adhere by Smartcomply\">\u003cmeta data-mint-head property=\"og:description\" content=\"Enable or disable identity verification and AML screening for your branch.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Adhere by Smartcomply\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.smartcomply.com/v3/onboarding/update_settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smartcomply-f420ec6b.mintlify.site/_mintlify/api/og/v2?division=Customer+Onboarding\u0026amp;title=Update+Onboarding+Settings\u0026amp;description=Enable+or+disable+identity+verification+and+AML+screening+for+your+branch.\u0026amp;theme=275165def0761b0b8fa8e21a\u0026amp;signature=1ffe2c3b38c61d0c07aacba77b9eff6c628e86c7cf6109ef1c6de26642e3b04d\">\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=\"Update Onboarding Settings - Adhere by Smartcomply\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Enable or disable identity verification and AML screening for your branch.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smartcomply-f420ec6b.mintlify.site/_mintlify/api/og/v2?division=Customer+Onboarding\u0026amp;title=Update+Onboarding+Settings\u0026amp;description=Enable+or+disable+identity+verification+and+AML+screening+for+your+branch.\u0026amp;theme=275165def0761b0b8fa8e21a\u0026amp;signature=1ffe2c3b38c61d0c07aacba77b9eff6c628e86c7cf6109ef1c6de26642e3b04d\">\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/smartcomply-f420ec6b/noosT1oj8RDt5iYq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Adhere by Smartcomply\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.smartcomply.com/v3/onboarding/update_settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/onboarding/update_settings.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.smartcomply.com/v3/onboarding/update_settings\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.smartcomply.com/fr/v3/onboarding/update_settings\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.smartcomply.com/v3/onboarding/update_settings\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.smartcomply.com/#organization\",\"name\":\"Adhere by Smartcomply\",\"url\":\"https://docs.smartcomply.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smartcomply-f420ec6b/jv92DPiviz1ucERE/logo/adhere-logo.png?fit=max\u0026auto=format\u0026n=jv92DPiviz1ucERE\u0026q=85\u0026s=728c06a1bc2c8bb258aa32e95598d984\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.smartcomply.com#website\",\"name\":\"Adhere by Smartcomply\",\"url\":\"https://docs.smartcomply.com\",\"publisher\":{\"@id\":\"https://docs.smartcomply.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.smartcomply.com/v3/onboarding/update_settings#webpage\",\"url\":\"https://docs.smartcomply.com/v3/onboarding/update_settings\",\"name\":\"Update Onboarding Settings\",\"description\":\"Enable or disable identity verification and AML screening for your branch.\",\"dateModified\":\"2026-05-24T22:29:08.244Z\",\"isPartOf\":{\"@id\":\"https://docs.smartcomply.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.smartcomply.com/v3/onboarding/update_settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.smartcomply.com/v3/onboarding/update_settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.smartcomply.com/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Onboarding Suite\",\"item\":\"https://docs.smartcomply.com/v3/onboarding/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Customer Onboarding\",\"item\":\"https://docs.smartcomply.com/v3/onboarding/introduction\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update Onboarding Settings\",\"item\":\"https://docs.smartcomply.com/v3/onboarding/update_settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.smartcomply.com/v3/onboarding/update_settings#apireference\",\"headline\":\"Update Onboarding Settings\",\"name\":\"Update Onboarding Settings\",\"description\":\"Enable or disable identity verification and AML screening for your branch.\",\"url\":\"https://docs.smartcomply.com/v3/onboarding/update_settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.smartcomply.com/v3/onboarding/update_settings#webpage\"},\"dateModified\":\"2026-05-24T22:29:08.244Z\",\"publisher\":{\"@id\":\"https://docs.smartcomply.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.smartcomply.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Adhere by Smartcomply\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Adhere by Smartcomply\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v3/onboarding/update_settings.md","siteName":"Adhere by Smartcomply","nav":{"global":null,"languages":[{"language":"en","default":true,"versions":[{"version":"v3","groups":[{"group":"API Reference","pages":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Error Codes","href":"/error_codes"},{"title":"Webhooks","href":"/webhooks"},{"title":"Changelog","sidebarTitle":"What's New","href":"/changelog"}]},{"group":"Common Use Cases","pages":[{"title":"Account \u0026 Identity Verification","sidebarTitle":"Account Verification","href":"/pages/account_verification"},{"title":"Lending \u0026 Loan Decisioning","sidebarTitle":"Lending","href":"/pages/lending"}]},{"group":"Libraries \u0026 Tools","pages":[{"title":"Web SDK","href":"/libraries/smartcomply_sdk"},{"title":"Android SDK","href":"/libraries/android_sdk"},{"title":"iOS SDK","href":"/libraries/ios_sdk"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/libraries/postman"}]},{"group":"Biometrics","pages":[{"title":"Face Comparison","sidebarTitle":"Face Comparison","openapi":"POST /api/onboarding/biometrics/face/comparison","href":"/v3/biometrics/face_comparism"},{"title":"Face Liveness Check","sidebarTitle":"Face Liveness","openapi":"POST /api/onboarding/biometrics/face/liveliness_check/","href":"/v3/biometrics/face_liveliness"}]},{"group":"Onboarding Suite","pages":[{"group":"Customer Onboarding","pages":[{"title":"Customer Onboarding","sidebarTitle":"Overview","href":"/v3/onboarding/introduction"},{"title":"Verify Customer","sidebarTitle":"Verify Customer","openapi":"POST /api/onboarding/verify_customer","href":"/v3/onboarding/verify_customer"},{"title":"Get Onboarding Settings","sidebarTitle":"Get Settings","description":"Retrieve the current identity verification and AML screening settings for your branch.","openapi":"GET /api/onboarding/settings","href":"/v3/onboarding/get_settings"},{"title":"Update Onboarding Settings","sidebarTitle":"Update Settings","openapi":"POST /api/onboarding/settings","href":"/v3/onboarding/update_settings"}]},{"group":"KYC","pages":[{"group":"Data Verification","pages":[{"group":"Nigeria","pages":[{"title":"Bank Verification Number (BVN)","sidebarTitle":"BVN","description":"Verify a customer's identity using their 11-digit Bank Verification Number.","openapi":"POST /api/onboarding/nigeria_kyc/bvn/","href":"/v3/kyc/nigeria/BVN"},{"title":"Bank Verification Number Advanced (BVN)","sidebarTitle":"BVN Advanced","openapi":"POST /api/onboarding/nigeria_kyc/bvn_advanced/","href":"/v3/kyc/nigeria/BVN_Advanced"},{"title":"Corporate Affairs Commission (CAC)","sidebarTitle":"CAC","openapi":"POST /api/onboarding/nigeria_kyc/cac/","href":"/v3/kyc/nigeria/CAC"},{"title":"CAC Advanced","sidebarTitle":"CAC Advanced","openapi":"POST /api/onboarding/nigeria_kyc/cac_advanced/","href":"/v3/kyc/nigeria/CAC_Advanced"},{"title":"Company Tax ID","sidebarTitle":"Company Tax ID","openapi":"POST /api/onboarding/business/company_tax_id/","href":"/v3/kyc/nigeria/company_tax_id"},{"title":"Driver's License","sidebarTitle":"Driver's License","openapi":"POST /api/onboarding/nigeria_kyc/driver_license/","href":"/v3/kyc/nigeria/Drivers_License"},{"title":"National Identity Number (NIN)","sidebarTitle":"NIN","openapi":"POST /api/onboarding/nigeria_kyc/nin/","href":"/v3/kyc/nigeria/nin"},{"title":"NIN with Face","sidebarTitle":"NIN with Face","openapi":"POST /api/onboarding/nigeria_kyc/nin_with_face/","href":"/v3/kyc/nigeria/nin_with_face"},{"title":"NUBAN Verification","sidebarTitle":"NUBAN","openapi":"POST /api/onboarding/nigeria_kyc/nuban/","href":"/v3/kyc/nigeria/nuban"},{"title":"NUBAN Advanced","sidebarTitle":"NUBAN Advanced","openapi":"POST /api/onboarding/nigeria_kyc/nuban_advanced/","href":"/v3/kyc/nigeria/nuban_advanced"},{"title":"Passport Verification","sidebarTitle":"Passport","openapi":"POST /api/onboarding/nigeria_kyc/passport/","href":"/v3/kyc/nigeria/passport_verification"},{"title":"Phone Number Advanced","sidebarTitle":"Phone Number Advanced","openapi":"POST /api/onboarding/nigeria_kyc/phone_no_advanced/","href":"/v3/kyc/nigeria/Phone_Number_Advanced"},{"title":"Phone Number Basic","sidebarTitle":"Phone Number Basic","openapi":"POST /api/onboarding/nigeria_kyc/phone_no_basic/","href":"/v3/kyc/nigeria/phone_number_basic"},{"title":"Company TIN","sidebarTitle":"Company TIN","openapi":"POST /api/onboarding/nigeria_kyc/tin/","href":"/v3/kyc/nigeria/tin"},{"title":"Virtual NIN (VNIN)","sidebarTitle":"VNIN","openapi":"POST /api/onboarding/nigeria_kyc/vnin/","href":"/v3/kyc/nigeria/VNIN"},{"title":"Voter's ID","sidebarTitle":"Voter's ID","openapi":"POST /api/onboarding/nigeria_kyc/voters_id/","href":"/v3/kyc/nigeria/Voters_ID"}]},{"group":"Kenya","pages":[{"title":"National ID Basic","sidebarTitle":"National ID Basic","openapi":"POST /api/onboarding/kenya_kyc/national_id_basic/","href":"/v3/kyc/kenya/national_id_basic"},{"title":"National ID Advanced","sidebarTitle":"National ID Advanced","openapi":"POST /api/onboarding/kenya_kyc/national_id_advance/","href":"/v3/kyc/kenya/national_id_advance"},{"title":"Business Registration","sidebarTitle":"Business Registration","openapi":"POST /api/onboarding/kenya_kyc/business_registration/","href":"/v3/kyc/kenya/business_registration"},{"title":"Alien ID","sidebarTitle":"Alien ID","openapi":"POST /api/onboarding/kenya_kyc/alien_id/","href":"/v3/kyc/kenya/alien_ID"},{"title":"KRA PIN","sidebarTitle":"KRA PIN","openapi":"POST /api/onboarding/kenya_kyc/kra_pin/","href":"/v3/kyc/kenya/kra_pin"},{"title":"Kenya Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/kenya_kyc/passport/","href":"/v3/kyc/kenya/Passport_Verification"},{"title":"Driver's License","sidebarTitle":"Driver's License","openapi":"POST /api/onboarding/kenya_kyc/drivers_license/","href":"/v3/kyc/kenya/Drivers_License"}]},{"group":"Ghana","pages":[{"title":"Ghana ID Card","sidebarTitle":"ID Card","openapi":"POST /api/onboarding/ghana_kyc/id_card/","href":"/v3/kyc/ghana/ID_Card"},{"title":"Ghana ID Card Advanced","sidebarTitle":"ID Card Advanced","openapi":"POST /api/onboarding/ghana_kyc/id_card_with_face/","href":"/v3/kyc/ghana/ID_Card_with_face"},{"title":"International Passport","sidebarTitle":"International Passport","openapi":"POST /api/onboarding/ghana_kyc/international_passport/","href":"/v3/kyc/ghana/International_Passport"}]},{"group":"Cote d'Ivoire","pages":[{"title":"National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/cote_divoire_kyc/national_id/","href":"/v3/kyc/cote_d_ivoire/National_ID"}]},{"group":"South Africa","pages":[{"title":"National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/south_africa_kyc/national_id/","href":"/v3/kyc/south_africa/National_ID"}]}]},{"group":"Document Verification","pages":[{"group":"Global","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/passport","href":"/v3/kyc/document_verification/global/Passport"}]},{"group":"Nigeria","pages":[{"title":"National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/document_verification/nigeria/national_id","href":"/v3/kyc/document_verification/nigeria/National_ID"},{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/nigeria/passport","href":"/v3/kyc/document_verification/nigeria/Passport"},{"title":"Driver's License","sidebarTitle":"Driver's License","openapi":"POST /api/onboarding/document_verification/nigeria/drivers_license","href":"/v3/kyc/document_verification/nigeria/Drivers_License"},{"title":"Voter's Card","sidebarTitle":"Voter's Card","openapi":"POST /api/onboarding/document_verification/nigeria/voters_card","href":"/v3/kyc/document_verification/nigeria/Voters_Card"}]},{"group":"Kenya","pages":[{"title":"Kenya National ID","sidebarTitle":"National ID","openapi":"POST /api/onboarding/document_verification/kenya/kenya_id","href":"/v3/kyc/document_verification/kenya/Kenya_ID"},{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/kenya/passport","href":"/v3/kyc/document_verification/kenya/Passport"}]},{"group":"Ghana","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/ghana/passport","href":"/v3/kyc/document_verification/ghana/Passport"}]},{"group":"Canada","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/canada/passport","href":"/v3/kyc/document_verification/canada/Passport"}]},{"group":"USA","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/usa/passport","href":"/v3/kyc/document_verification/usa/Passport"}]},{"group":"Cote d'Ivoire","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/cote_d_ivoire/passport","href":"/v3/kyc/document_verification/cote_d_ivoire/Passport"}]},{"group":"UK","pages":[{"title":"Passport","sidebarTitle":"Passport","openapi":"POST /api/onboarding/document_verification/uk/passport","href":"/v3/kyc/document_verification/uk/Passport"}]}]}]},{"group":"Credit Report","pages":[{"group":"Nigeria","pages":[{"group":"Business","pages":[{"title":"CRC Business Credit History","sidebarTitle":"CRC Credit History","openapi":"POST /api/onboarding/business/crc/","href":"/v3/credit/business/crc-business_credit_history"},{"title":"First Central Business Credit History","sidebarTitle":"First Central History","openapi":"POST /api/onboarding/business/first_central/","href":"/v3/credit/business/first-central_business_credit_history"},{"title":"Premium Business Credit History","sidebarTitle":"Premium Credit History","openapi":"POST /api/onboarding/business/premium/","href":"/v3/credit/business/premium_business_credit_history"}]},{"group":"Individual","pages":[{"title":"First Central Credit Summary","sidebarTitle":"First Central Summary","openapi":"POST /api/onboarding/individual/first_central_summary/","href":"/v3/credit/individual/First_Central_Credit_Summary"},{"title":"First Central Full Credit Report","sidebarTitle":"First Central Full Report","openapi":"POST /api/onboarding/individual/first_central_full/","href":"/v3/credit/individual/First_Central_Full_Credit_Report"},{"title":"Credit Registry Credit Summary","sidebarTitle":"CRC Credit Summary","openapi":"POST /api/onboarding/individual/credit_registry_summary/","href":"/v3/credit/individual/Credit_Registry_Credit_Summary"},{"title":"Credit Registry Full Credit Report","sidebarTitle":"CRC Full Credit Report","openapi":"POST /api/onboarding/individual/credit_registry_full/","href":"/v3/credit/individual/Credit_Registry_Full_Credit_Report"},{"title":"Premium Individual Credit Report","sidebarTitle":"Premium Credit Report","openapi":"POST /api/onboarding/individual/premium/","href":"/v3/credit/individual/Credit_Report_Premium"},{"title":"First Central Credit Score","sidebarTitle":"First Central Score","openapi":"POST /api/onboarding/individual/credit_scores_first_central/","href":"/v3/credit/individual/First_Central_Credit_Score"},{"title":"CRC Credit Score","sidebarTitle":"CRC Credit Score","openapi":"POST /api/onboarding/individual/credit_scores_crc/","href":"/v3/credit/individual/CRC_Credit_Score"},{"title":"CRC Credit History","sidebarTitle":"CRC Credit History","openapi":"POST /api/onboarding/individual/crc_summary/","href":"/v3/credit/individual/CRC_Credit_History"},{"title":"CRC Full Credit Report","sidebarTitle":"CRC Full Report","openapi":"POST /api/onboarding/individual/crc_full/","href":"/v3/credit/individual/CRC_full_credit_report"},{"title":"Credit Registry History Advanced","sidebarTitle":"CRC History Advanced","openapi":"POST /api/onboarding/individual/credit_registry_history_advanced/","href":"/v3/credit/individual/Credt_Registry_History_Advanced"}]}]},{"group":"Kenya","pages":[{"group":"Individual","pages":[{"title":"Kenya Individual Credit Report","sidebarTitle":"Kenya Credit Report","openapi":"POST /api/onboarding/kenya/individual_credit/","href":"/v3/credit/individual/Kenya_Individual_Credit"}]},{"group":"Business","pages":[{"title":"Kenya Business Credit Report","sidebarTitle":"Kenya Credit Report","openapi":"POST /api/onboarding/kenya/company_credit/","href":"/v3/credit/business/Kenya_Business_Credit"}]}]}]}]},{"group":"Fraud \u0026 Transaction Monitoring","pages":[{"group":"Transaction Monitoring","pages":[{"title":"Transaction Monitoring","sidebarTitle":"Overview","href":"/v3/transaction/transaction_monitoring/transaction_monitoring_overview"},{"title":"Submit Transaction for Monitoring","sidebarTitle":"Submit Transaction","href":"/v3/transaction/transaction_monitoring/post_transaction_request"},{"title":"User Journey Tracking","sidebarTitle":"User Journey","openapi":"POST /api/v1/journey/event/","href":"/v3/transaction/transaction_monitoring/user_journey"}]},{"group":"Transaction Screening","pages":[{"title":"Transaction Screening","sidebarTitle":"Overview","href":"/v3/transaction/transaction_screening/overview"},{"title":"Screen a Transaction","sidebarTitle":"Screen Transaction","openapi":"POST /api/v1/monitoring/transaction_screening","href":"/v3/transaction/transaction_screening/post_transaction_screening"}]},{"group":"KYC","pages":[{"title":"Get All KYC Search Results","sidebarTitle":"Get All KYC Results","openapi":"GET /api/v1/monitoring/kyc_search/","href":"/v3/transaction/kyc/get_all_search_results"},{"title":"Get KYC Result by ID","sidebarTitle":"Get KYC by ID","openapi":"GET /api/v1/monitoring/kyc_search/{id}/","href":"/v3/transaction/kyc/get_entity_kyc_by_id"},{"title":"Run KYC Check","sidebarTitle":"Run KYC Check","openapi":"POST /api/v1/monitoring/kyc_search/","href":"/v3/transaction/kyc/post_kyc_check"}]}]},{"group":"Loan Fraud Check","pages":[{"title":"Loan Fraud Check — Overview","sidebarTitle":"Overview","href":"/v3/loan/introduction"},{"title":"Individual Loan Fraud Check","sidebarTitle":"Individual Fraud Check","openapi":"POST /api/v1/loan/fraud_check/","href":"/v3/loan/individual_fraud_check"},{"title":"Business Loan Fraud Check","sidebarTitle":"Business Fraud Check","openapi":"POST /api/v1/loan/fraud_check/","href":"/v3/loan/business_fraud_check"}]}]}]},{"version":"v2","pages":[{"title":"v2","href":"/introduction"}]},{"version":"v1","pages":[{"title":"v1","href":"/introduction"}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/v3/onboarding/update_settings"}]}]},"basePath":"","title":"Update Onboarding Settings - Adhere by Smartcomply","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BOAJk9BH.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js"]}