Create user registers a new user with their identity and compliance information.Users must read and agree with the general Terms of Service associated with their country of residence, and you must provide it in the termsOfService field of the request.You can optionally include custom entity metadata in the metadata field to store your own business data (e.g., external IDs, settings, tracking parameters). If not provided during creation, you can add it later using Set metadata endpoint.
The X-Uphold-User-Ipuser context header is mandatory to record the user’s IP when accepting the Terms of Service.
Completing KYC at creation
For individual users, you can optionally provide KYC data directly in this request instead of submitting it afterward through separate calls: fullName, birthdate, and address complete the profile process. You can also provide phone, but the phone process still requires verification. This is entirely optional — you can also create the user with the minimum required fields and complete these processes later.
Authorizations
Authorization
string
header
required
OAuth 2.0 authentication.
Scopes
core.users:create
Grants access to create users
Body
application/json
Individual
Individual (legacy)
Business
Business (legacy)
type
enum<string>
default:individual
required
The type of the user.
Available options:
individual
email
string<email>
required
The email address.
Maximum string length: 254
termsOfService
enum<string>
required
The general terms of service the user agreed to.
Available options:
general-us-hq,
general-gb-fca,
general-pt-bop,
general-lt-fcs,
general-bs-scb
primaryCitizenship
string
required
The citizenship country.
Pattern: ^[A-Z]{2}$
address
object
required
The address of residency.
Show child attributes
phone
object
The phone number.
Show child attributes
fullName
string
The full legal name.
Maximum string length: 200
Pattern: ^\S+\s+\S+(\s+\S+)*$
birthdate
string<date>
The date of birth.
metadata
object
Additional data for the user.
Response
User created.
user
Individual · object
required
Individual
Business
Show child attributes
errors
object
Additional contextual errors that occurred while processing the request.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Uphold","description":"Documentation for the Uphold Enterprise API Suite: onboard users and move value across banks, cards, and crypto with REST APIs, FIX APIs, and embeddable widgets.","colors":{"primary":"#49CC68","light":"#84FB7F","dark":"#49CC68"},"logo":{"light":"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-branded-house-horizontal-enterprise-for-light.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=f60facd63ac72f992db1ece0b4cefaa1","dark":"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-branded-house-horizontal-enterprise-for-dark.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=2bef6993603c9b5c473a7eeff0c3bc97"},"favicon":"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-favicon.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=fe0c9bdf95c1c4a3ad50ef0dec7b3e97","api":{"examples":{"prefill":true}},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[],"primary":{"type":"button","label":"Sandbox Access","href":"http://portal.enterprise.uphold.com"}},"footer":{"socials":{"x":"https://x.com/upholdinc","github":"https://github.com/uphold","linkedin":"https://linkedin.com/company/upholdinc"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uphold-d4756e17","hasAudioNarration":false,"actualSubdomain":"uphold-d4756e17","customDomains":["developer.uphold.com"],"gitSource":{"type":"github","owner":"uphold","repo":"enterprise-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afae6f868b1903921efa1c9","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"REST APIs","count":178},{"language":"default","tag":"Core API","count":137},{"language":"default","tag":"Developer Guides","count":71},{"language":"default","tag":"Webhooks","count":40},{"language":"default","tag":"KYC","count":27},{"language":"default","tag":"KYB","count":25},{"language":"default","tag":"Deposit","count":21},{"language":"default","tag":"Withdrawal","count":18},{"language":"default","tag":"Bank transfers","count":16},{"language":"default","tag":"Accounts","count":16}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".card .prose :where(ul>li):not(:where([class~=not-prose],[class~=not-prose] *)){padding-left:1em!important}.card .prose :where(ul>li):not(:where([class~=not-prose],[class~=not-prose] *)):before{left:0em!important}.card-group>.card>img{position:relative;display:inline-block;top:1.25rem;left:1.5rem;margin-bottom:1rem;width:1.5rem;height:1.5rem;object-fit:contain;object-position:left center}.mbs-cap-height-valign,.icon{margin-block-start:calc(1ex - 1cap)}li[data-group-tag]>button{align-items:center}html[data-current-path^=\"/widgets/payment/\"] table td code,html[data-current-path^=\"/widgets/payment/\"] table th code{white-space:nowrap}html[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)){--sticky-col-bg: #ffffff}html.dark[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)){--sticky-col-bg: #0c0d0d}html[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)) th:first-child,html[data-current-path^=\"/widgets/payment/\"] table:has(thead th:nth-child(5)) td:first-child{background-color:var(--sticky-col-bg);left:0;position:sticky;z-index:20}.kyc-connector-errors-table td:first-child{width:35%}html[data-current-path=\"/widgets/payment/introduction\"] #content-container{max-width:unset}html[data-current-path=\"/widgets/kyc/introduction\"] #content-container{max-width:unset}html[data-current-path=\"/get-started/overview\"] [class~=\"@container/page-header\"]{display:none}html[data-current-path=\"/get-started/overview\"] #content-container{max-width:unset}html[data-current-path=\"/get-started/overview\"] [class*=\"max-w-8xl\"]{max-width:unset!important}@media (min-width: 1600px){html[data-current-path=\"/get-started/overview\"] [class*=\"max-w-8xl\"]{max-width:calc(100% - 6cm)!important;margin-left:0!important;margin-right:auto!important}}html[data-current-path=\"/get-started/overview\"] main{margin-top:-10rem}@media (min-width: 1024px){html[data-current-path=\"/get-started/overview\"] main{margin-top:-2.5rem}}@media (max-width: 1023px){html[data-current-path=\"/get-started/overview\"] main{margin-top:-2.5rem}}html[data-current-path=\"/get-started/overview\"] span[style*=\"radial-gradient\"]{display:none!important}.hero-onchain{margin:0 0 0.5rem;font-weight:700;letter-spacing:-0.02em;line-height:1.1;font-size:clamp(1.75rem, 3vw, 2.5rem);text-wrap:balance;color:#0a1f2e}.dark .hero-onchain{color:#ffffff}.hero-onchain .grad{color:#49CC68}.dark .hero-onchain .grad{color:#84FB7F}.hero-onchain-sub{margin:0 0 1.5rem;font-size:1.0625rem;line-height:1.6;color:#4b5563}.dark .hero-onchain-sub{color:#9aa6b2}.hero-onchain-row{display:grid;grid-template-columns:49.2% 36.63%;column-gap:9.09%;align-items:start;padding-right:5.08%;box-sizing:border-box}.hero-onchain-image{max-width:360px}.hero-onchain-image img{width:100%;height:auto;display:block;margin:0}@media (max-width: 768px){.hero-onchain-row{display:block;padding-right:0}.hero-onchain-image{max-width:65%;margin:1.5rem auto 0}}.hero-onchain-eyebrow{margin:0 0 0.5rem;font-size:1rem;line-height:1.5rem;font-weight:600;color:#6b7280}.dark .hero-onchain-eyebrow{color:#9aa6b2}.hero-cta-row{display:flex;align-items:center;flex-wrap:wrap;gap:0.5rem;margin:0 0 1.5rem}.hero-below-image-line{height:1px;margin-top:0.25cm;background:rgba(10, 31, 46, 0.12)}.dark .hero-below-image-line{background:rgba(255, 255, 255, 0.1)}.section-heading{margin:2rem 0 0;font-family:inherit;font-weight:700;font-size:28px;line-height:36px;letter-spacing:-0.2px;color:#0a1f2e}.dark .section-heading{color:#ffffff}.section-subtitle{margin:0 0 2rem;font-size:16px;line-height:20px;font-weight:400;color:#4b5563}.dark .section-subtitle{color:#8494bd}.ov-btn-primary,.ov-btn-secondary{display:inline-flex;align-items:center;gap:0.375rem;padding:0.5rem 0.875rem;border-radius:9999px;font-size:0.875rem;font-weight:600;line-height:1.25rem;white-space:nowrap;border:none;outline:none;box-shadow:none}.ov-btn-primary:hover,.ov-btn-secondary:hover{text-decoration:none;opacity:0.9}.ov-btn-primary{background:#49cc68;color:#0a1f2e}.dark .ov-btn-primary{background:#84fb7f;color:#090d14}.ov-btn-secondary{background:#e5e7eb;color:#1f2937}.dark .ov-btn-secondary{background:#273149;color:#f0f2fa}.ov-btn-icon{display:inline-block;width:0.7rem;height:0.85rem;background-color:currentColor;-webkit-mask:url('/_media/get-started/icon-build-with-ai.svg') center / contain no-repeat;mask:url('/_media/get-started/icon-build-with-ai.svg') center / contain no-repeat}.section-heading.section-heading-gap-lg{margin-top:5rem}.start-building-grid{display:grid;grid-template-columns:repeat(3, 1fr);gap:1.6%}.start-building-card{position:relative;display:block;aspect-ratio:362 / 249;border-radius:16px;overflow:hidden;text-decoration:none!important;background:#141c29}.start-building-card img{position:absolute;inset:0;width:100%;height:100%;object-fit:cover}.start-building-card-content{position:relative;z-index:1;display:flex;flex-direction:column;justify-content:space-between;height:100%;padding:13px 16px 16px;box-sizing:border-box}.start-building-card-title{margin:0 0 4px;font-size:16px;font-weight:600;line-height:20px;color:#84fb7f}.start-building-card-desc{margin:0;max-width:200px;font-size:14px;font-weight:400;line-height:20px;color:#8494bd}.start-building-card-btn{align-self:flex-start;display:inline-flex;align-items:center;padding:0.5rem 0.875rem;border-radius:9999px;font-size:14px;font-weight:600;line-height:20px;white-space:nowrap;background:#273149;color:#f0f2fa}@media (max-width: 768px){.start-building-grid{grid-template-columns:1fr;gap:1rem}}.ready-steps{display:grid;grid-template-columns:repeat(4, 1fr);gap:2rem}.ready-step{position:relative;display:flex;flex-direction:column;gap:1rem}.ready-step:not(:last-child)::after{content:'';position:absolute;top:12px;left:calc(25px + 8px);right:calc(-2rem + 8px);height:4px;border-radius:9999px;background:#141c29}.ready-step-badge{display:flex;align-items:center;justify-content:center;width:25px;height:25px;border-radius:9999px;background:#84fb7f;color:#000e29;font-size:12px;font-weight:600;z-index:1}.ready-step-title{margin:0;font-size:16px;font-weight:600;line-height:20px;color:#84fb7f}.ready-step-desc{margin:0;font-size:14px;font-weight:400;line-height:20px;color:#8494bd}.ready-step-portal-link{color:#8494bd;font-weight:700;text-decoration:underline}@media (max-width: 768px){.ready-steps{grid-template-columns:1fr;gap:2.5rem}.ready-step:not(:last-child)::after{display:none}}html[data-current-path=\"/developer-guides/trade-and-send/trade/interactive-trade-flow\"] #content-container,html[data-current-path=\"/developer-guides/trade-and-send/send/interactive-send-flow\"] #content-container{max-width:unset}html[data-current-path=\"/developer-guides/buy-and-sell/buy/interactive-buy-flow\"] #content-container,html[data-current-path=\"/developer-guides/buy-and-sell/sell/interactive-sell-flow\"] #content-container{max-width:unset}.wizard-step-pane>div>:first-child{margin-top:0!important}@keyframes pulse-ring{0%,100%{box-shadow:0 0 0 0 rgba(53, 177, 61, 0.75),\n 0 0 12px 2px rgba(53, 177, 61, 0.4)}50%{box-shadow:0 0 0 14px rgba(53, 177, 61, 0),\n 0 0 20px 6px rgba(53, 177, 61, 0.15)}}"}],"page":{"pagePath":"rest-apis/core-api/users/create-user","slug":"/rest-apis/core-api/users/create-user","pageMetadata":{"openapi":"_media/specs/core-openapi.mintlify.json post /core/users","title":"Create user","description":"Create a new user.","href":"/rest-apis/core-api/users/create-user"},"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 a new user.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const RestEndpointSubjects=({subjects=[]})=>{const _components={a:`a`,..._provideComponents()},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);const subjectToIconMap={\"client\":`browser`,\"user:individual\":`user`,\"user:business\":`briefcase`};if(subjects.length===0){return null}return _jsx(_Fragment,{children:subjects.map(subject=>_jsx(_components.a,{href:`/rest-apis/authentication#subjects`,className:`mint-border-0 mint-opacity-85 hover:mint-opacity-100 mint-transition-opacity`,children:_jsx(Badge,{stroke:true,size:`lg`,icon:subjectToIconMap[subject],color:`gray`,className:`mint-mr-1`,children:subject})},subject))})};function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Tip,_MdxComponentBoundary}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`RestEndpointSubjects`,children:_jsx(RestEndpointSubjects,{subjects:[`client`]})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Create user`}),` registers a new user with their identity and compliance information.`]}),`\n`,_jsxs(_components.p,{children:[`Users must read and agree with the `,_jsx(_components.a,{href:`/rest-apis/core-api/terms-of-service/introduction#general-terms`,children:`general Terms of Service`}),` associated with their country of residence, and you must provide it in the `,_jsx(_components.code,{children:`termsOfService`}),` field of the request.`]}),`\n`,_jsxs(_components.p,{children:[`You can optionally include custom `,_jsx(_components.a,{href:`/rest-apis/entity-metadata`,children:`entity metadata`}),` in the `,_jsx(_components.code,{children:`metadata`}),` field to store your own business data (e.g., external IDs, settings, tracking parameters). If not provided during creation, you can add it later using `,_jsx(_components.a,{href:`/rest-apis/core-api/metadata/set-metadata`,children:`Set metadata`}),` endpoint.`]}),`\n`,_jsxs(Tip,{children:[`The `,_jsx(_components.code,{children:`X-Uphold-User-Ip`}),` `,_jsx(_components.a,{href:`/rest-apis/headers#user-context`,children:`user context`}),` header is `,_jsx(_components.strong,{children:`mandatory`}),` to record the user’s IP when accepting the Terms of Service.`]}),`\n`,_jsx(Heading,{level:`2`,id:`completing-kyc-at-creation`,children:`Completing KYC at creation`}),`\n`,_jsxs(_components.p,{children:[`For individual users, you can optionally provide KYC data directly in this request instead of submitting it afterward through separate calls: `,_jsx(_components.code,{children:`fullName`}),`, `,_jsx(_components.code,{children:`birthdate`}),`, and `,_jsx(_components.code,{children:`address`}),` complete the `,_jsx(_components.a,{href:`/rest-apis/core-api/kyc/update-profile`,children:`profile`}),` process. You can also provide `,_jsx(_components.code,{children:`phone`}),`, but the `,_jsx(_components.a,{href:`/rest-apis/core-api/kyc/update-phone`,children:`phone`}),` process still requires verification. This is entirely optional — you can also create the user with the minimum required fields and complete these processes later.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{RestEndpointSubjects,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":{"openapi":"_media/specs/core-openapi.mintlify.json post /core/users","title":"Create user","description":"Create a new user.","href":"/rest-apis/core-api/users/create-user"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[156,780,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Completing KYC at creation","slug":"completing-kyc-at-creation","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-mr-1 {\n margin-right: 0.25rem\n}\n.mint-border-0 {\n border-width: 0px\n}\n.mint-opacity-85 {\n opacity: 0.85\n}\n.mint-transition-opacity {\n transition-property: opacity;\n transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);\n transition-duration: 150ms\n}\n.hover\\:mint-opacity-100:hover {\n opacity: 1\n}","openApiReferenceData":{"operation":{"operationId":"core.create-user","summary":"Create user","description":"Create a new user.","tags":["Users"],"x-uphold":{"security":{"OAuth2":{"subjects":["client"]}}},"security":["cdd9545d-ffca-4afd-8da3-2de0f4625557"],"requestBody":"75e8961e-2294-43b3-8187-18b37b5058a4","responses":{"201":"eb97226f-c21d-4d04-b271-9124ca5122a5","409":"3c7233fa-77d4-4078-beba-4bf669ab5129"},"method":"post","type":"path","servers":["1bf44ae3-9719-4ab2-8015-0dae068a8d01","226066c3-4d97-4b49-be47-5af89fbf345c"],"path":"/core/users","baseUrlOptions":["https://api.enterprise.sandbox.uphold.com","https://api.enterprise.uphold.com"],"title":"Create user","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.oneOf.0.type":"individual","body.oneOf.0.email":"[email protected]","body.oneOf.0.termsOfService":"general-us-hq","body.oneOf.0.primaryCitizenship":"US","body.oneOf.0.address.country":"US","body.oneOf.0.address.subdivision":"US-CA","body.oneOf.0.address.city":"Los Angeles","body.oneOf.0.address.line1":"100 Main Street","body.oneOf.0.address.postalCode":"90011","body.oneOf.0.phone.number":"+12125550123","body.oneOf.0.phone.country":"US","body.oneOf.0.fullName":"John Doe","body.oneOf.0.birthdate":"1987-01-01"},{"body.oneOf.0.type":"individual","body.oneOf.0.email":"[email protected]","body.oneOf.0.termsOfService":"general-gb-fca","body.oneOf.0.primaryCitizenship":"GB","body.oneOf.0.address.country":"GB","body.oneOf.0.address.subdivision":"GB-MAN","body.oneOf.0.address.city":"Manchester","body.oneOf.0.address.line1":"1 High Street","body.oneOf.0.address.line2":"Northern Quarter","body.oneOf.0.address.postalCode":"M4 1AA","body.oneOf.0.phone.number":"+447400123456","body.oneOf.0.phone.country":"GB","body.oneOf.0.fullName":"John Doe","body.oneOf.0.birthdate":"1987-01-01"},{"body.oneOf.0.type":"individual","body.oneOf.0.email":"[email protected]","body.oneOf.0.termsOfService":"general-us-hq","body.oneOf.0.primaryCitizenship":"US","body.oneOf.0.address.country":"US","body.oneOf.0.address.subdivision":"US-CA","body.oneOf.0.metadata":{"externalId":123}},{"body.oneOf.0.type":"individual","body.oneOf.0.email":"[email protected]","body.oneOf.0.termsOfService":"general-gb-fca","body.oneOf.0.primaryCitizenship":"GB","body.oneOf.0.address.country":"GB","body.oneOf.0.address.subdivision":"GB-MAN","body.oneOf.0.metadata":{"externalId":123}},{"body.oneOf.2.type":"business","body.oneOf.2.email":"[email protected]","body.oneOf.2.termsOfService":"general-us-hq","body.oneOf.2.legalEntityType":"private-limited-company","body.oneOf.2.registrationAddress.country":"US","body.oneOf.2.operatingAddress.country":"US","body.oneOf.2.metadata":{"externalId":123}},{"body.oneOf.2.type":"business","body.oneOf.2.email":"[email protected]","body.oneOf.2.termsOfService":"general-gb-fca","body.oneOf.2.legalEntityType":"private-limited-company","body.oneOf.2.registrationAddress.country":"GB","body.oneOf.2.operatingAddress.country":"GB","body.oneOf.2.metadata":{"externalId":123}},{"body.oneOf.2.type":"business","body.oneOf.2.email":"[email protected]","body.oneOf.2.termsOfService":"general-us-hq","body.oneOf.2.legalEntityType":"private-limited-company","body.oneOf.2.registrationAddress.country":"US","body.oneOf.2.registrationAddress.subdivision":"US-CA","body.oneOf.2.registrationAddress.city":"Los Angeles","body.oneOf.2.registrationAddress.line1":"100 Main Street","body.oneOf.2.registrationAddress.postalCode":"90011","body.oneOf.2.operatingAddress.country":"US","body.oneOf.2.operatingAddress.subdivision":"US-CA","body.oneOf.2.operatingAddress.city":"Los Angeles","body.oneOf.2.operatingAddress.line1":"100 Main Street","body.oneOf.2.operatingAddress.postalCode":"90011","body.oneOf.2.legalEntityName":"ACME Corporation","body.oneOf.2.formationDate":"2000-01-01","body.oneOf.2.industry.oneOf.6.sector":"ecommerce-and-retail","body.oneOf.2.industry.oneOf.6.subSector":"online-marketplaces","body.oneOf.2.legalIds.items.0.type":"tax-id","body.oneOf.2.legalIds.items.0.id":"12-3456789","body.oneOf.2.legalIds.items.0.country":"US","body.oneOf.2.legalIds.items.1.type":"registration-id","body.oneOf.2.legalIds.items.1.id":"7234567","body.oneOf.2.legalIds.items.1.country":"US","body.oneOf.2.metadata":{"externalId":123}},{"body.oneOf.2.type":"business","body.oneOf.2.email":"[email protected]","body.oneOf.2.termsOfService":"general-gb-fca","body.oneOf.2.legalEntityType":"private-limited-company","body.oneOf.2.registrationAddress.country":"GB","body.oneOf.2.registrationAddress.subdivision":"GB-MAN","body.oneOf.2.registrationAddress.city":"Manchester","body.oneOf.2.registrationAddress.line1":"1 High Street","body.oneOf.2.registrationAddress.line2":"Northern Quarter","body.oneOf.2.registrationAddress.postalCode":"M4 1AA","body.oneOf.2.operatingAddress.country":"GB","body.oneOf.2.operatingAddress.subdivision":"GB-MAN","body.oneOf.2.operatingAddress.city":"Manchester","body.oneOf.2.operatingAddress.line1":"1 High Street","body.oneOf.2.operatingAddress.line2":"Northern Quarter","body.oneOf.2.operatingAddress.postalCode":"M4 1AA","body.oneOf.2.legalEntityName":"ACME Corporation","body.oneOf.2.formationDate":"2000-01-01","body.oneOf.2.industry.oneOf.6.sector":"ecommerce-and-retail","body.oneOf.2.industry.oneOf.6.subSector":"online-marketplaces","body.oneOf.2.legalIds.items.0.type":"tax-id","body.oneOf.2.legalIds.items.0.id":"99L99999","body.oneOf.2.legalIds.items.0.country":"GB","body.oneOf.2.legalIds.items.1.type":"registration-id","body.oneOf.2.legalIds.items.1.id":"AB123456","body.oneOf.2.legalIds.items.1.country":"GB","body.oneOf.2.metadata":{"externalId":123}}]},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Individual","required":["type","email","termsOfService","primaryCitizenship","address"],"properties":{"type":{"type":"string","description":"The type of the user.","default":"individual","enum":["individual"],"isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"email":{"description":"The email address.","type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"oneOf.0.email","typeLabel":"string\u003cemail>"},"termsOfService":{"type":"string","description":"The general terms of service the user agreed to.","enum":["general-us-hq","general-gb-fca","general-pt-bop","general-lt-fcs","general-bs-scb"],"isRequired":true,"uniqueKey":"oneOf.0.termsOfService","typeLabel":"enum\u003cstring>"},"primaryCitizenship":{"type":"string","description":"The citizenship country.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"oneOf.0.primaryCitizenship","typeLabel":"string"},"address":{"type":"object","description":"The address of residency.","minProperties":1,"required":["country"],"properties":{"country":{"type":"string","description":"The country of the address.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"oneOf.0.address.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The subdivision of the address.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","uniqueKey":"oneOf.0.address.subdivision","typeLabel":"string"},"city":{"type":"string","description":"The city of the address.","maxLength":100,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.0.address.city","typeLabel":"string"},"line1":{"type":"string","description":"The first line of the address.","maxLength":150,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.0.address.line1","typeLabel":"string"},"line2":{"type":"string","description":"The second line of the address.","maxLength":100,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.0.address.line2","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code of the address.","maxLength":20,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.0.address.postalCode","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.address","typeLabel":"object"},"phone":{"description":"The phone number.","type":"object","properties":{"number":{"description":"The E.164 formatted phone number.","type":"string","pattern":"^\\+[0-9]{1,15}$","isRequired":true,"uniqueKey":"oneOf.0.phone.number","typeLabel":"string"},"country":{"type":"string","description":"The country code of the phone number.\nIt must be a ISO alpha-2 code that is used to disambiguate phone numbers with the same dialing code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"oneOf.0.phone.country","typeLabel":"string"}},"required":["number","country"],"uniqueKey":"oneOf.0.phone","typeLabel":"object"},"fullName":{"type":"string","description":"The full legal name.","maxLength":200,"pattern":"^\\S+\\s+\\S+(\\s+\\S+)*$","uniqueKey":"oneOf.0.fullName","typeLabel":"string"},"birthdate":{"description":"The date of birth.","type":"string","format":"date","uniqueKey":"oneOf.0.birthdate","typeLabel":"string\u003cdate>"},"metadata":{"type":"object","additionalProperties":true,"minProperties":1,"description":"Additional data for the user.","uniqueKey":"oneOf.0.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"Individual · object"},{"type":"object","title":"Individual (legacy)","required":["type","email","termsOfService","citizenshipCountry","country"],"properties":{"type":{"type":"string","description":"The type of the user.","default":"individual","enum":["individual"],"isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"email":{"description":"The email address.","type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"oneOf.1.email","typeLabel":"string\u003cemail>"},"termsOfService":{"type":"string","description":"The general terms of service the user agreed to.","enum":["general-us-hq","general-gb-fca","general-pt-bop","general-lt-fcs","general-bs-scb"],"isRequired":true,"uniqueKey":"oneOf.1.termsOfService","typeLabel":"enum\u003cstring>"},"citizenshipCountry":{"type":"string","description":"The citizenship country.","pattern":"^[A-Z]{2}$","deprecated":true,"isRequired":true,"uniqueKey":"oneOf.1.citizenshipCountry","typeLabel":"string"},"country":{"type":"string","description":"The country of residency.","pattern":"^[A-Z]{2}$","deprecated":true,"isRequired":true,"uniqueKey":"oneOf.1.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The subdivision of residency.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","deprecated":true,"uniqueKey":"oneOf.1.subdivision","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"minProperties":1,"description":"Additional data for the user.","uniqueKey":"oneOf.1.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"Individual (legacy) · object"},{"type":"object","title":"Business","required":["type","termsOfService","email","legalEntityType","registrationAddress","operatingAddress"],"properties":{"type":{"type":"string","description":"The type of the user.","default":"individual","enum":["business"],"isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"email":{"description":"The email address.","type":"string","format":"email","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.email","typeLabel":"string\u003cemail>"},"termsOfService":{"type":"string","description":"The general terms of service the user agreed to.","enum":["general-us-hq","general-gb-fca","general-pt-bop","general-lt-fcs","general-bs-scb"],"isRequired":true,"uniqueKey":"oneOf.2.termsOfService","typeLabel":"enum\u003cstring>"},"legalEntityType":{"type":"string","description":"Business legal form/classification.","enum":["government-entity","non-profit","partnership","private-limited-company","public-company","sole-proprietor"],"isRequired":true,"uniqueKey":"oneOf.2.legalEntityType","typeLabel":"enum\u003cstring>"},"registrationAddress":{"type":"object","description":"The registration address of the business.","minProperties":1,"required":["country"],"properties":{"country":{"type":"string","description":"The country of the address.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"oneOf.2.registrationAddress.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The subdivision of the address.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","uniqueKey":"oneOf.2.registrationAddress.subdivision","typeLabel":"string"},"city":{"type":"string","description":"The city of the address.","maxLength":100,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.registrationAddress.city","typeLabel":"string"},"line1":{"type":"string","description":"The first line of the address.","maxLength":150,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.registrationAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"The second line of the address.","maxLength":100,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.registrationAddress.line2","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code of the address.","maxLength":20,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.registrationAddress.postalCode","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.2.registrationAddress","typeLabel":"object"},"operatingAddress":{"type":"object","description":"The operating address of the business.","minProperties":1,"required":["country"],"properties":{"country":{"type":"string","description":"The country of the address.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"oneOf.2.operatingAddress.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The subdivision of the address.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","uniqueKey":"oneOf.2.operatingAddress.subdivision","typeLabel":"string"},"city":{"type":"string","description":"The city of the address.","maxLength":100,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.operatingAddress.city","typeLabel":"string"},"line1":{"type":"string","description":"The first line of the address.","maxLength":150,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.operatingAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"The second line of the address.","maxLength":100,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.operatingAddress.line2","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code of the address.","maxLength":20,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.operatingAddress.postalCode","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.2.operatingAddress","typeLabel":"object"},"legalEntityName":{"type":"string","description":"The full legal entity name.","maxLength":200,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.legalEntityName","typeLabel":"string"},"formationDate":{"description":"The date of the business formation.","type":"string","format":"date","uniqueKey":"oneOf.2.formationDate","typeLabel":"string\u003cdate>"},"industry":{"oneOf":[{"type":"object","title":"Financial Institutions and Money Services","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"financial-institutions-and-money-services","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.0.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["money-transmitters","remittance-services","vasp-casp","payment-processors","fx-providers","other-regulated-nbfi"],"uniqueKey":"oneOf.2.industry.oneOf.0.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.0","typeLabel":"Financial Institutions and Money Services · object"},{"type":"object","title":"Crypto Services and Products","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"crypto-services-and-products","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.1.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["exchanges","custodial-wallet-providers","non-custodial-wallet-providers","miners","nft-platforms","defi-projects"],"uniqueKey":"oneOf.2.industry.oneOf.1.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.1","typeLabel":"Crypto Services and Products · object"},{"type":"object","title":"Personal Investment Vehicles","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"personal-investment-vehicles","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.2.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["private-trusts","roth-ira","llc-spe-for-holding-assets"],"uniqueKey":"oneOf.2.industry.oneOf.2.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.2","typeLabel":"Personal Investment Vehicles · object"},{"type":"object","title":"Family Offices and Investment Funds","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"family-offices-and-investment-funds","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.3.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["family-offices","pooled-investment-vehicles","private-investment-funds"],"uniqueKey":"oneOf.2.industry.oneOf.3.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.3","typeLabel":"Family Offices and Investment Funds · object"},{"type":"object","title":"Professional Services","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"professional-services","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.4.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["law-firms","accounting-firms","consultants","company-formation-or-secretarial-services"],"uniqueKey":"oneOf.2.industry.oneOf.4.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.4","typeLabel":"Professional Services · object"},{"type":"object","title":"Technology and Software","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"technology-and-software","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.5.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["it-services","saas","gaming-studios","cybersecurity","data-analytics","ai-firms"],"uniqueKey":"oneOf.2.industry.oneOf.5.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.5","typeLabel":"Technology and Software · object"},{"type":"object","title":"E-commerce and Retail","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"ecommerce-and-retail","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.6.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["online-marketplaces","merchants","wholesalers","direct-to-consumer-retailers"],"uniqueKey":"oneOf.2.industry.oneOf.6.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.6","typeLabel":"E-commerce and Retail · object"},{"type":"object","title":"Real Estate and Property Management","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"real-estate-and-property-management","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.7.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["brokerages","property-developers","management-companies","investment-vehicles"],"uniqueKey":"oneOf.2.industry.oneOf.7.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.7","typeLabel":"Real Estate and Property Management · object"},{"type":"object","title":"High-Value Goods and Luxury Dealers","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"high-value-goods-and-luxury-dealers","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.8.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["jewelry","art","precious-metals","automobiles","auction-houses"],"uniqueKey":"oneOf.2.industry.oneOf.8.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.8","typeLabel":"High-Value Goods and Luxury Dealers · object"},{"type":"object","title":"Other","required":["sector"],"properties":{"sector":{"type":"string","const":"other","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.9.sector","typeLabel":"string"},"otherSector":{"type":"string","description":"Free-form description of the sector and sub-sector.","pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.industry.oneOf.9.otherSector","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.9","typeLabel":"Other · object"},{"type":"object","title":"Other","required":["sector"],"properties":{"sector":{"type":"string","const":"other","isRequired":true,"uniqueKey":"oneOf.2.industry.oneOf.10.sector","typeLabel":"string"},"otherSector":{"type":"string","description":"Free-form description of the sector and sub-sector.","maxLength":255,"pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"oneOf.2.industry.oneOf.10.otherSector","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.2.industry.oneOf.10","typeLabel":"Other · object"}],"uniqueKey":"oneOf.2.industry","typeLabel":"Financial Institutions and Money Services · object · Crypto Services and Products · object · Personal Investment Vehicles · object · Family Offices and Investment Funds · object · Professional Services · object · Technology and Software · object · E-commerce and Retail · object · Real Estate and Property Management · object · High-Value Goods and Luxury Dealers · object · Other · object · Other · object"},"legalIds":{"type":"array","description":"The legal identifiers of the business, usually government-issued.","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"type":{"description":"The type of the legal identifier.","type":"string","enum":["tax-id","registration-id"],"isRequired":true,"uniqueKey":"oneOf.2.legalIds.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The legal identifier value.","maxLength":140,"pattern":"^\\S.*\\S$|^\\S$","isRequired":true,"uniqueKey":"oneOf.2.legalIds.items.[INDEX].id","typeLabel":"string"},"country":{"type":"string","description":"The country of the legal identifier.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"oneOf.2.legalIds.items.[INDEX].country","typeLabel":"string"}},"required":["type","id","country"],"uniqueKey":"oneOf.2.legalIds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.legalIds","typeLabel":"object[]"},"metadata":{"type":"object","additionalProperties":true,"minProperties":1,"description":"Additional data for the user.","uniqueKey":"oneOf.2.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"Business · object"},{"type":"object","title":"Business (legacy)","required":["type","termsOfService","email","legalEntityType","country"],"properties":{"type":{"type":"string","description":"The type of the user.","default":"individual","enum":["business"],"isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"enum\u003cstring>"},"email":{"description":"The email address.","type":"string","format":"email","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.email","typeLabel":"string\u003cemail>"},"termsOfService":{"type":"string","description":"The general terms of service the user agreed to.","enum":["general-us-hq","general-gb-fca","general-pt-bop","general-lt-fcs","general-bs-scb"],"isRequired":true,"uniqueKey":"oneOf.3.termsOfService","typeLabel":"enum\u003cstring>"},"legalEntityType":{"type":"string","description":"Business legal form/classification.","enum":["private-limited-company"],"isRequired":true,"uniqueKey":"oneOf.3.legalEntityType","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"The country of residency.","pattern":"^[A-Z]{2}$","deprecated":true,"isRequired":true,"uniqueKey":"oneOf.3.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The subdivision of residency.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","deprecated":true,"uniqueKey":"oneOf.3.subdivision","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"minProperties":1,"description":"Additional data for the user.","uniqueKey":"oneOf.3.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.3","typeLabel":"Business (legacy) · object"}],"uniqueKey":"","typeLabel":"Individual · object | Individual (legacy) · object | Business · object | Business (legacy) · object"},"examples":{"Create Complete Individual User - US":{"title":"Create Complete Individual User - US","value":{"type":"individual","email":"[email protected]","termsOfService":"general-us-hq","fullName":"John Doe","birthdate":"1987-01-01","primaryCitizenship":"US","address":{"country":"US","subdivision":"US-CA","city":"Los Angeles","line1":"100 Main Street","postalCode":"90011"},"phone":{"number":"+12125550123","country":"US"}}},"Create Complete Individual User - GB":{"title":"Create Complete Individual User - GB","value":{"type":"individual","email":"[email protected]","termsOfService":"general-gb-fca","fullName":"John Doe","birthdate":"1987-01-01","primaryCitizenship":"GB","address":{"country":"GB","subdivision":"GB-MAN","city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA"},"phone":{"number":"+447400123456","country":"GB"}}},"Create Individual User - US":{"title":"Create Individual User - US","value":{"type":"individual","email":"[email protected]","termsOfService":"general-us-hq","primaryCitizenship":"US","address":{"country":"US","subdivision":"US-CA"},"metadata":{"externalId":123}}},"Create Individual User - GB":{"title":"Create Individual User - GB","value":{"type":"individual","email":"[email protected]","termsOfService":"general-gb-fca","primaryCitizenship":"GB","address":{"country":"GB","subdivision":"GB-MAN"},"metadata":{"externalId":123}}},"Create Business User - US":{"title":"Create Business User - US","value":{"type":"business","email":"[email protected]","termsOfService":"general-us-hq","legalEntityType":"private-limited-company","registrationAddress":{"country":"US"},"operatingAddress":{"country":"US"},"metadata":{"externalId":123}}},"Create Business User - GB":{"title":"Create Business User - GB","value":{"type":"business","email":"[email protected]","termsOfService":"general-gb-fca","legalEntityType":"private-limited-company","registrationAddress":{"country":"GB"},"operatingAddress":{"country":"GB"},"metadata":{"externalId":123}}},"Create Complete Business User - US":{"title":"Create Complete Business User - US","value":{"type":"business","email":"[email protected]","termsOfService":"general-us-hq","legalEntityType":"private-limited-company","legalEntityName":"ACME Corporation","formationDate":"2000-01-01","industry":{"sector":"ecommerce-and-retail","subSector":"online-marketplaces"},"legalIds":[{"type":"tax-id","id":"12-3456789","country":"US"},{"type":"registration-id","id":"7234567","country":"US"}],"registrationAddress":{"city":"Los Angeles","line1":"100 Main Street","postalCode":"90011","subdivision":"US-CA","country":"US"},"operatingAddress":{"city":"Los Angeles","line1":"100 Main Street","postalCode":"90011","subdivision":"US-CA","country":"US"},"metadata":{"externalId":123}}},"Create Complete Business User - GB":{"title":"Create Complete Business User - GB","value":{"type":"business","email":"[email protected]","termsOfService":"general-gb-fca","legalEntityType":"private-limited-company","legalEntityName":"ACME Corporation","formationDate":"2000-01-01","industry":{"sector":"ecommerce-and-retail","subSector":"online-marketplaces"},"legalIds":[{"type":"tax-id","id":"99L99999","country":"GB"},{"type":"registration-id","id":"AB123456","country":"GB"}],"registrationAddress":{"city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA","subdivision":"GB-MAN","country":"GB"},"operatingAddress":{"city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA","subdivision":"GB-MAN","country":"GB"},"metadata":{"externalId":123}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"eb97226f-c21d-4d04-b271-9124ca5122a5":{"description":"User created.","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"oneOf":[{"type":"object","title":"Individual","required":["id","type","email","address","primaryCitizenship","createdAt","updatedAt"],"properties":{"id":{"description":"The id of the user.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"user.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"description":"The type of the user.","type":"string","enum":["individual"],"isRequired":true,"uniqueKey":"user.oneOf.0.type","typeLabel":"enum\u003cstring>"},"email":{"description":"The email address.","type":"string","format":"email","isRequired":true,"uniqueKey":"user.oneOf.0.email","typeLabel":"string\u003cemail>"},"primaryCitizenship":{"description":"The citizenship country.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.0.primaryCitizenship","typeLabel":"string"},"address":{"type":"object","description":"The address of residency.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.0.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"user.oneOf.0.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"user.oneOf.0.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"user.oneOf.0.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"user.oneOf.0.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"user.oneOf.0.address.postalCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.oneOf.0.address","typeLabel":"object"},"createdAt":{"description":"The time at which the user was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"user.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"The time at which the user was last updated.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"user.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"fullName":{"description":"The full legal name.","type":"string","uniqueKey":"user.oneOf.0.fullName","typeLabel":"string"},"birthdate":{"description":"The date of birth.","type":"string","uniqueKey":"user.oneOf.0.birthdate","typeLabel":"string"},"citizenshipCountry":{"description":"The citizenship country. Deprecated in favor of `primaryCitizenship`.","type":"string","deprecated":true,"uniqueKey":"user.oneOf.0.citizenshipCountry","typeLabel":"string"},"phone":{"description":"The phone number.","type":"object","properties":{"number":{"description":"The E.164 formatted phone number.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.0.phone.number","typeLabel":"string"},"country":{"description":"The country code of the phone number.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.0.phone.country","typeLabel":"string"}},"required":["number","country"],"uniqueKey":"user.oneOf.0.phone","typeLabel":"object"}},"isRequired":true,"uniqueKey":"user.oneOf.0","typeLabel":"Individual · object"},{"type":"object","title":"Business","required":["id","type","email","legalEntityType","operatingAddress","address","createdAt","updatedAt"],"properties":{"id":{"description":"The id of the user.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"user.oneOf.1.id","typeLabel":"string\u003cuuid>"},"type":{"description":"The type of the user.","type":"string","enum":["business"],"isRequired":true,"uniqueKey":"user.oneOf.1.type","typeLabel":"enum\u003cstring>"},"email":{"description":"The email address.","type":"string","format":"email","isRequired":true,"uniqueKey":"user.oneOf.1.email","typeLabel":"string\u003cemail>"},"legalEntityType":{"type":"string","description":"Business legal form/classification.","enum":["government-entity","non-profit","partnership","private-limited-company","public-company","sole-proprietor"],"isRequired":true,"uniqueKey":"user.oneOf.1.legalEntityType","typeLabel":"enum\u003cstring>"},"operatingAddress":{"description":"The address information.","type":"object","properties":{"country":{"description":"The country of the address.","type":"string","uniqueKey":"user.oneOf.1.operatingAddress.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"user.oneOf.1.operatingAddress.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"user.oneOf.1.operatingAddress.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"user.oneOf.1.operatingAddress.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"user.oneOf.1.operatingAddress.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"user.oneOf.1.operatingAddress.postalCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.oneOf.1.operatingAddress","typeLabel":"object"},"address":{"type":"object","description":"The address of the business (operating address).","required":["country"],"deprecated":true,"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.1.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"user.oneOf.1.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"user.oneOf.1.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"user.oneOf.1.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"user.oneOf.1.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"user.oneOf.1.address.postalCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.oneOf.1.address","typeLabel":"object"},"createdAt":{"description":"The time at which the user was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"user.oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"The time at which the user was last updated.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"user.oneOf.1.updatedAt","typeLabel":"string\u003cdate-time>"},"legalEntityName":{"description":"The full legal entity name.","type":"string","uniqueKey":"user.oneOf.1.legalEntityName","typeLabel":"string"},"formationDate":{"description":"The date of the business formation.","type":"string","format":"date","uniqueKey":"user.oneOf.1.formationDate","typeLabel":"string\u003cdate>"},"industry":{"oneOf":[{"type":"object","title":"Financial Institutions and Money Services","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"financial-institutions-and-money-services","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.0.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["money-transmitters","remittance-services","vasp-casp","payment-processors","fx-providers","other-regulated-nbfi"],"uniqueKey":"user.oneOf.1.industry.oneOf.0.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.0","typeLabel":"Financial Institutions and Money Services · object"},{"type":"object","title":"Crypto Services and Products","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"crypto-services-and-products","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.1.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["exchanges","custodial-wallet-providers","non-custodial-wallet-providers","miners","nft-platforms","defi-projects"],"uniqueKey":"user.oneOf.1.industry.oneOf.1.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.1","typeLabel":"Crypto Services and Products · object"},{"type":"object","title":"Personal Investment Vehicles","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"personal-investment-vehicles","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.2.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["private-trusts","roth-ira","llc-spe-for-holding-assets"],"uniqueKey":"user.oneOf.1.industry.oneOf.2.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.2","typeLabel":"Personal Investment Vehicles · object"},{"type":"object","title":"Family Offices and Investment Funds","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"family-offices-and-investment-funds","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.3.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["family-offices","pooled-investment-vehicles","private-investment-funds"],"uniqueKey":"user.oneOf.1.industry.oneOf.3.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.3","typeLabel":"Family Offices and Investment Funds · object"},{"type":"object","title":"Professional Services","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"professional-services","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.4.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["law-firms","accounting-firms","consultants","company-formation-or-secretarial-services"],"uniqueKey":"user.oneOf.1.industry.oneOf.4.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.4","typeLabel":"Professional Services · object"},{"type":"object","title":"Technology and Software","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"technology-and-software","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.5.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["it-services","saas","gaming-studios","cybersecurity","data-analytics","ai-firms"],"uniqueKey":"user.oneOf.1.industry.oneOf.5.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.5","typeLabel":"Technology and Software · object"},{"type":"object","title":"E-commerce and Retail","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"ecommerce-and-retail","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.6.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["online-marketplaces","merchants","wholesalers","direct-to-consumer-retailers"],"uniqueKey":"user.oneOf.1.industry.oneOf.6.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.6","typeLabel":"E-commerce and Retail · object"},{"type":"object","title":"Real Estate and Property Management","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"real-estate-and-property-management","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.7.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["brokerages","property-developers","management-companies","investment-vehicles"],"uniqueKey":"user.oneOf.1.industry.oneOf.7.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.7","typeLabel":"Real Estate and Property Management · object"},{"type":"object","title":"High-Value Goods and Luxury Dealers","description":"The industry classification of the business. Allowed `subSector` values depend on the selected `sector`.","required":["sector"],"properties":{"sector":{"type":"string","const":"high-value-goods-and-luxury-dealers","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.8.sector","typeLabel":"string"},"subSector":{"type":"string","enum":["jewelry","art","precious-metals","automobiles","auction-houses"],"uniqueKey":"user.oneOf.1.industry.oneOf.8.subSector","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.8","typeLabel":"High-Value Goods and Luxury Dealers · object"},{"type":"object","title":"Other","required":["sector"],"properties":{"sector":{"type":"string","const":"other","isRequired":true,"uniqueKey":"user.oneOf.1.industry.oneOf.9.sector","typeLabel":"string"},"otherSector":{"type":"string","description":"Free-form description of the sector and sub-sector.","pattern":"^\\S.*\\S$|^\\S$","uniqueKey":"user.oneOf.1.industry.oneOf.9.otherSector","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"user.oneOf.1.industry.oneOf.9","typeLabel":"Other · object"}],"uniqueKey":"user.oneOf.1.industry","typeLabel":"Financial Institutions and Money Services · object | Crypto Services and Products · object | Personal Investment Vehicles · object | Family Offices and Investment Funds · object | Professional Services · object | Technology and Software · object | E-commerce and Retail · object | Real Estate and Property Management · object | High-Value Goods and Luxury Dealers · object | Other · object"},"legalIds":{"type":"array","description":"The legal identifiers of the business, usually government-issued.","minItems":1,"items":{"type":"object","properties":{"type":{"description":"The type of the legal identifier.","type":"string","enum":["tax-id","registration-id"],"isRequired":true,"uniqueKey":"user.oneOf.1.legalIds.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"description":"The legal identifier value.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.1.legalIds.items.[INDEX].id","typeLabel":"string"},"country":{"description":"The country of the legal identifier.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.1.legalIds.items.[INDEX].country","typeLabel":"string"}},"required":["type","id","country"],"uniqueKey":"user.oneOf.1.legalIds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"user.oneOf.1.legalIds","typeLabel":"object[]"},"registrationAddress":{"type":"object","description":"The registration address of the business. Always available for non-legacy business users.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"user.oneOf.1.registrationAddress.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"user.oneOf.1.registrationAddress.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"user.oneOf.1.registrationAddress.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"user.oneOf.1.registrationAddress.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"user.oneOf.1.registrationAddress.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"user.oneOf.1.registrationAddress.postalCode","typeLabel":"string"}},"uniqueKey":"user.oneOf.1.registrationAddress","typeLabel":"object"},"name":{"description":"The legal name of the business.","type":"string","deprecated":true,"uniqueKey":"user.oneOf.1.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"user.oneOf.1","typeLabel":"Business · object"}],"isRequired":true,"uniqueKey":"user","typeLabel":"Individual · object | Business · object"},"errors":{"description":"Additional contextual errors that occurred while processing the request.","type":"object","properties":{"metadata":{"type":"object","description":"Error related to metadata processing.","required":["code","message"],"properties":{"code":{"description":"A short string with a brief explanation about the code reported.","type":"string","isRequired":true,"uniqueKey":"errors.metadata.code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details.","type":"string","isRequired":true,"uniqueKey":"errors.metadata.message","typeLabel":"string"},"details":{"description":"Additional information about the feedback reported.","type":"object","additionalProperties":true,"uniqueKey":"errors.metadata.details","typeLabel":"object"}},"uniqueKey":"errors.metadata","typeLabel":"object"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["user"],"uniqueKey":"","typeLabel":"object"},"examples":{"Complete Individual User Created - US":{"title":"Complete Individual User Created - US","value":{"user":{"id":"cd21b26d-35d2-408a-9201-b8fdbef7a604","type":"individual","email":"[email protected]","fullName":"John Doe","birthdate":"1987-01-01","primaryCitizenship":"US","address":{"country":"US","subdivision":"US-CA","city":"Los Angeles","line1":"100 Main Street","postalCode":"90011"},"phone":{"number":"+12125550123","country":"US"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"}}},"Complete Individual User Created - GB":{"title":"Complete Individual User Created - GB","value":{"user":{"id":"cd21b26d-35d2-408a-9201-b8fdbef7a604","type":"individual","email":"[email protected]","fullName":"John Doe","birthdate":"1987-01-01","primaryCitizenship":"GB","address":{"country":"GB","subdivision":"GB-MAN","city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA"},"phone":{"number":"+447400123456","country":"GB"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"}}},"Individual User Created - US":{"title":"Individual User Created - US","value":{"user":{"id":"cd21b26d-35d2-408a-9201-b8fdbef7a604","type":"individual","email":"[email protected]","primaryCitizenship":"US","address":{"country":"US","subdivision":"US-CA"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"}}},"Individual User Created - GB":{"title":"Individual User Created - GB","value":{"user":{"id":"cd21b26d-35d2-408a-9201-b8fdbef7a604","type":"individual","email":"[email protected]","primaryCitizenship":"GB","address":{"country":"GB","subdivision":"GB-MAN"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"}}},"Business User Created - US":{"title":"Business User Created - US","value":{"user":{"id":"4237b7f2-4658-4183-ab56-b2fc4ecd7b7f","type":"business","email":"[email protected]","legalEntityType":"private-limited-company","registrationAddress":{"country":"US","subdivision":"US-CA"},"operatingAddress":{"country":"US","subdivision":"US-CA"},"address":{"country":"US","subdivision":"US-CA"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"}}},"Business User Created - GB":{"title":"Business User Created - GB","value":{"user":{"id":"4237b7f2-4658-4183-ab56-b2fc4ecd7b7f","type":"business","email":"[email protected]","legalEntityType":"private-limited-company","registrationAddress":{"country":"GB","subdivision":"GB-MAN"},"operatingAddress":{"country":"GB","subdivision":"GB-MAN"},"address":{"country":"GB","subdivision":"GB-MAN"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"}}},"Individual User Created With Metadata Error - US":{"title":"Individual User Created With Metadata Error - US","value":{"user":{"id":"cd21b26d-35d2-408a-9201-b8fdbef7a604","type":"individual","email":"[email protected]","primaryCitizenship":"US","address":{"country":"US","subdivision":"US-CA"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"},"errors":{"metadata":{"code":"content_too_large","message":"The entity metadata size is greater than maximum size limit","details":{"threshold":{"unit":"characters","limit":1024}}}}}},"Individual User Created With Metadata Error - GB":{"title":"Individual User Created With Metadata Error - GB","value":{"user":{"id":"cd21b26d-35d2-408a-9201-b8fdbef7a604","type":"individual","email":"[email protected]","primaryCitizenship":"GB","address":{"country":"GB","subdivision":"GB-MAN"},"createdAt":"2024-03-13T20:20:39.000Z","updatedAt":"2024-03-13T20:20:39.000Z"},"errors":{"metadata":{"code":"content_too_large","message":"The entity metadata size is greater than maximum size limit","details":{"threshold":{"unit":"characters","limit":1024}}}}}}},"exampleType":"examples"}},"headers":{"x-uphold-request-id":{"description":"A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.","required":true,"schema":{"type":"string"},"examples":{"Request ID":{"value":"a4e390583b3ac581-MRS"}}}},"exampleType":"examples"},"3c7233fa-77d4-4078-beba-4bf669ab5129":{"description":"Business logic error.","content":{"application/json":{"schema":{"type":"object","description":"The error information.","required":["code","message"],"properties":{"code":{"description":"A short string with a brief explanation about the code reported.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional information about the feedback reported.","type":"object","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Name Contains Invalid Characters":{"title":"Name Contains Invalid Characters","value":{"code":"invalid_characters","message":"The request has invalid characters","details":{"context":"body","property":"fullName"}}},"User Underage":{"title":"User Underage","value":{"code":"date_invalid","message":"The date must be older than or equal to 18 years ago","details":{"context":"body","property":"birthdate","rule":"difference-greater-than-or-equal-to-threshold","threshold":{"limit":18,"unit":"years"}}}},"User Overage":{"title":"User Overage","value":{"code":"date_invalid","message":"The date must be newer than or equal to 100 years from now","details":{"context":"body","property":"birthdate","rule":"difference-less-than-or-equal-to-threshold","threshold":{"limit":100,"unit":"years"}}}},"Primary Citizenship Not Supported":{"title":"Primary Citizenship Not Supported","value":{"code":"country_not_supported","message":"The country is not supported","details":{"context":"body","property":"primaryCitizenship"}}},"Address Country Not Supported":{"title":"Address Country Not Supported","value":{"code":"country_not_supported","message":"The country is not supported","details":{"context":"body","property":"address.country"}}},"User Country Not Supported":{"title":"User Country Not Supported","value":{"code":"country_not_supported","message":"The country is not supported","details":{"context":"headers","property":"x-uphold-user-country"}}},"Address Subdivision Not Supported":{"title":"Address Subdivision Not Supported","value":{"code":"subdivision_not_supported","message":"The subdivision is not supported","details":{"context":"body","property":"address.subdivision"}}},"Address Subdivision Required For Country":{"title":"Address Subdivision Required For Country","value":{"code":"subdivision_required","message":"The subdivision is required for the selected country","details":{"context":"body","property":"address.subdivision"}}},"Address PO Box Not Allowed":{"title":"Address PO Box Not Allowed","value":{"code":"po_boxes_not_allowed","message":"PO boxes are not allowed","details":{"context":"body","property":"address"}}},"Address Postal Code Invalid":{"title":"Address Postal Code Invalid","value":{"code":"postal_code_invalid","message":"The postal code is invalid","details":{"context":"body","property":"address.postalCode"}}},"Email Incorrect or Disallowed":{"title":"Email Incorrect or Disallowed","value":{"code":"email_incorrect_or_disallowed","message":"The email is incorrect or disallowed"}},"Email Already Exists":{"title":"Email Already Exists","value":{"code":"email_already_exists","message":"The provided email is already in use by another user"}},"Phone Already Exists":{"title":"Phone Already Exists","value":{"code":"phone_already_exists","message":"The provided phone is already in use by another user"}},"Phone Invalid":{"title":"Phone Invalid","value":{"code":"phone_invalid","message":"The phone number is invalid"}},"Phone Country Not Supported":{"title":"Phone Country Not Supported","value":{"code":"country_not_supported","message":"The country is not supported","details":{"context":"body","property":"phone.country"}}},"Legal Entity Type Not Allowed":{"title":"Legal Entity Type Not Allowed","value":{"code":"operation_not_allowed","message":"Sole proprietors are not allowed in GB","details":{"reasons":["legal-entity-type-not-allowed"]}}},"Formation Date Invalid":{"title":"Formation Date Invalid","value":{"code":"date_invalid","message":"The date must be in the past","details":{"context":"body","property":"formationDate","rule":"difference-greater-than-threshold","threshold":{"limit":0,"unit":"milliseconds"}}}},"Legal ID Country Not Supported":{"title":"Legal ID Country Not Supported","value":{"code":"country_not_supported","message":"The country is not supported","details":{"context":"body","property":"legalIds[0].country"}}},"Legal ID Document Number Invalid":{"title":"Legal ID Document Number Invalid","value":{"code":"document_number_invalid","message":"Tax ID is invalid for country","details":{"context":"body","property":"legalIds[0].id"}}},"Terms Of Service Mismatch":{"title":"Terms Of Service Mismatch","value":{"code":"terms_of_service_mismatch","message":"The terms of service passed in the request does not match the one that should have been accepted"}},"Missing User Context":{"title":"Missing User Context","value":{"code":"operation_not_allowed","message":"Request not allowed due to missing user context","details":{"reasons":["missing-user-ip-header"]}}}},"exampleType":"examples"}},"headers":{"x-uphold-request-id":{"description":"A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.","required":true,"schema":{"type":"string"},"examples":{"Request ID":{"value":"a4e390583b3ac581-MRS"}}}},"exampleType":"examples"}},"security":{"cdd9545d-ffca-4afd-8da3-2de0f4625557":{"OAuth2":{"type":"oauth2","description":"OAuth 2.0 authentication.","flows":{"clientCredentials":{"tokenUrl":"/core/oauth2/token","scopes":{"core.users:act-on-behalf-of":"Grants access to act on behalf of a user","core.users:create":"Grants access to create users","core.users:read":"Grants access to view users","core.users:delete":"Grants access to delete users","core.users.metadata:read":"Grants access to view user metadata","core.users.metadata:write":"Grants access to modify user metadata","core.kyc:read":"Grants access to view KYC processes","core.kyc.profile:update":"Grants access to update profile KYC process","core.kyc.address:update":"Grants access to update address KYC process","core.kyc.email:update":"Grants access to update email KYC process","core.kyc.phone:update":"Grants access to update phone KYC process","core.kyc.identity:update":"Grants access to update identity KYC process","core.kyc.proof-of-address:update":"Grants access to update proof-of-address KYC process","core.kyc.customer-due-diligence:update":"Grants access to update customer due diligence KYC process","core.kyc.enhanced-due-diligence:update":"Grants access to update enhanced due diligence KYC process","core.kyc.crypto-risk-assessment:update":"Grants access to update crypto risk assessment KYC process","core.kyc.self-categorization-statement:update":"Grants access to update self-categorization statement KYC process","core.kyc.tax-details:update":"Grants access to update tax details KYC process","core.kyb:read":"Grants access to view KYB processes","core.kyb.profile:update":"Grants access to update profile KYB process","core.kyb.documents:update":"Grants access to update documents KYB process","core.kyb.financial-institution:update":"Grants access to update financial institution KYB process","core.kyb.associated-persons:create":"Grants access to create KYB associated persons","core.kyb.associated-persons:read":"Grants access to view KYB associated persons","core.kyb.associated-persons:delete":"Grants access to delete KYB associated persons","core.kyb.associated-persons.profile:update":"Grants access to update profile KYB associated person process","core.kyb.associated-persons.identity:update":"Grants access to update identity KYB associated person process","core.kyb.associated-persons.proof-of-address:update":"Grants access to update proof-of-address KYB associated person process","core.kyb:use-test-helpers":"Grants access to test helpers for KYB","core.kyb.attestation:trigger":"Grants access to trigger the attestation process","core.capabilities:read":"Grants access to view user capabilities","core.terms-of-service:read":"Grants access to view terms of service","core.terms-of-service:accept":"Grants access to accept terms of service","core.files:create":"Grants access to create files","core.files:read":"Grants access to view files","core.files.metadata:read":"Grants access to view files metadata","core.files.metadata:write":"Grants access to modify files metadata","core.accounts:create":"Grants access to create accounts","core.accounts:read":"Grants access to view accounts","core.accounts:update":"Grants access to update accounts","core.accounts:archive":"Grants access to archive accounts","core.accounts:deposit-method":"Grants access to deposit method needed for depositing into accounts","core.accounts:use-test-helpers":"Grants access to test helpers of accounts","core.accounts.metadata:read":"Grants access to view accounts metadata","core.accounts.metadata:write":"Grants access to modify accounts metadata","core.assets:use-test-helpers":"Grants access to test helpers of assets","core.external-accounts:create":"Grants access to create external accounts","core.external-accounts:read":"Grants access to view external accounts","core.external-accounts:update":"Grants access to update external accounts","core.external-accounts:delete":"Grants access to delete external accounts","core.external-accounts.metadata:read":"Grants access to view external accounts metadata","core.external-accounts.metadata:write":"Grants access to modify external accounts metadata","core.transactions:create":"Grants access to commit quotes","core.transactions:read":"Grants access to view transactions","core.transactions.metadata:read":"Grants access to view transactions metadata","core.transactions.metadata:write":"Grants access to modify transactions metadata","core.transactions.requests-for-information:read":"Grants access to view transactions requests for information","core.transactions.requests-for-information:update":"Grants access to update transactions requests for information","core.requests-for-information:read":"Grants access to view requests for information","core.requests-for-information:update":"Grants access to update requests for information","core.portfolio:read":"Grants access to view portfolio overview, performance, and historical balance","core.statements:read":"Grants access to read statements","core.webhooks:management-link":"Grants access to create webhook management links"}}},"scopes":["core.users:create"],"schemeName":"OAuth2"}}},"servers":{"1bf44ae3-9719-4ab2-8015-0dae068a8d01":{"url":"https://api.enterprise.sandbox.uphold.com","description":"Sandbox"},"226066c3-4d97-4b49-be47-5af89fbf345c":{"url":"https://api.enterprise.uphold.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authentication.","flows":{"clientCredentials":{"tokenUrl":"/core/oauth2/token","scopes":{"core.users:act-on-behalf-of":"Grants access to act on behalf of a user","core.users:create":"Grants access to create users","core.users:read":"Grants access to view users","core.users:delete":"Grants access to delete users","core.users.metadata:read":"Grants access to view user metadata","core.users.metadata:write":"Grants access to modify user metadata","core.kyc:read":"Grants access to view KYC processes","core.kyc.profile:update":"Grants access to update profile KYC process","core.kyc.address:update":"Grants access to update address KYC process","core.kyc.email:update":"Grants access to update email KYC process","core.kyc.phone:update":"Grants access to update phone KYC process","core.kyc.identity:update":"Grants access to update identity KYC process","core.kyc.proof-of-address:update":"Grants access to update proof-of-address KYC process","core.kyc.customer-due-diligence:update":"Grants access to update customer due diligence KYC process","core.kyc.enhanced-due-diligence:update":"Grants access to update enhanced due diligence KYC process","core.kyc.crypto-risk-assessment:update":"Grants access to update crypto risk assessment KYC process","core.kyc.self-categorization-statement:update":"Grants access to update self-categorization statement KYC process","core.kyc.tax-details:update":"Grants access to update tax details KYC process","core.kyb:read":"Grants access to view KYB processes","core.kyb.profile:update":"Grants access to update profile KYB process","core.kyb.documents:update":"Grants access to update documents KYB process","core.kyb.financial-institution:update":"Grants access to update financial institution KYB process","core.kyb.associated-persons:create":"Grants access to create KYB associated persons","core.kyb.associated-persons:read":"Grants access to view KYB associated persons","core.kyb.associated-persons:delete":"Grants access to delete KYB associated persons","core.kyb.associated-persons.profile:update":"Grants access to update profile KYB associated person process","core.kyb.associated-persons.identity:update":"Grants access to update identity KYB associated person process","core.kyb.associated-persons.proof-of-address:update":"Grants access to update proof-of-address KYB associated person process","core.kyb:use-test-helpers":"Grants access to test helpers for KYB","core.kyb.attestation:trigger":"Grants access to trigger the attestation process","core.capabilities:read":"Grants access to view user capabilities","core.terms-of-service:read":"Grants access to view terms of service","core.terms-of-service:accept":"Grants access to accept terms of service","core.files:create":"Grants access to create files","core.files:read":"Grants access to view files","core.files.metadata:read":"Grants access to view files metadata","core.files.metadata:write":"Grants access to modify files metadata","core.accounts:create":"Grants access to create accounts","core.accounts:read":"Grants access to view accounts","core.accounts:update":"Grants access to update accounts","core.accounts:archive":"Grants access to archive accounts","core.accounts:deposit-method":"Grants access to deposit method needed for depositing into accounts","core.accounts:use-test-helpers":"Grants access to test helpers of accounts","core.accounts.metadata:read":"Grants access to view accounts metadata","core.accounts.metadata:write":"Grants access to modify accounts metadata","core.assets:use-test-helpers":"Grants access to test helpers of assets","core.external-accounts:create":"Grants access to create external accounts","core.external-accounts:read":"Grants access to view external accounts","core.external-accounts:update":"Grants access to update external accounts","core.external-accounts:delete":"Grants access to delete external accounts","core.external-accounts.metadata:read":"Grants access to view external accounts metadata","core.external-accounts.metadata:write":"Grants access to modify external accounts metadata","core.transactions:create":"Grants access to commit quotes","core.transactions:read":"Grants access to view transactions","core.transactions.metadata:read":"Grants access to view transactions metadata","core.transactions.metadata:write":"Grants access to modify transactions metadata","core.transactions.requests-for-information:read":"Grants access to view transactions requests for information","core.transactions.requests-for-information:update":"Grants access to update transactions requests for information","core.requests-for-information:read":"Grants access to view requests for information","core.requests-for-information:update":"Grants access to update requests for information","core.portfolio:read":"Grants access to view portfolio overview, performance, and historical balance","core.statements:read":"Grants access to read statements","core.webhooks:management-link":"Grants access to create webhook management links"}}},"scopes":["core.users:create"],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authentication.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"_media/specs/core-openapi.mintlify.json"},"subdomain":"uphold-d4756e17","siteName":"Uphold","title":"Create user - Uphold","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-15T10:57:37.674Z","originalFileLocation":"rest-apis/core-api/users/create-user.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=\"dark\"}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 a new user.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Uphold\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_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/uphold-d4756e17/TGvshyKbe31xNfhd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create user - Uphold\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new user.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Uphold\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.uphold.com/rest-apis/core-api/users/create-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uphold-d4756e17.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Create+user\u0026amp;description=Create+a+new+user.\u0026amp;theme=ff31b04fc4d9e649c4b1458d\u0026amp;signature=64be3aff3d822ad3d58e99336edf048b4182090d28be5d3acb408c655b02ed81\">\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 user - Uphold\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uphold-d4756e17.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Create+user\u0026amp;description=Create+a+new+user.\u0026amp;theme=ff31b04fc4d9e649c4b1458d\u0026amp;signature=64be3aff3d822ad3d58e99336edf048b4182090d28be5d3acb408c655b02ed81\">\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/uphold-d4756e17/TGvshyKbe31xNfhd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Uphold\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#49CC68\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.uphold.com/rest-apis/core-api/users/create-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/rest-apis/core-api/users/create-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.uphold.com/#organization\",\"name\":\"Uphold\",\"url\":\"https://developer.uphold.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uphold-d4756e17/7IRkuAa79m7bSPci/_media/logos/uphold-branded-house-horizontal-enterprise-for-light.svg?fit=max\u0026auto=format\u0026n=7IRkuAa79m7bSPci\u0026q=85\u0026s=f60facd63ac72f992db1ece0b4cefaa1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.uphold.com#website\",\"name\":\"Uphold\",\"url\":\"https://developer.uphold.com\",\"publisher\":{\"@id\":\"https://developer.uphold.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user#webpage\",\"url\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user\",\"name\":\"Create user\",\"description\":\"Create a new user.\",\"dateModified\":\"2026-07-15T10:57:37.674Z\",\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/concepts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create user\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user#apireference\",\"headline\":\"Create user\",\"name\":\"Create user\",\"description\":\"Create a new user.\",\"url\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user\",\"mainEntityOfPage\":{\"@id\":\"https://developer.uphold.com/rest-apis/core-api/users/create-user#webpage\"},\"dateModified\":\"2026-07-15T10:57:37.674Z\",\"publisher\":{\"@id\":\"https://developer.uphold.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"}}]}\u003c/script>","agentPointerHref":"/rest-apis/core-api/users/create-user.md","siteName":"Uphold","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/get-started/overview"}]},{"tab":"Developer Guides","pages":[{"title":"Developer Guides","href":"/developer-guides/overview"}]},{"tab":"REST APIs","pages":[{"title":"Introduction to the Uphold Enterprise REST APIs","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/introduction"},{"title":"REST API changelog","sidebarTitle":"Changelog","icon":"rss","href":"/rest-apis/changelog"},{"title":"Authentication","icon":"key","href":"/rest-apis/authentication"},{"title":"API versioning","sidebarTitle":"Versioning","icon":"code-branch","href":"/rest-apis/versioning"},{"title":"Error handling","sidebarTitle":"Errors","icon":"bug","href":"/rest-apis/errors"},{"title":"Rate limits","icon":"gauge","href":"/rest-apis/rate-limits"},{"title":"Common headers","icon":"brackets-curly","href":"/rest-apis/headers"},{"title":"Entity metadata","icon":"tags","href":"/rest-apis/entity-metadata"},{"title":"Pagination","icon":"list","href":"/rest-apis/pagination"},{"title":"Test helpers","icon":"bolt","href":"/rest-apis/test-helpers"},{"title":"Webhooks","icon":"webhook","href":"/rest-apis/webhooks"},{"group":"Core API","pages":[{"title":"Core API concepts and data model","sidebarTitle":"Concepts","icon":"lightbulb","href":"/rest-apis/core-api/concepts"},{"group":"Authentication","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/oauth2/token","title":"Request OAuth2 token","href":"/rest-apis/core-api/authentication/request-oauth2-token"}]},{"group":"Countries","pages":[{"title":"Countries API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/countries/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/countries","title":"List countries","href":"/rest-apis/core-api/countries/list-countries"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/countries/{country}","title":"Get country","description":"Retrieve a country by code.","href":"/rest-apis/core-api/countries/get-country"}]},{"group":"Users","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/users","title":"Create user","href":"/rest-apis/core-api/users/create-user"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/users/me","title":"Get user","description":"Retrieve an existing user.","href":"/rest-apis/core-api/users/get-user"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/users/me","title":"Delete user","href":"/rest-apis/core-api/users/delete-user"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.user.created","title":"User created","href":"/rest-apis/core-api/users/webhooks/user-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.user.deleted","title":"User deleted","href":"/rest-apis/core-api/users/webhooks/user-deleted"}]}]},{"group":"KYC","pages":[{"title":"KYC API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/kyc/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyc","title":"Get overview","href":"/rest-apis/core-api/kyc/get-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/email","title":"Update email","href":"/rest-apis/core-api/kyc/update-email"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/phone","title":"Update phone","href":"/rest-apis/core-api/kyc/update-phone"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/profile","title":"Update profile","href":"/rest-apis/core-api/kyc/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/address","title":"Update address","href":"/rest-apis/core-api/kyc/update-address"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/identity","title":"Update identity","href":"/rest-apis/core-api/kyc/update-identity"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/proof-of-address","title":"Update proof-of-address","href":"/rest-apis/core-api/kyc/update-proof-of-address"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/customer-due-diligence","title":"Update customer due diligence","href":"/rest-apis/core-api/kyc/update-customer-due-diligence"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/enhanced-due-diligence","title":"Update enhanced due diligence","href":"/rest-apis/core-api/kyc/update-enhanced-due-diligence"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/crypto-risk-assessment","title":"Update crypto risk assessment","href":"/rest-apis/core-api/kyc/update-crypto-risk-assessment"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/self-categorization-statement","title":"Update self-categorization statement","href":"/rest-apis/core-api/kyc/update-self-categorization-statement"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/tax-details","title":"Update tax details","href":"/rest-apis/core-api/kyc/update-tax-details"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.email.status-changed","title":"Email status changed","href":"/rest-apis/core-api/kyc/webhooks/email-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.phone.status-changed","title":"Phone status changed","href":"/rest-apis/core-api/kyc/webhooks/phone-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.profile.status-changed","title":"Profile status changed","href":"/rest-apis/core-api/kyc/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.address.status-changed","title":"Address status Changed","href":"/rest-apis/core-api/kyc/webhooks/address-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.identity.status-changed","title":"Identity status changed","href":"/rest-apis/core-api/kyc/webhooks/identity-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.proof-of-address.status-changed","title":"Proof-of-address status changed","href":"/rest-apis/core-api/kyc/webhooks/proof-of-address-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.customer-due-diligence.status-changed","title":"Customer due diligence status changed","href":"/rest-apis/core-api/kyc/webhooks/customer-due-diligence-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.enhanced-due-diligence.status-changed","title":"Enhanced due diligence status changed","href":"/rest-apis/core-api/kyc/webhooks/enhanced-due-diligence-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.crypto-risk-assessment.status-changed","title":"Crypto risk assessment status changed","href":"/rest-apis/core-api/kyc/webhooks/crypto-risk-assessment-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.self-categorization-statement.status-changed","title":"Self categorization statement status changed","href":"/rest-apis/core-api/kyc/webhooks/self-categorization-statement-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.tax-details.status-changed","title":"Tax details status changed","href":"/rest-apis/core-api/kyc/webhooks/tax-details-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.screening.status-changed","title":"Screening status changed","href":"/rest-apis/core-api/kyc/webhooks/screening-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.risk.status-changed","title":"Risk status changed","href":"/rest-apis/core-api/kyc/webhooks/risk-status-changed"}]}]},{"group":"KYB","pages":[{"title":"KYB API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/kyb/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb","title":"Get overview","href":"/rest-apis/core-api/kyb/get-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/profile","title":"Update profile","href":"/rest-apis/core-api/kyb/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/documents","title":"Update documents","href":"/rest-apis/core-api/kyb/update-documents"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/financial-institution","title":"Update financial institution","href":"/rest-apis/core-api/kyb/update-financial-institution"},{"group":"Associated persons","icon":"users","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb/associated-persons","sidebarTitle":"List persons","title":"List associated persons","href":"/rest-apis/core-api/kyb/associated-persons/list-associated-persons"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons","sidebarTitle":"Create person","title":"Create associated person","href":"/rest-apis/core-api/kyb/associated-persons/create-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb/associated-persons/{personId}","sidebarTitle":"Get person","title":"Get associated person","href":"/rest-apis/core-api/kyb/associated-persons/get-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/kyb/associated-persons/{personId}","sidebarTitle":"Delete person","title":"Delete associated person","href":"/rest-apis/core-api/kyb/associated-persons/delete-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/profile","sidebarTitle":"Update person profile","title":"Update associated person profile","href":"/rest-apis/core-api/kyb/associated-persons/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/identity","sidebarTitle":"Update person identity","title":"Update associated person identity","href":"/rest-apis/core-api/kyb/associated-persons/update-identity"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/proof-of-address","sidebarTitle":"Update person proof-of-address","title":"Update associated person proof-of-address","href":"/rest-apis/core-api/kyb/associated-persons/update-proof-of-address"},{"group":"Test helpers","icon":"bolt","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons/{personId}/test-helpers/identity-outcome","sidebarTitle":"Set desired outcome for IDV Process","title":"Set identity verification outcome","href":"/rest-apis/core-api/kyb/associated-persons/test-helpers/identity-outcome"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons/{personId}/test-helpers/proof-of-address-outcome","sidebarTitle":"Set desired outcome for POA Process","title":"Set proof of address verification outcome","href":"/rest-apis/core-api/kyb/associated-persons/test-helpers/proof-of-address-outcome"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.created","sidebarTitle":"Person created","title":"Associated person created","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/associated-person-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.deleted","sidebarTitle":"Person deleted","title":"Associated person deleted","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/associated-person-deleted"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.profile.status-changed","sidebarTitle":"Person profile status changed","title":"Associated person profile status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.identity.status-changed","sidebarTitle":"Person identity status changed","title":"Associated person identity status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/identity-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.proof-of-address.status-changed","sidebarTitle":"Person proof-of-address status changed","title":"Associated person proof-of-address status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/proof-of-address-status-changed"}]}]},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/processes/attestation/trigger","title":"Trigger attestation","href":"/rest-apis/core-api/kyb/trigger-attestation"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.profile.status-changed","title":"Profile status changed","href":"/rest-apis/core-api/kyb/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-persons.status-changed","title":"Associated persons status changed","href":"/rest-apis/core-api/kyb/webhooks/associated-persons-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.documents.status-changed","title":"Documents status changed","href":"/rest-apis/core-api/kyb/webhooks/documents-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.financial-institution.status-changed","title":"Financial institution status changed","href":"/rest-apis/core-api/kyb/webhooks/financial-institution-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.attestation.status-changed","title":"Attestation status changed","href":"/rest-apis/core-api/kyb/webhooks/attestation-status-changed"}]}]},{"group":"Capabilities","pages":[{"title":"Capabilities API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/capabilities/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/capabilities","title":"List capabilities","href":"/rest-apis/core-api/capabilities/list-user-capabilities"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/capabilities/{capability}","title":"Get capability","href":"/rest-apis/core-api/capabilities/get-user-capability"}]},{"group":"Terms of service","pages":[{"title":"Terms of Service API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/terms-of-service/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/terms-of-service","title":"List terms of service","href":"/rest-apis/core-api/terms-of-service/list-terms-of-service"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/terms-of-service/{termsOfService}","title":"Get terms of service","href":"/rest-apis/core-api/terms-of-service/get-terms-of-service"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/terms-of-service/{termsOfService}/accept","title":"Accept terms of service","href":"/rest-apis/core-api/terms-of-service/accept-terms-of-service"}]},{"group":"Files","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/files","title":"Create file","href":"/rest-apis/core-api/files/create-file"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/files/{fileId}","title":"Get file","href":"/rest-apis/core-api/files/get-file"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/files/settings","title":"List files settings","href":"/rest-apis/core-api/files/list-files-settings"}]},{"group":"Assets","pages":[{"title":"Assets API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/assets/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets","title":"List assets","href":"/rest-apis/core-api/assets/list-assets"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets/{asset}","title":"Get asset","href":"/rest-apis/core-api/assets/get-asset"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets/{asset}/rates","title":"Get asset rates","href":"/rest-apis/core-api/assets/get-asset-rates"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/assets/{asset}/historical-rates","title":"Get asset historical rates","href":"/rest-apis/core-api/assets/get-historical-rates"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/networks","title":"List networks","href":"/rest-apis/core-api/assets/list-networks"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/networks/{network}","title":"Get network","href":"/rest-apis/core-api/assets/get-network"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/networks/{network}/validate-address","title":"Validate network address","href":"/rest-apis/core-api/assets/validate-network-address"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/rails","title":"List rails","href":"/rest-apis/core-api/assets/list-rails"},{"group":"Test helpers","icon":"bolt","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json put /core/assets/test-helpers/skip-assets-cooldowns","title":"Skip assets cooldowns","href":"/rest-apis/core-api/assets/test-helpers/skip-assets-cooldowns"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.assets.cooldown-ended","title":"Assets cooldown ended","href":"/rest-apis/core-api/assets/webhooks/assets-cooldown-ended"}]}]},{"group":"Accounts","pages":[{"title":"Accounts API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/accounts/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts","title":"List accounts","href":"/rest-apis/core-api/accounts/list-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/defaults","title":"List default accounts","href":"/rest-apis/core-api/accounts/list-default-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/accounts","title":"Create account","href":"/rest-apis/core-api/accounts/create-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}","title":"Get account","href":"/rest-apis/core-api/accounts/get-account"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/accounts/{accountId}","title":"Archive account","href":"/rest-apis/core-api/accounts/archive-account"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/accounts/{accountId}","title":"Update account","href":"/rest-apis/core-api/accounts/update-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}/deposit-method","title":"Get account deposit method","href":"/rest-apis/core-api/accounts/get-account-deposit-method"},{"openapi":"_media/specs/core-openapi.mintlify.json put /core/accounts/{accountId}/deposit-method","title":"Set up account deposit method","href":"/rest-apis/core-api/accounts/set-up-account-deposit-method"},{"group":"Test helpers","icon":"bolt","pages":[{"title":"Fund Sandbox accounts","sidebarTitle":"Fund sandbox accounts","icon":"wallet","href":"/rest-apis/core-api/accounts/test-helpers/fund-sandbox-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/accounts/test-helpers/bank-deposits","title":"Simulate bank deposit","href":"/rest-apis/core-api/accounts/test-helpers/simulate-bank-deposit"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/accounts/test-helpers/crypto-deposits","title":"Simulate crypto deposit","href":"/rest-apis/core-api/accounts/test-helpers/simulate-crypto-deposit"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.created","title":"Account Created","href":"/rest-apis/core-api/accounts/webhooks/account-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.balance-changed","title":"Account Balance Changed","href":"/rest-apis/core-api/accounts/webhooks/account-balance-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.archived","title":"Account archived","href":"/rest-apis/core-api/accounts/webhooks/account-archived"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.account.unarchived","title":"Account unarchived","href":"/rest-apis/core-api/accounts/webhooks/account-unarchived"}]}]},{"group":"External accounts","pages":[{"title":"External accounts API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/external-accounts/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts","title":"List external accounts","href":"/rest-apis/core-api/external-accounts/list-external-accounts"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/external-accounts","title":"Create external account","href":"/rest-apis/core-api/external-accounts/create-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts/{externalAccountId}","title":"Get external account","href":"/rest-apis/core-api/external-accounts/get-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/external-accounts/{externalAccountId}","title":"Delete external account","href":"/rest-apis/core-api/external-accounts/delete-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/external-accounts/{externalAccountId}","title":"Update external account","href":"/rest-apis/core-api/external-accounts/update-external-account"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts/{externalAccountId}/verifications","title":"List external account verifications","href":"/rest-apis/core-api/external-accounts/list-external-account-verifications"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/external-accounts/{externalAccountId}/verifications/{level}","title":"Get external account verification","href":"/rest-apis/core-api/external-accounts/get-external-account-verification"},{"openapi":"_media/specs/core-openapi.mintlify.json put /core/external-accounts/{externalAccountId}/verifications/{level}","title":"Set up crypto external account verification","href":"/rest-apis/core-api/external-accounts/setup-external-account-verification"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.external-account.created","title":"External account created","href":"/rest-apis/core-api/external-accounts/webhooks/external-account-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.external-account.status-changed","title":"External account status changed","href":"/rest-apis/core-api/external-accounts/webhooks/external-account-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.external-account.deleted","title":"External account deleted","href":"/rest-apis/core-api/external-accounts/webhooks/external-account-deleted"}]}]},{"group":"Transactions","pages":[{"title":"Transactions API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/transactions/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/transactions/quote","title":"Create quote","href":"/rest-apis/core-api/transactions/create-quote"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}/transactions","title":"List account transactions","href":"/rest-apis/core-api/transactions/list-account-transactions"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/transactions","title":"List transactions","href":"/rest-apis/core-api/transactions/list-transactions"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/transactions","title":"Create transaction","href":"/rest-apis/core-api/transactions/create-transaction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/transactions/{transactionId}","title":"Get transaction","href":"/rest-apis/core-api/transactions/get-transaction"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.transaction.created","title":"Transaction created","href":"/rest-apis/core-api/transactions/webhooks/transaction-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.transaction.status-changed","title":"Transaction status changed","href":"/rest-apis/core-api/transactions/webhooks/transaction-status-changed"}]}]},{"group":"Requests for information","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json get /core/requests-for-information","title":"List requests for information","href":"/rest-apis/core-api/requests-for-information/list-requests-for-information"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/requests-for-information/{requestForInformationId}","title":"Get request for information","href":"/rest-apis/core-api/requests-for-information/get-request-for-information"},{"openapi":"_media/specs/core-openapi.mintlify.json put /core/requests-for-information/{requestForInformationId}","title":"Update request for information","href":"/rest-apis/core-api/requests-for-information/update-request-for-information"}]},{"group":"Portfolio","pages":[{"title":"Portfolio API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/portfolio/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio","title":"Get overview","href":"/rest-apis/core-api/portfolio/get-portfolio-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/performance","title":"Get performance","href":"/rest-apis/core-api/portfolio/get-portfolio-performance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/historical-balance","title":"Get historical balance","href":"/rest-apis/core-api/portfolio/get-portfolio-historical-balance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/accounts/{accountId}/performance","title":"Get account performance","href":"/rest-apis/core-api/portfolio/get-portfolio-account-performance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/accounts/{accountId}/historical-balance","title":"Get account historical balance","href":"/rest-apis/core-api/portfolio/get-portfolio-account-historical-balance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/assets/{asset}/performance","title":"Get asset performance","href":"/rest-apis/core-api/portfolio/get-portfolio-asset-performance"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/portfolio/assets/{asset}/historical-balance","title":"Get asset historical balance","href":"/rest-apis/core-api/portfolio/get-portfolio-asset-historical-balance"}]},{"group":"Statements","pages":[{"title":"Introduction","icon":"book-open","href":"/rest-apis/core-api/statements/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/statements/portfolio","title":"Get portfolio statement","href":"/rest-apis/core-api/statements/get-portfolio-statement"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/statements/transactions","title":"Get transactions statement","href":"/rest-apis/core-api/statements/get-transactions-statement"}]},{"group":"Metadata","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json put /core/{entity}/{entityId}/metadata","title":"Set metadata","href":"/rest-apis/core-api/metadata/set-metadata"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/{entity}/{entityId}/metadata","title":"Get metadata","href":"/rest-apis/core-api/metadata/get-metadata"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/{entity}/{entityId}/metadata","title":"Delete metadata","href":"/rest-apis/core-api/metadata/delete-metadata"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/{entity}/{entityId}/metadata","title":"Update metadata","href":"/rest-apis/core-api/metadata/update-metadata"}]},{"group":"Webhooks","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/webhooks/management-link","title":"Request webhook management link","href":"/rest-apis/core-api/webhooks/request-management-link"}]}]},{"group":"Trading API","tag":"Preview","pages":[{"title":"Trading API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/trading-api/introduction"},{"group":"Prices","pages":[{"openapi":"_media/specs/trading-openapi.mintlify.json post /trading/prices","title":"Estimate price","href":"/rest-apis/trading-api/prices/estimate-price"}]},{"group":"Orders","pages":[{"openapi":"_media/specs/trading-openapi.mintlify.json post /trading/orders","title":"Create order","href":"/rest-apis/trading-api/orders/create-order"},{"openapi":"_media/specs/trading-openapi.mintlify.json get /trading/orders","title":"List orders","href":"/rest-apis/trading-api/orders/list-orders"},{"openapi":"_media/specs/trading-openapi.mintlify.json get /trading/orders/{orderId}","title":"Get order","href":"/rest-apis/trading-api/orders/get-order"},{"openapi":"_media/specs/trading-openapi.mintlify.json get /trading/orders/{orderId}/trades","title":"List order trades","href":"/rest-apis/trading-api/orders/list-order-trades"}]}]},{"group":"Market Pulse API","pages":[{"group":"General","pages":[{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/news","title":"List general news","href":"/rest-apis/market-pulse-api/general/list-general-news"}]},{"group":"Assets","pages":[{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/assets/{assetCode}/news","title":"List asset news","href":"/rest-apis/market-pulse-api/assets/list-asset-news"},{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/assets/{assetCode}/statistics","title":"Get asset statistics","href":"/rest-apis/market-pulse-api/assets/get-asset-statistics"},{"openapi":"_media/specs/market-pulse-openapi.mintlify.json get /market-pulse/assets/{assetCode}/information","title":"Get asset information","href":"/rest-apis/market-pulse-api/assets/get-asset-information"}]}]},{"group":"KYC Connector API","pages":[{"title":"KYC Connector API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/kyc-connector-api/introduction"},{"group":"Sumsub","pages":[{"title":"Sumsub KYC Connector overview","sidebarTitle":"Overview","icon":"list-radio","href":"/rest-apis/kyc-connector-api/sumsub/overview"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json post /kyc-connector/sumsub/ingestions","title":"Create Sumsub ingestion","href":"/rest-apis/kyc-connector-api/sumsub/create-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/sumsub/ingestions/{ingestionId}","title":"Get Sumsub ingestion","href":"/rest-apis/kyc-connector-api/sumsub/get-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/sumsub/ingestions","title":"List Sumsub ingestions","href":"/rest-apis/kyc-connector-api/sumsub/list-ingestions"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.sumsub.ingestion.created","title":"Sumsub ingestion created","href":"/rest-apis/kyc-connector-api/sumsub/webhooks/ingestion-created"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.sumsub.ingestion.status-changed","title":"Sumsub ingestion status changed","href":"/rest-apis/kyc-connector-api/sumsub/webhooks/ingestion-status-changed"}]}]},{"group":"Veriff","pages":[{"title":"Veriff KYC Connector overview","sidebarTitle":"Overview","icon":"list-radio","href":"/rest-apis/kyc-connector-api/veriff/overview"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json post /kyc-connector/veriff/ingestions","title":"Create Veriff ingestion","href":"/rest-apis/kyc-connector-api/veriff/create-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/veriff/ingestions/{ingestionId}","title":"Get Veriff ingestion","href":"/rest-apis/kyc-connector-api/veriff/get-ingestion"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/veriff/ingestions","title":"List Veriff ingestions","href":"/rest-apis/kyc-connector-api/veriff/list-ingestions"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json put /kyc-connector/veriff/config","title":"Set Veriff config","href":"/rest-apis/kyc-connector-api/veriff/set-config"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json get /kyc-connector/veriff/config","title":"Get Veriff config","href":"/rest-apis/kyc-connector-api/veriff/get-config"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.veriff.ingestion.created","title":"Veriff ingestion created","href":"/rest-apis/kyc-connector-api/veriff/webhooks/ingestion-created"},{"openapi":"_media/specs/kyc-connector-openapi.mintlify.json webhook kyc-connector.veriff.ingestion.status-changed","title":"Veriff ingestion status changed","href":"/rest-apis/kyc-connector-api/veriff/webhooks/ingestion-status-changed"}]}]}]},{"group":"Widgets API","pages":[{"group":"Payment","pages":[{"openapi":"_media/specs/widgets-openapi.mintlify.json post /widgets/payment/sessions","title":"Create session","href":"/rest-apis/widgets-api/payment/create-session"}]},{"group":"KYC","pages":[{"openapi":"_media/specs/widgets-openapi.mintlify.json post /widgets/kyc/sessions","title":"Create session","href":"/rest-apis/widgets-api/kyc/create-session"}]},{"group":"Travel rule","pages":[{"openapi":"_media/specs/widgets-openapi.mintlify.json post /widgets/travel-rule/sessions","title":"Create session","href":"/rest-apis/widgets-api/travel-rule/create-session"}]}]},{"group":"Topper API","pages":[{"group":"KYC sharing","pages":[{"openapi":"_media/specs/topper-openapi.mintlify.json post /topper/kyc-sharing/identify-user","title":"Identify user","href":"/rest-apis/topper-api/kyc-sharing/identify-user"},{"openapi":"_media/specs/topper-openapi.mintlify.json post /topper/kyc-sharing/sessions","title":"Create session","href":"/rest-apis/topper-api/kyc-sharing/create-session"}]}]}]},{"tab":"FIX APIs","pages":[{"title":"FIX APIs","href":"/fix-apis/introduction"}]},{"tab":"Widgets","pages":[{"title":"Widgets","href":"/widgets/introduction"}]}]},"basePath":"","title":"Create user - Uphold","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}