This endpoint always requires x-api-key. The email is normalized before lookup, and needKyc defaults to true.
Testing in Sandbox? Pass needKyc: false and skip identity verification entirely. The KYC flow
is a Sumsub verification with document upload, not something you need to prove your integration
works, and every test investor you create without it is one less manual step in your loop.Rehearse the real KYC flow once before you go live, since needKyc: false is rejected in
production with needKyc=false is only available in the sandbox environment.
This operation can create an investor account and send an invitation email. The returned Sumsub URL grants access to a verification flow; do not log it, commit it, or expose it to another user.
When needKyc is false, the investor is created without a KYC requirement and url is null.
A wallet address is set once. If the investor already has a different address on file, the call is
rejected with Investor <email> is already associated with a different wallet address rather than
overwriting it. Preparing a whitelist transaction
also attaches the address when the record does not yet have one.
Confirm the result with GET /get-investor-info, which returns walletAddress and
complianceStatus. A complianceStatus of NOT_REQUIRED together with a non-null walletAddress
is a ready-to-invest test investor.
needKyc is only applied when the investor record is created. For an email that already has an
account, the stored value wins and cannot be downgraded — use a fresh address, such as a + alias.
Optional. Investor wallet address. It is attached to the investor record when that record does not already have one. A different stored address is rejected rather than replaced.
Sumsub verification URL. Null when KYC is not required. Treat this value as sensitive.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Brickken Documentation","colors":{"primary":"#4C82df","light":"#4C82df","dark":"#4C82df"},"logo":{"light":"https://mintcdn.com/brickken/UYpLPKOSKNI6CnjX/logo/light.svg?fit=max\u0026auto=format\u0026n=UYpLPKOSKNI6CnjX\u0026q=85\u0026s=192d7d8eaa4997ed5fe5ebf73e4e6aee","dark":"https://mintcdn.com/brickken/UYpLPKOSKNI6CnjX/logo/dark.svg?fit=max\u0026auto=format\u0026n=UYpLPKOSKNI6CnjX\u0026q=85\u0026s=a65d0b5432e2917c02ee6ed31984af6f"},"favicon":"https://mintcdn.com/brickken/UYpLPKOSKNI6CnjX/favicon.svg?fit=max\u0026auto=format\u0026n=UYpLPKOSKNI6CnjX\u0026q=85\u0026s=51afb98395641cf97bb79fb30a48d4b1","navbar":{"links":[{"href":"https://docs.brickken.com/get-started/request-api-key","label":"Get an API key"},{"href":"mailto:support@brickken.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dapp.brickken.com/en/dashboard/home"}},"footer":{"socials":{"x":"https://x.com/brickken","instagram":"https://www.instagram.com/brickken","facebook":"https://www.facebook.com/Brickken","linkedin":"https://www.linkedin.com/company/brickken","youtube":"https://www.youtube.com/@Brickken","discord":"https://discord.com/invite/FBsBVsBqxV"}},"contextual":{"options":[{"title":"Documentation","description":"Open the Brickken documentation home.","icon":"book-open-cover","href":"https://docs.brickken.com"},{"title":"Community","description":"Join the Brickken community on Discord.","icon":"discord","href":"https://discord.com/invite/brickken-official-community-851756929268056086"},{"title":"Blog","description":"Read the Brickken blog.","icon":"newspaper","href":"https://www.brickken.com/blog"}],"display":"toc"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Authentication","icon":"key","href":"/get-started/authentication"},{"anchor":"Request an API key","icon":"envelope","href":"/get-started/request-api-key"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brickken","hasAudioNarration":false,"actualSubdomain":"brickken","customDomains":["docs.brickken.com"],"gitSource":{"type":"github","owner":"fbrickken","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6a9844f4157c701ea07b7cc9","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Agentic API","count":36},{"language":"default","tag":"Dapp API","count":34},{"language":"default","tag":"SDK","count":14},{"language":"default","tag":"Prepare Transactions","count":13},{"language":"default","tag":"Read Endpoints","count":13},{"language":"default","tag":"CLI","count":13},{"language":"default","tag":"RAMS Mandates (ERC-8226)","count":11},{"language":"default","tag":"Overview","count":8},{"language":"default","tag":"Get Started","count":8},{"language":"default","tag":"Guides","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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/create-kyc-link","slug":"/api-reference/endpoint/create-kyc-link","pageMetadata":{"title":"Create KYC Link","openapi":"POST /create-kyc-link","description":"Create or reuse an investor and return a Sumsub verification link.","href":"/api-reference/endpoint/create-kyc-link"},"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: \"Create or reuse an investor and return a Sumsub verification link.\"\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`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Tab,Table,Tabs,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This endpoint always requires `,_jsx(_components.code,{children:`x-api-key`}),`. The email is normalized before lookup, and `,_jsx(_components.code,{children:`needKyc`}),` defaults to `,_jsx(_components.code,{children:`true`}),`.`]}),`\n`,_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Testing in Sandbox?`}),` Pass `,_jsx(_components.code,{children:`needKyc: false`}),` and skip identity verification entirely. The KYC flow\nis a Sumsub verification with document upload, not something you need to prove your integration\nworks, and every test investor you create without it is one less manual step in your loop.`]}),_jsxs(_components.p,{children:[`Rehearse the real KYC flow once before you go live, since `,_jsx(_components.code,{children:`needKyc: false`}),` is rejected in\nproduction with `,_jsx(_components.code,{children:`needKyc=false is only available in the sandbox environment`}),`.`]})]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`This operation can create an investor account and send an invitation email. The returned Sumsub URL grants access to a verification flow; do not log it, commit it, or expose it to another user.`})}),`\n`,_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`needKyc`}),` is `,_jsx(_components.code,{children:`false`}),`, the investor is created without a KYC requirement and `,_jsx(_components.code,{children:`url`}),` is `,_jsx(_components.code,{children:`null`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`fields`,children:`Fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Notes`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`email`})}),_jsx(_components.td,{children:`yes`}),_jsx(_components.td,{children:`Normalized to lowercase before lookup`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`needKyc`})}),_jsx(_components.td,{children:`no`}),_jsxs(_components.td,{children:[`Defaults to `,_jsx(_components.code,{children:`true`}),`. `,_jsx(_components.code,{children:`false`}),` creates the investor with no KYC requirement, and is accepted in Sandbox only`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`walletAddress`})}),_jsx(_components.td,{children:`no`}),_jsx(_components.td,{children:`The investor’s wallet, as a valid EVM address`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tokenSymbol`})}),_jsx(_components.td,{children:`no`}),_jsx(_components.td,{children:`Scopes the investor to a tokenized asset`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`attach-the-wallet-address`,children:`Attach the wallet address`}),`\n`,_jsxs(_components.p,{children:[`An investor record with no wallet address cannot invest. Pass `,_jsx(_components.code,{children:`walletAddress`}),` here so the record is\ncomplete from the start:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,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:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"investor@example.com\"`}),_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:` \"needKyc\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"walletAddress\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0x1111111111111111111111111111111111111111\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A wallet address is set once. If the investor already has a different address on file, the call is\nrejected with `,_jsx(_components.code,{children:`Investor \u003cemail> is already associated with a different wallet address`}),` rather than\noverwriting it. Preparing a `,_jsx(_components.a,{href:`/api-reference/endpoint/prepare-whitelist`,children:_jsx(_components.code,{children:`whitelist`})}),` transaction\nalso attaches the address when the record does not yet have one.`]})}),`\n`,_jsxs(_components.p,{children:[`Confirm the result with `,_jsx(_components.code,{children:`GET /get-investor-info`}),`, which returns `,_jsx(_components.code,{children:`walletAddress`}),` and\n`,_jsx(_components.code,{children:`complianceStatus`}),`. A `,_jsx(_components.code,{children:`complianceStatus`}),` of `,_jsx(_components.code,{children:`NOT_REQUIRED`}),` together with a non-null `,_jsx(_components.code,{children:`walletAddress`}),`\nis a ready-to-invest test investor.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`needKyc`}),` is only applied when the investor record is created. For an email that already has an\naccount, the stored value wins and cannot be downgraded — use a fresh address, such as a `,_jsx(_components.code,{children:`+`}),` alias.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`client-examples`,children:`Client examples`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`walletAddress`}),` and `,_jsx(_components.code,{children:`tokenSymbol`}),` are currently available through the API only; the CLI, MCP and SDK\nclients still accept `,_jsx(_components.code,{children:`email`}),` and `,_jsx(_components.code,{children:`needKyc`}),`.`]}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`CLI`,id:`cli`,children:_jsx(CodeBlock,{filename:``,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:`brickken`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` kyc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create-link`}),_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:` --email`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` investor@example.com`}),_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:` --need-kyc`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` true`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`})}),`\n`]})})})}),_jsx(Tab,{title:`MCP`,id:`mcp`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`7`,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:`7`,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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"create_kyc_link\"`}),_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:` \"arguments\"`}),_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:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"investor@example.com\"`}),_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:` \"needKyc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\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`]})})})}),_jsx(Tab,{title:`SDK`,id:`sdk`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`typescript`,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:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`4`,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:` result`}),_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:` bkn`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`kyc`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`createLink`}),_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:` email:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'investor@example.com'`}),_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:` needKyc:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` true`}),_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:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,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:`9`,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:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"investor@example.com\"`}),_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:` \"needKyc\"`}),_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:` \"userCreated\"`}),_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:` \"invitationSent\"`}),_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:` \"tokenSymbol\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_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:` \"walletAddress\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0x1111111111111111111111111111111111111111\"`}),_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:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://in.sumsub.com/...\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}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":"Create KYC Link","openapi":"POST /create-kyc-link","description":"Create or reuse an investor and return a Sumsub verification link.","href":"/api-reference/endpoint/create-kyc-link"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Fields","slug":"fields","depth":2,"children":[{"title":"Attach the wallet address","slug":"attach-the-wallet-address","depth":3,"children":[]}]},{"title":"Client examples","slug":"client-examples","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createKycLink","summary":"Create a KYC link","tags":["KYC"],"description":"Create or reuse an investor and return a Sumsub verification link.","security":["da550d12-edf8-4cbc-9199-2d8df90b2e57"],"requestBody":"a03e21db-a34a-4a85-b15a-2739de7197d8","responses":{"200":"295b8a9d-8dec-42a1-990c-7a675f143247","400":"9e8b50db-0df4-44f4-a3b9-21bac437ad5c","401":"fcb45664-c962-43c4-88e1-8586034b8764","403":"cd06caaa-79f3-4cc1-9be6-d3d4832f8e30"},"method":"post","type":"path","servers":["c49d4b74-8565-45d3-9488-a1db87f8218a","d17a9f2b-96ea-4c3e-a855-b25208a2a781"],"path":"/create-kyc-link","baseUrlOptions":["https://api.sandbox.brickken.com","https://api.brickken.com"],"title":"Create a KYC link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"needKyc":{"type":"boolean","default":true,"uniqueKey":"needKyc","typeLabel":"boolean"},"walletAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Optional. Investor wallet address. It is attached to the investor record when that record does not already have one. A different stored address is rejected rather than replaced.","uniqueKey":"walletAddress","typeLabel":"string"},"tokenSymbol":{"type":"string","description":"Optional. Tokenized asset the investor is scoped to.","uniqueKey":"tokenSymbol","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"email":"investor@example.com","needKyc":true,"walletAddress":"0x1111111111111111111111111111111111111111"},"examples":{"Example":{"title":"Example","value":{"email":"investor@example.com","needKyc":true,"walletAddress":"0x1111111111111111111111111111111111111111"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"295b8a9d-8dec-42a1-990c-7a675f143247":{"description":"Investor access resolved and invitation state returned.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"required":["email","needKyc","userCreated","invitationSent","tokenSymbol","walletAddress","url"],"properties":{"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"needKyc":{"type":"boolean","isRequired":true,"uniqueKey":"needKyc","typeLabel":"boolean"},"userCreated":{"type":"boolean","isRequired":true,"uniqueKey":"userCreated","typeLabel":"boolean"},"invitationSent":{"type":"boolean","isRequired":true,"uniqueKey":"invitationSent","typeLabel":"boolean"},"tokenSymbol":{"oneOf":[{"type":"string","description":"Tokenized asset the investor is scoped to, or null.","isRequired":true,"uniqueKey":"tokenSymbol.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tokenized asset the investor is scoped to, or null.","isRequired":true,"uniqueKey":"tokenSymbol.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tokenSymbol","typeLabel":"string | null"},"walletAddress":{"oneOf":[{"type":"string","description":"Investor wallet address on record, or null when none is set.","isRequired":true,"uniqueKey":"walletAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Investor wallet address on record, or null when none is set.","isRequired":true,"uniqueKey":"walletAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"walletAddress","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","format":"uri","description":"Sumsub verification URL. Null when KYC is not required. Treat this value as sensitive.","isRequired":true,"uniqueKey":"url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Sumsub verification URL. Null when KYC is not required. Treat this value as sensitive.","isRequired":true,"uniqueKey":"url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"jsmith@example.com","needKyc":true,"userCreated":true,"invitationSent":true,"tokenSymbol":"\u003cstring>","walletAddress":"\u003cstring>","url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9e8b50db-0df4-44f4-a3b9-21bac437ad5c":{"description":"Invalid email, invalid needKyc value, or unsupported user.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fcb45664-c962-43c4-88e1-8586034b8764":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"cd06caaa-79f3-4cc1-9be6-d3d4832f8e30":{"description":"The API key is not authorized to access an existing user.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"da550d12-edf8-4cbc-9199-2d8df90b2e57":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"c49d4b74-8565-45d3-9488-a1db87f8218a":{"url":"https://api.sandbox.brickken.com","description":"Sandbox Environment"},"d17a9f2b-96ea-4c3e-a855-b25208a2a781":{"url":"https://api.brickken.com","description":"Production Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"brickken","siteName":"Brickken Documentation","title":"Create KYC Link - Brickken Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-02T15:15:44.073Z","originalFileLocation":"api-reference/endpoint/create-kyc-link.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=\"Create or reuse an investor and return a Sumsub verification link.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Brickken 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/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_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/brickken/7zynTh_4u-m-NSjz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create KYC Link - Brickken Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create or reuse an investor and return a Sumsub verification link.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Brickken Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brickken.mintlify.site/_mintlify/api/og/v2?division=KYC\u0026amp;title=Create+KYC+Link\u0026amp;description=Create+or+reuse+an+investor+and+return+a+Sumsub+verification+link.\u0026amp;theme=a1bd983e53c819ae00b958cb\u0026amp;signature=5c558ac2d7277b6fbcb478fe7f68fba2c3cf22d3237bdff719070d8abbedee70\">\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=\"Create KYC Link - Brickken Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create or reuse an investor and return a Sumsub verification link.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brickken.mintlify.site/_mintlify/api/og/v2?division=KYC\u0026amp;title=Create+KYC+Link\u0026amp;description=Create+or+reuse+an+investor+and+return+a+Sumsub+verification+link.\u0026amp;theme=a1bd983e53c819ae00b958cb\u0026amp;signature=5c558ac2d7277b6fbcb478fe7f68fba2c3cf22d3237bdff719070d8abbedee70\">\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/brickken/7zynTh_4u-m-NSjz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Brickken Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4C82df\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/create-kyc-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brickken.com/#organization\",\"name\":\"Brickken Documentation\",\"url\":\"https://docs.brickken.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brickken/UYpLPKOSKNI6CnjX/logo/light.svg?fit=max\u0026auto=format\u0026n=UYpLPKOSKNI6CnjX\u0026q=85\u0026s=192d7d8eaa4997ed5fe5ebf73e4e6aee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brickken.com#website\",\"name\":\"Brickken Documentation\",\"url\":\"https://docs.brickken.com\",\"publisher\":{\"@id\":\"https://docs.brickken.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link#webpage\",\"url\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link\",\"name\":\"Create KYC Link\",\"description\":\"Create or reuse an investor and return a Sumsub verification link.\",\"dateModified\":\"2026-09-02T15:15:44.073Z\",\"isPartOf\":{\"@id\":\"https://docs.brickken.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Brickken Documentation\",\"item\":\"https://docs.brickken.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create KYC Link\",\"item\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link#apireference\",\"headline\":\"Create KYC Link\",\"name\":\"Create KYC Link\",\"description\":\"Create or reuse an investor and return a Sumsub verification link.\",\"url\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brickken.com/api-reference/endpoint/create-kyc-link#webpage\"},\"dateModified\":\"2026-09-02T15:15:44.073Z\",\"publisher\":{\"@id\":\"https://docs.brickken.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brickken.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Brickken Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Brickken Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/create-kyc-link.md","siteName":"Brickken Documentation","nav":{"global":{"anchors":[{"anchor":"Authentication","icon":"key","href":"/get-started/authentication"},{"anchor":"Request an API key","icon":"envelope","href":"/get-started/request-api-key"}]},"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Dapp API","groups":[{"group":"Overview","pages":[{"title":"Dapp API","href":"/api-reference/introduction"},{"title":"Postman Collection","icon":"download","href":"/api-reference/postman"}]},{"group":"Guides","pages":[{"title":"Tokenize an asset and run an STO","icon":"route","href":"/api-reference/guides/tokenize-and-run-an-sto"},{"title":"Browser wallets","icon":"wallet","href":"/api-reference/guides/browser-wallets"},{"title":"Troubleshooting","icon":"stethoscope","href":"/api-reference/guides/troubleshooting"}]},{"group":"Prepare Transactions","pages":[{"title":"Prepare Transactions","openapi":"api-reference/openapi.json POST /prepare-transactions","href":"/api-reference/endpoint/create"},{"title":"newTokenization","openapi":"api-reference/prepare/newTokenization.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-newTokenization"},{"title":"mintToken","openapi":"api-reference/prepare/mintToken.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-mintToken"},{"title":"whitelist","openapi":"api-reference/prepare/whitelist.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-whitelist"},{"title":"burnToken","openapi":"api-reference/prepare/burnToken.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-burnToken"},{"title":"transferFrom","openapi":"api-reference/prepare/transferFrom.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-transferFrom"},{"title":"transferTo","openapi":"api-reference/prepare/transferTo.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-transferTo"},{"title":"approve","openapi":"api-reference/prepare/approve.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-approve"},{"title":"dividendDistribution","openapi":"api-reference/prepare/dividendDistribution.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-dividendDistribution"},{"title":"newSto","openapi":"api-reference/prepare/newSto.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-newSto"},{"title":"newInvest","openapi":"api-reference/prepare/newInvest.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-newInvest"},{"title":"claimTokens","openapi":"api-reference/prepare/claimTokens.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-claimTokens"},{"title":"closeOffer","openapi":"api-reference/prepare/closeOffer.json POST /prepare-transactions","href":"/api-reference/endpoint/prepare-closeOffer"}]},{"group":"Send Transactions","pages":[{"title":"Send Transactions","openapi":"POST /send-transactions","href":"/api-reference/endpoint/send"}]},{"group":"Read Endpoints","pages":[{"title":"Get Network Information","openapi":"GET /get-network-info","href":"/api-reference/endpoint/get-network-info"},{"title":"Get Tokenizer Information","openapi":"GET /get-tokenizer-info","href":"/api-reference/endpoint/get-tokenizer-info"},{"title":"Get Token Information","openapi":"GET /get-token-info","href":"/api-reference/endpoint/get-token-info"},{"title":"Get STOs","openapi":"GET /get-stos","href":"/api-reference/endpoint/get-stos"},{"title":"Get STO by ID","openapi":"GET /get-sto-by-id","href":"/api-reference/endpoint/get-sto-by-id"},{"title":"Get STO Balance","openapi":"GET /get-sto-balance","href":"/api-reference/endpoint/get-sto-balance"},{"title":"Get Investments by STO","openapi":"GET /get-investments-by-sto-id","href":"/api-reference/endpoint/get-investments-by-sto"},{"title":"Get Investor Information","openapi":"GET /get-investor-info","href":"/api-reference/endpoint/get-investors-info"},{"title":"Get Whitelist Status","openapi":"GET /get-whitelist-status","href":"/api-reference/endpoint/get-whitelist-status"},{"title":"Get Balance and Whitelist Status","openapi":"GET /get-balance-whitelist","href":"/api-reference/endpoint/get-balance-whitelist"},{"title":"Get Allowance","openapi":"GET /get-allowance","href":"/api-reference/endpoint/get-allowance"},{"title":"Get Dividend Distribution Info","openapi":"GET /get-dividend-distribution","href":"/api-reference/endpoint/get-dividend-distribution"},{"title":"Get Transaction Status","openapi":"GET /get-transaction-status","href":"/api-reference/endpoint/get-transaction-status"}]},{"group":"Token Documents","pages":[{"title":"Update Token Documentation","openapi":"PATCH /patch-token-docs","description":"**Description:** This endpoint allows you to update token-related documentation and branding materials. It is fully off-chain and does not prepare or require a blockchain transaction.\n\n**Headers:**\n- `x-api-key`: `YOUR_API_KEY`\n\n**Request Format:**\nThis endpoint accepts `multipart/form-data` input, which should include:\n- `tokenSymbol` (text)\n- `tokenLogotype` (image file) - optional\n- `subscriptionAgreement` (PDF file) - optional\n- `legalDocs` (PDF file) - optional\n\n**What the endpoint does:**\n- The `tokenLogotype` is uploaded to S3.\n- The `subscriptionAgreement` and `legalDocs` are uploaded to IPFS.\n- The token record (identified by `tokenSymbol`) is then updated with references to the uploaded files.\n- No `txId`, transaction payload, or signed transaction is produced.\n\n**Security:**\n- You must provide a valid `x-api-key`.\n- API key requests do not require `signerAddress`.","href":"/api-reference/endpoint/update-docs"}]},{"group":"KYC","pages":[{"title":"Create KYC Link","openapi":"POST /create-kyc-link","href":"/api-reference/endpoint/create-kyc-link"}]}]},{"tab":"Agentic API","pages":[{"title":"Agentic API","href":"/api-reference/endpoint/agentic-methods-x402"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/introduction"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/introduction"}]},{"tab":"Skill","pages":[{"title":"Skill","href":"/skill/introduction"}]}]},"basePath":"","title":"Create KYC Link - Brickken Documentation","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}