Get overview is the endpoint that provides a summary of the user’s KYC process.By default, only the status of each KYC process is included in the response.
If you need detailed information, you can use the detailed query parameter to specify the KYC processes you want more detail, which will bring
their input, output fields as well as hint if applicable.
Getting the detailed KYC information is more expensive in terms of performance and should be used only when necessary.
Overall status
The summary object describes the user’s overall standing, independently of the individual processes:
Status
Meaning
pending
The platform is still expecting information from the user.
ok
The user has been verified.
restricted
The user has been verified but the platform has limited certain capabilities.
blocked
The user is not allowed to operate on the platform.
The accompanying reason field carries additional context for the current status, and is none when there is nothing further to report.
Authorizations
Authorization
string
header
required
OAuth 2.0 authentication.
Scopes
core.kyc:read
Grants access to view KYC processes
Headers
Accept-Language
string
The natural language and locale that the client prefers.
Query Parameters
detailed
enum<string>[]
Include detailed information about the specified KYC processes. Use this sparingly as its more expensive to retrieve.
Maximum array length: 20
Available options:
profile,
address,
email,
phone,
identity,
proofOfAddress,
customerDueDiligence,
enhancedDueDiligence,
cryptoRiskAssessment,
selfCategorizationStatement,
taxDetails,
screening,
risk
Response
KYC overview retrieved.
summary
object
required
Show child attributes
processes
object
required
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.4177","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":[],"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/kyc/get-overview","slug":"/rest-apis/core-api/kyc/get-overview","pageMetadata":{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyc","title":"Get overview","description":"Get the KYC overview of an individual user.","href":"/rest-apis/core-api/kyc/get-overview"},"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: \"Get the KYC overview of an individual 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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table,_MdxComponentBoundary}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`RestEndpointSubjects`,children:_jsx(RestEndpointSubjects,{subjects:[`user:individual`]})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Get overview`}),` is the endpoint that provides a summary of the user’s KYC process.`]}),`\n`,_jsxs(_components.p,{children:[`By default, only the status of each KYC process is included in the response.\nIf you need detailed information, you can use the `,_jsx(_components.code,{children:`detailed`}),` query parameter to specify the KYC processes you want more detail, which will bring\ntheir `,_jsx(_components.code,{children:`input`}),`, `,_jsx(_components.code,{children:`output`}),` fields as well as `,_jsx(_components.code,{children:`hint`}),` if applicable.`]}),`\n`,_jsx(Note,{children:`Getting the detailed KYC information is more expensive in terms of performance and should be used only when necessary.`}),`\n`,_jsx(Heading,{level:`2`,id:`overall-status`,children:`Overall status`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`summary`}),` object describes the user’s overall standing, independently of the individual processes:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pending`})}),_jsx(_components.td,{children:`The platform is still expecting information from the user.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ok`})}),_jsx(_components.td,{children:`The user has been verified.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`restricted`})}),_jsxs(_components.td,{children:[`The user has been verified but the platform has limited certain `,_jsx(_components.a,{href:`/rest-apis/core-api/capabilities`,children:`capabilities`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`blocked`})}),_jsx(_components.td,{children:`The user is not allowed to operate on the platform.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`The accompanying `,_jsx(_components.code,{children:`reason`}),` field carries additional context for the current status, and is `,_jsx(_components.code,{children:`none`}),` when there is nothing further to report.`]})]})}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 get /core/kyc","title":"Get overview","description":"Get the KYC overview of an individual user.","href":"/rest-apis/core-api/kyc/get-overview"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[156,780,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Overall status","slug":"overall-status","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.get-kyc-overview","summary":"Get overview","description":"Get the KYC overview of an individual user.","tags":["KYC"],"x-uphold":{"security":{"OAuth2":{"subjects":["user:individual"]}}},"security":["6bcf598a-8ffd-4e9f-ae98-7002562b5b5b"],"parameters":["28cd0515-f6f9-49f6-a3ca-548a736092a2","1a54b2f6-d6c4-460a-a990-edc6548bd5a0"],"responses":{"200":"c4a71ff9-9100-46ea-b477-6c7517d381f7","409":"0bb180a5-8c64-4b36-85af-071ebb44b234"},"method":"get","type":"path","servers":["1bf44ae3-9719-4ab2-8015-0dae068a8d01","226066c3-4d97-4b49-be47-5af89fbf345c"],"path":"/core/kyc","baseUrlOptions":["https://api.enterprise.sandbox.uphold.com","https://api.enterprise.uphold.com"],"title":"Get overview","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"28cd0515-f6f9-49f6-a3ca-548a736092a2":{"name":"detailed","in":"query","description":"Include detailed information about the specified KYC processes. Use this sparingly as its more expensive to retrieve.","explode":false,"schema":{"type":"array","maxItems":20,"uniqueItems":true,"items":{"type":"string","enum":["profile","address","email","phone","identity","proofOfAddress","customerDueDiligence","enhancedDueDiligence","cryptoRiskAssessment","selfCategorizationStatement","taxDetails","screening","risk"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Include detailed information about the specified KYC processes. Use this sparingly as its more expensive to retrieve.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"examples":{"Detailed KYC Processes":{"value":["identity","proofOfAddress"]}}},"1a54b2f6-d6c4-460a-a990-edc6548bd5a0":{"name":"Accept-Language","description":"The natural language and locale that the client prefers.","in":"header","schema":{"type":"string","description":"The natural language and locale that the client prefers.","uniqueKey":"","typeLabel":"string"},"examples":{"English (UK)":{"value":"en-GB"}}}},"responses":{"c4a71ff9-9100-46ea-b477-6c7517d381f7":{"description":"KYC overview retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"summary":{"type":"object","properties":{"status":{"description":"The overall KYC status.","type":"string","enum":["blocked","ok","pending","restricted"],"isRequired":true,"uniqueKey":"summary.status","typeLabel":"enum\u003cstring>"},"reason":{"description":"Additional reason for the status.","type":"string","isRequired":true,"uniqueKey":"summary.reason","typeLabel":"string"}},"required":["status","reason"],"isRequired":true,"uniqueKey":"summary","typeLabel":"object"},"processes":{"type":"object","properties":{"profile":{"type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.profile.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.profile.status","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.profile.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.profile.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.profile.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.profile.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.profile.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.profile.verification.triggers","typeLabel":"enum\u003cstring>[]"},"rules":{"type":"object","properties":{"fullName":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.fullName.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.fullName.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.fullName","typeLabel":"object"},"birthdate":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthdate.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthdate.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.birthdate","typeLabel":"object"},"birthplace":{"type":"object","description":"The process verification rule.","required":["editable","presence"],"properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthplace.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthplace.editable","typeLabel":"boolean"},"rules":{"type":"object","properties":{"country":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthplace.rules.country.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthplace.rules.country.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.birthplace.rules.country","typeLabel":"object"},"town":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthplace.rules.town.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.birthplace.rules.town.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.birthplace.rules.town","typeLabel":"object"}},"uniqueKey":"processes.profile.verification.rules.birthplace.rules","typeLabel":"object"}},"uniqueKey":"processes.profile.verification.rules.birthplace","typeLabel":"object"},"citizenshipCountry":{"type":"object","description":"The process verification rule.","required":["editable","presence"],"deprecated":true,"properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.citizenshipCountry.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.citizenshipCountry.editable","typeLabel":"boolean"}},"uniqueKey":"processes.profile.verification.rules.citizenshipCountry","typeLabel":"object"},"primaryCitizenship":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.primaryCitizenship.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.primaryCitizenship.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.primaryCitizenship","typeLabel":"object"},"otherCitizenships":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.otherCitizenships.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.otherCitizenships.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.otherCitizenships","typeLabel":"object"},"address":{"type":"object","description":"The process verification rule.","required":["editable","presence"],"properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.editable","typeLabel":"boolean"},"rules":{"type":"object","properties":{"subdivision":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.subdivision.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.subdivision.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.address.rules.subdivision","typeLabel":"object"},"city":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.city.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.city.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.address.rules.city","typeLabel":"object"},"line1":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.line1.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.line1.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.address.rules.line1","typeLabel":"object"},"line2":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.line2.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.line2.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.address.rules.line2","typeLabel":"object"},"postalCode":{"description":"The process verification rule.","type":"object","properties":{"presence":{"type":"string","enum":["required","optional","disallowed"],"isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.postalCode.presence","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","isRequired":true,"uniqueKey":"processes.profile.verification.rules.address.rules.postalCode.editable","typeLabel":"boolean"}},"required":["editable","presence"],"uniqueKey":"processes.profile.verification.rules.address.rules.postalCode","typeLabel":"object"}},"uniqueKey":"processes.profile.verification.rules.address.rules","typeLabel":"object"}},"uniqueKey":"processes.profile.verification.rules.address","typeLabel":"object"}},"uniqueKey":"processes.profile.verification.rules","typeLabel":"object"}},"uniqueKey":"processes.profile.verification","typeLabel":"object"},"input":{"description":"The declared profile details.","type":"object","properties":{"fullName":{"description":"The full legal name.","type":"string","uniqueKey":"processes.profile.input.fullName","typeLabel":"string"},"birthdate":{"description":"The date of birth.","type":"string","format":"date","uniqueKey":"processes.profile.input.birthdate","typeLabel":"string\u003cdate>"},"birthplace":{"description":"The place of birth.","type":"object","properties":{"country":{"description":"The country of birth.","type":"string","isRequired":true,"uniqueKey":"processes.profile.input.birthplace.country","typeLabel":"string"},"town":{"description":"The town of birth.","type":"string","isRequired":true,"uniqueKey":"processes.profile.input.birthplace.town","typeLabel":"string"}},"required":["country","town"],"uniqueKey":"processes.profile.input.birthplace","typeLabel":"object"},"primaryCitizenship":{"description":"The primary citizenship country.","type":"string","uniqueKey":"processes.profile.input.primaryCitizenship","typeLabel":"string"},"citizenshipCountry":{"deprecated":true,"description":"The citizenship country. Deprecated in favor of primaryCitizenship.","type":"string","uniqueKey":"processes.profile.input.citizenshipCountry","typeLabel":"string"},"otherCitizenships":{"description":"Additional citizenship countries.","type":"array","items":{"type":"string","uniqueKey":"processes.profile.input.otherCitizenships.items.[INDEX]","typeLabel":"string"},"uniqueKey":"processes.profile.input.otherCitizenships","typeLabel":"string[]"},"address":{"type":"object","description":"The address information.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"processes.profile.input.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.profile.input.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.profile.input.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.profile.input.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.profile.input.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.profile.input.address.postalCode","typeLabel":"string"}},"uniqueKey":"processes.profile.input.address","typeLabel":"object"},"details":{"deprecated":true,"description":"Dynamic form input following the [JSON Forms](https://jsonforms.io/) specification. Deprecated in favor of the flat profile fields.","type":"object","additionalProperties":true,"uniqueKey":"processes.profile.input.details","typeLabel":"object"}},"uniqueKey":"processes.profile.input","typeLabel":"object"},"hint":{"type":"object","description":"The hints for the KYC process. Deprecated in favor of verification.rules.","required":["type","schema","uiSchema"],"deprecated":true,"properties":{"type":{"description":"The type of the hint.","type":"string","enum":["form"],"isRequired":true,"uniqueKey":"processes.profile.hint.type","typeLabel":"enum\u003cstring>"},"schema":{"description":"The definition of the structure and validation rules for this KYC process form.\n\nIt follows the [JSON Schema](https://json-schema.org/) specification with the power of [JSON Forms](https://jsonforms.io/).\n\nThe schema is iterative, meaning that new questions and properties can be added dynamically as the KYC process evolves. This allows for a flexible and adaptive form structure that can accommodate changes and new requirements over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.profile.hint.schema","typeLabel":"object"},"uiSchema":{"description":"The definition of the general layout and presentation of the form by means of different UI schema elements.\n\nIt follows the [JSON Forms](https://jsonforms.io/) specification and is used to customize the appearance and behavior of the form fields.\n\nThe `uiSchema` includes the following elements:\n\n- `Layouts`: Used to structure the form layout. It includes properties like `type` to define the layout type (e.g., `Categorization`) and `elements` to define the child elements.\n- `Controls`: Used to define the form controls. It includes properties like `scope` to point to the corresponding schema property and `label` to define the control's label.\n- `Rules`: Used to define conditional visibility rules for form controls. It includes properties like `effect` to define the rule effect (e.g., `SHOW`) and `condition` to define the rule condition.\n\nThe `uiSchema` is iterative, meaning that new controls and layout elements can be added dynamically as the KYC process evolves. This allows for a flexible and dynamic form layout, enhancing the user experience by providing a structured and intuitive form design that can adapt to new requirements and changes over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.profile.hint.uiSchema","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","format":"uuid","uniqueKey":"processes.profile.hint.formId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"processes.profile.hint","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.profile","typeLabel":"object"},"address":{"type":"object","description":"The KYC address object.","required":["code","status"],"deprecated":true,"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.address.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.address.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.address.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.address.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.address.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.address.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.address.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.address.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.address.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"address":{"type":"object","description":"The address information.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"processes.address.input.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.address.input.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.address.input.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.address.input.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.address.input.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.address.input.address.postalCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"processes.address.input.address","typeLabel":"object"}},"required":["address"],"uniqueKey":"processes.address.input","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.address","typeLabel":"object"},"email":{"description":"The KYC email object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.email.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.email.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.email.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.email.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.email.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.email.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.email.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.email.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.email.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"email":{"description":"The email address that was verified.","type":"string","format":"email","isRequired":true,"uniqueKey":"processes.email.input.email","typeLabel":"string\u003cemail>"}},"required":["email"],"uniqueKey":"processes.email.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.email.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"required":["verifiedAt"],"uniqueKey":"processes.email.output","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.email","typeLabel":"object"},"phone":{"description":"The KYC phone object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.phone.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.phone.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.phone.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.phone.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.phone.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.phone.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.phone.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.phone.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.phone.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"phone":{"description":"The E.164 formatted phone number that was verified.","type":"string","isRequired":true,"uniqueKey":"processes.phone.input.phone","typeLabel":"string"},"country":{"description":"The country code of the phone number.","type":"string","isRequired":true,"uniqueKey":"processes.phone.input.country","typeLabel":"string"}},"required":["phone","country"],"uniqueKey":"processes.phone.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.phone.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"required":["verifiedAt"],"uniqueKey":"processes.phone.output","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.phone","typeLabel":"object"},"identity":{"oneOf":[{"type":"object","title":"None","description":"The KYC identity object.","required":["code","status"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.0.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.0.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The identity submission type.","type":"string","enum":["none"],"uniqueKey":"processes.identity.oneOf.0.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.0.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.0.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.identity.oneOf.0.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.identity.oneOf.0.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.identity.oneOf.0.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.identity.oneOf.0.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.identity.oneOf.0.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.identity.oneOf.0.verification","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.identity.oneOf.0","typeLabel":"None · object"},{"type":"object","title":"Document submission","description":"The KYC identity object.","required":["code","status","type"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The identity submission type.","type":"string","enum":["document-submission"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.identity.oneOf.1.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.identity.oneOf.1.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.identity.oneOf.1.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.identity.oneOf.1.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"media":{"description":"The media that was collected during the process.","type":"array","items":{"type":"object","properties":{"context":{"description":"The context of the file.","type":"string","enum":["photo-document-front","photo-document-back","photo-selfie","photo-selfie-and-document-front","video"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.input.media.items.[INDEX].context","typeLabel":"enum\u003cstring>"},"fileId":{"description":"The id of the file.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.input.media.items.[INDEX].fileId","typeLabel":"string\u003cuuid>"}},"required":["context","fileId"],"uniqueKey":"processes.identity.oneOf.1.input.media.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.input.media","typeLabel":"object[]"}},"required":["media"],"uniqueKey":"processes.identity.oneOf.1.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"provider":{"description":"The provider used to verify the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.provider","typeLabel":"string"},"document":{"description":"The identity document information.","type":"object","properties":{"type":{"description":"The type of the document.","type":"string","enum":["driving-license","id-card","passport","residence-permit","unsupported"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.document.type","typeLabel":"enum\u003cstring>"},"number":{"description":"The number of the document.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.document.number","typeLabel":"string"},"country":{"description":"The country of the document.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.document.country","typeLabel":"string"},"expiresAt":{"description":"The expiration date of the document.","type":"string","format":"date","uniqueKey":"processes.identity.oneOf.1.output.document.expiresAt","typeLabel":"string\u003cdate>"}},"required":["type","number","country"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.document","typeLabel":"object"},"person":{"description":"The person information.","type":"object","properties":{"givenName":{"description":"The person's given name.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.person.givenName","typeLabel":"string"},"birthdate":{"description":"The date of birth.","type":"string","format":"date","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.person.birthdate","typeLabel":"string\u003cdate>"},"familyName":{"description":"The person's family name or surname.","type":"string","uniqueKey":"processes.identity.oneOf.1.output.person.familyName","typeLabel":"string"},"gender":{"description":"The gender.","type":"string","enum":["female","male"],"uniqueKey":"processes.identity.oneOf.1.output.person.gender","typeLabel":"enum\u003cstring>"},"address":{"type":"object","description":"The address information.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.person.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.identity.oneOf.1.output.person.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.identity.oneOf.1.output.person.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.identity.oneOf.1.output.person.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.identity.oneOf.1.output.person.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.identity.oneOf.1.output.person.address.postalCode","typeLabel":"string"}},"uniqueKey":"processes.identity.oneOf.1.output.person.address","typeLabel":"object"}},"required":["givenName","birthdate"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.person","typeLabel":"object"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.identity.oneOf.1.output.verifiedAt","typeLabel":"string\u003cdate-time>"},"providerDetails":{"description":"The provider details associated with the verification.","type":"object","properties":{"reasons":{"description":"The reasons associated with the verification.","type":"array","items":{"type":"string","uniqueKey":"processes.identity.oneOf.1.output.providerDetails.reasons.items.[INDEX]","typeLabel":"string"},"uniqueKey":"processes.identity.oneOf.1.output.providerDetails.reasons","typeLabel":"string[]"}},"uniqueKey":"processes.identity.oneOf.1.output.providerDetails","typeLabel":"object"},"reason":{"description":"The reason associated with the verification.","type":"string","enum":["data-mismatch","duplicate","underage","provider-verification-rejected"],"uniqueKey":"processes.identity.oneOf.1.output.reason","typeLabel":"enum\u003cstring>"}},"required":["provider","document","person","verifiedAt"],"uniqueKey":"processes.identity.oneOf.1.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.identity.oneOf.1","typeLabel":"Document submission · object"},{"type":"object","title":"Electronic verification","description":"The KYC identity object.","required":["code","status","type"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.2.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The identity submission type.","type":"string","enum":["electronic-verification"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.2.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.2.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.2.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.identity.oneOf.2.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.identity.oneOf.2.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.identity.oneOf.2.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.identity.oneOf.2.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.identity.oneOf.2.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"data":{"description":"The declared data used to verify the process.","type":"object","properties":{"givenName":{"description":"The given name.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.input.data.givenName","typeLabel":"string"},"birthdate":{"description":"The date of birth.","type":"string","format":"date","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.input.data.birthdate","typeLabel":"string\u003cdate>"},"citizenshipCountry":{"description":"The citizenship country.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.input.data.citizenshipCountry","typeLabel":"string"},"familyName":{"description":"The family name or surname.","type":"string","uniqueKey":"processes.identity.oneOf.2.input.data.familyName","typeLabel":"string"},"gender":{"description":"The gender.","type":"string","enum":["female","male"],"uniqueKey":"processes.identity.oneOf.2.input.data.gender","typeLabel":"enum\u003cstring>"},"address":{"type":"object","description":"The address information.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.input.data.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.identity.oneOf.2.input.data.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.identity.oneOf.2.input.data.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.identity.oneOf.2.input.data.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.identity.oneOf.2.input.data.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.identity.oneOf.2.input.data.address.postalCode","typeLabel":"string"}},"uniqueKey":"processes.identity.oneOf.2.input.data.address","typeLabel":"object"}},"required":["givenName","birthdate","citizenshipCountry"],"isRequired":true,"uniqueKey":"processes.identity.oneOf.2.input.data","typeLabel":"object"}},"required":["data"],"uniqueKey":"processes.identity.oneOf.2.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"provider":{"description":"The provider used to verify the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.output.provider","typeLabel":"string"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.identity.oneOf.2.output.verifiedAt","typeLabel":"string\u003cdate-time>"},"reason":{"description":"The reason associated with the verification.","type":"string","enum":["data-mismatch","duplicate","missing-declared-information","underage"],"uniqueKey":"processes.identity.oneOf.2.output.reason","typeLabel":"enum\u003cstring>"}},"required":["provider","verifiedAt"],"uniqueKey":"processes.identity.oneOf.2.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.identity.oneOf.2","typeLabel":"Electronic verification · object"}],"isRequired":true,"uniqueKey":"processes.identity","typeLabel":"None · object | Document submission · object | Electronic verification · object"},"proofOfAddress":{"oneOf":[{"type":"object","title":"None","description":"The KYC proof-of-address object.","required":["code","status"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The proof-of-address submission type.","type":"string","enum":["none"],"uniqueKey":"processes.proofOfAddress.oneOf.0.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.proofOfAddress.oneOf.0.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.proofOfAddress.oneOf.0.verification","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.0","typeLabel":"None · object"},{"type":"object","title":"Document submission","description":"The KYC proof-of-address object.","required":["code","status","type"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The proof-of-address submission type.","type":"string","enum":["document-submission"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.proofOfAddress.oneOf.1.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.proofOfAddress.oneOf.1.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"media":{"description":"The media that was collected during the process.","type":"array","items":{"type":"object","properties":{"context":{"description":"The context of the file.","type":"string","enum":["address-proof"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.input.media.items.[INDEX].context","typeLabel":"enum\u003cstring>"},"fileId":{"description":"The id of the file.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.input.media.items.[INDEX].fileId","typeLabel":"string\u003cuuid>"}},"required":["context","fileId"],"uniqueKey":"processes.proofOfAddress.oneOf.1.input.media.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.input.media","typeLabel":"object[]"}},"required":["media"],"uniqueKey":"processes.proofOfAddress.oneOf.1.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"provider":{"description":"The provider used to verify the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.output.provider","typeLabel":"string"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1.output.verifiedAt","typeLabel":"string\u003cdate-time>"},"providerDetails":{"description":"The provider details associated with the verification.","type":"object","properties":{"reasons":{"description":"The reasons associated with the verification.","type":"array","items":{"type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.providerDetails.reasons.items.[INDEX]","typeLabel":"string"},"uniqueKey":"processes.proofOfAddress.oneOf.1.output.providerDetails.reasons","typeLabel":"string[]"}},"uniqueKey":"processes.proofOfAddress.oneOf.1.output.providerDetails","typeLabel":"object"},"reason":{"description":"The reason associated with the verification.","type":"string","enum":["address-mismatch","name-mismatch","provider-verification-rejected"],"uniqueKey":"processes.proofOfAddress.oneOf.1.output.reason","typeLabel":"enum\u003cstring>"},"person":{"description":"The person information.","type":"object","properties":{"givenName":{"description":"The person's given name.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.givenName","typeLabel":"string"},"familyName":{"description":"The person's family name or surname.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.familyName","typeLabel":"string"},"address":{"type":"object","description":"The address information.","properties":{"country":{"description":"The country of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address.postalCode","typeLabel":"string"}},"uniqueKey":"processes.proofOfAddress.oneOf.1.output.person.address","typeLabel":"object"}},"uniqueKey":"processes.proofOfAddress.oneOf.1.output.person","typeLabel":"object"}},"required":["provider","verifiedAt"],"uniqueKey":"processes.proofOfAddress.oneOf.1.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.1","typeLabel":"Document submission · object"},{"type":"object","title":"Electronic verification","description":"The KYC proof-of-address object.","required":["code","status","type"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The proof-of-address submission type.","type":"string","enum":["electronic-verification"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.proofOfAddress.oneOf.2.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.proofOfAddress.oneOf.2.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"data":{"description":"The declared data used to verify the process.","type":"object","properties":{"givenName":{"description":"The given name.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.givenName","typeLabel":"string"},"address":{"type":"object","description":"The address information.","required":["country"],"properties":{"country":{"description":"The country of the address.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address.postalCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.address","typeLabel":"object"},"familyName":{"description":"The family name or surname.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.2.input.data.familyName","typeLabel":"string"}},"required":["givenName","address"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.input.data","typeLabel":"object"}},"required":["data"],"uniqueKey":"processes.proofOfAddress.oneOf.2.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"provider":{"description":"The provider used to verify the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.output.provider","typeLabel":"string"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2.output.verifiedAt","typeLabel":"string\u003cdate-time>"},"reason":{"description":"The reason associated with the verification.","type":"string","enum":["address-mismatch","name-mismatch"],"uniqueKey":"processes.proofOfAddress.oneOf.2.output.reason","typeLabel":"enum\u003cstring>"}},"required":["provider","verifiedAt"],"uniqueKey":"processes.proofOfAddress.oneOf.2.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.2","typeLabel":"Electronic verification · object"},{"type":"object","title":"From identity","description":"The KYC proof-of-address object.","required":["code","status","type"],"properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.status","typeLabel":"enum\u003cstring>"},"type":{"description":"The proof-of-address submission type.","type":"string","enum":["from-identity"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.type","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","description":"Configuration of this process.","required":["submittable","model","method","dependencies"],"properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"submittable":{"description":"Whether this process currently accepts a new submission.","type":"boolean","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.submittable","typeLabel":"boolean"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.proofOfAddress.oneOf.3.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"processes.proofOfAddress.oneOf.3.verification","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"provider":{"description":"The provider used to verify the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.output.provider","typeLabel":"string"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3.output.verifiedAt","typeLabel":"string\u003cdate-time>"},"reason":{"description":"The reason associated with the verification.","type":"string","enum":["address-mismatch","name-mismatch"],"uniqueKey":"processes.proofOfAddress.oneOf.3.output.reason","typeLabel":"enum\u003cstring>"},"person":{"description":"The person information.","type":"object","properties":{"givenName":{"description":"The person's given name.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.givenName","typeLabel":"string"},"familyName":{"description":"The person's family name or surname.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.familyName","typeLabel":"string"},"address":{"type":"object","description":"The address information.","properties":{"country":{"description":"The country of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address.country","typeLabel":"string"},"subdivision":{"description":"The subdivision of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address.subdivision","typeLabel":"string"},"city":{"description":"The city of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address.city","typeLabel":"string"},"line1":{"description":"The first line of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address.line1","typeLabel":"string"},"line2":{"description":"The second line of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address.line2","typeLabel":"string"},"postalCode":{"description":"The postal code of the address.","type":"string","uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address.postalCode","typeLabel":"string"}},"uniqueKey":"processes.proofOfAddress.oneOf.3.output.person.address","typeLabel":"object"}},"uniqueKey":"processes.proofOfAddress.oneOf.3.output.person","typeLabel":"object"}},"required":["provider","verifiedAt"],"uniqueKey":"processes.proofOfAddress.oneOf.3.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"processes.proofOfAddress.oneOf.3","typeLabel":"From identity · object"}],"isRequired":true,"uniqueKey":"processes.proofOfAddress","typeLabel":"None · object | Document submission · object | Electronic verification · object | From identity · object"},"customerDueDiligence":{"description":"The KYC customer due diligence object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.customerDueDiligence.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.customerDueDiligence.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.customerDueDiligence.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.customerDueDiligence.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.customerDueDiligence.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.customerDueDiligence.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.customerDueDiligence.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.customerDueDiligence.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.customerDueDiligence.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"answers":{"description":"The answers of the form.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.customerDueDiligence.input.answers","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","uniqueKey":"processes.customerDueDiligence.input.formId","typeLabel":"string"}},"required":["answers"],"uniqueKey":"processes.customerDueDiligence.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"score":{"type":"string","enum":["low","medium","high"],"description":"The score of the verification.","uniqueKey":"processes.customerDueDiligence.output.score","typeLabel":"enum\u003cstring>"},"expiresAt":{"type":"string","format":"date-time","description":"The date and time when the verification expires.","uniqueKey":"processes.customerDueDiligence.output.expiresAt","typeLabel":"string\u003cdate-time>"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","uniqueKey":"processes.customerDueDiligence.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"processes.customerDueDiligence.output","typeLabel":"object"},"hint":{"description":"The hint for the KYC process.","type":"object","properties":{"type":{"description":"The type of the hint.","type":"string","enum":["form"],"isRequired":true,"uniqueKey":"processes.customerDueDiligence.hint.type","typeLabel":"enum\u003cstring>"},"schema":{"description":"The definition of the structure and validation rules for this KYC process form.\n\nIt follows the [JSON Schema](https://json-schema.org/) specification with the power of [JSON Forms](https://jsonforms.io/).\n\nThe schema is iterative, meaning that new questions and properties can be added dynamically as the KYC process evolves. This allows for a flexible and adaptive form structure that can accommodate changes and new requirements over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.customerDueDiligence.hint.schema","typeLabel":"object"},"uiSchema":{"description":"The definition of the general layout and presentation of the form by means of different UI schema elements.\n\nIt follows the [JSON Forms](https://jsonforms.io/) specification and is used to customize the appearance and behavior of the form fields.\n\nThe `uiSchema` includes the following elements:\n\n- `Layouts`: Used to structure the form layout. It includes properties like `type` to define the layout type (e.g., `Categorization`) and `elements` to define the child elements.\n- `Controls`: Used to define the form controls. It includes properties like `scope` to point to the corresponding schema property and `label` to define the control's label.\n- `Rules`: Used to define conditional visibility rules for form controls. It includes properties like `effect` to define the rule effect (e.g., `SHOW`) and `condition` to define the rule condition.\n\nThe `uiSchema` is iterative, meaning that new controls and layout elements can be added dynamically as the KYC process evolves. This allows for a flexible and dynamic form layout, enhancing the user experience by providing a structured and intuitive form design that can adapt to new requirements and changes over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.customerDueDiligence.hint.uiSchema","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","format":"uuid","uniqueKey":"processes.customerDueDiligence.hint.formId","typeLabel":"string\u003cuuid>"}},"required":["type","schema","uiSchema"],"uniqueKey":"processes.customerDueDiligence.hint","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.customerDueDiligence","typeLabel":"object"},"enhancedDueDiligence":{"description":"The KYC enhanced due diligence object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.enhancedDueDiligence.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.enhancedDueDiligence.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.enhancedDueDiligence.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.enhancedDueDiligence.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"media":{"type":"array","items":{"type":"object","properties":{"context":{"description":"The context of the file.","type":"string","enum":["source-of-funds-proof"],"isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.input.media.items.[INDEX].context","typeLabel":"enum\u003cstring>"},"fileId":{"description":"The id of the file.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.input.media.items.[INDEX].fileId","typeLabel":"string\u003cuuid>"}},"required":["context","fileId"],"uniqueKey":"processes.enhancedDueDiligence.input.media.items.[INDEX]","typeLabel":"object"},"uniqueKey":"processes.enhancedDueDiligence.input.media","typeLabel":"object[]"}},"uniqueKey":"processes.enhancedDueDiligence.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.enhancedDueDiligence.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"required":["verifiedAt"],"uniqueKey":"processes.enhancedDueDiligence.output","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.enhancedDueDiligence","typeLabel":"object"},"cryptoRiskAssessment":{"description":"The KYC crypto risk assessment object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.cryptoRiskAssessment.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.cryptoRiskAssessment.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.cryptoRiskAssessment.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.cryptoRiskAssessment.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"answers":{"description":"The answers of the form.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.input.answers","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","uniqueKey":"processes.cryptoRiskAssessment.input.formId","typeLabel":"string"}},"required":["answers"],"uniqueKey":"processes.cryptoRiskAssessment.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"result":{"description":"The result of the verification.","type":"string","enum":["approved","rejected"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.output.result","typeLabel":"enum\u003cstring>"},"attempts":{"description":"The attempts state of the verification.","type":"object","properties":{"used":{"description":"The number of attempts used.","type":"integer","isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.output.attempts.used","typeLabel":"integer"},"maximum":{"description":"The maximum number of attempts.","type":"integer","isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.output.attempts.maximum","typeLabel":"integer"},"retryAt":{"description":"The date and time when the next attempt is allowed.","type":"string","format":"date-time","uniqueKey":"processes.cryptoRiskAssessment.output.attempts.retryAt","typeLabel":"string\u003cdate-time>"}},"required":["used","maximum"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.output.attempts","typeLabel":"object"},"offboard":{"description":"The offboarding state of the verification.","type":"object","properties":{"endsAt":{"description":"The date and time when the offboard ends.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.output.offboard.endsAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"description":"The date and time when the offboarding was completed.","type":"string","format":"date-time","uniqueKey":"processes.cryptoRiskAssessment.output.offboard.completedAt","typeLabel":"string\u003cdate-time>"}},"required":["endsAt"],"uniqueKey":"processes.cryptoRiskAssessment.output.offboard","typeLabel":"object"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","uniqueKey":"processes.cryptoRiskAssessment.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"required":["result","attempts"],"uniqueKey":"processes.cryptoRiskAssessment.output","typeLabel":"object"},"hint":{"description":"The hint for the KYC process.","type":"object","properties":{"type":{"description":"The type of the hint.","type":"string","enum":["form"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.hint.type","typeLabel":"enum\u003cstring>"},"schema":{"description":"The definition of the structure and validation rules for this KYC process form.\n\nIt follows the [JSON Schema](https://json-schema.org/) specification with the power of [JSON Forms](https://jsonforms.io/).\n\nThe schema is iterative, meaning that new questions and properties can be added dynamically as the KYC process evolves. This allows for a flexible and adaptive form structure that can accommodate changes and new requirements over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.hint.schema","typeLabel":"object"},"uiSchema":{"description":"The definition of the general layout and presentation of the form by means of different UI schema elements.\n\nIt follows the [JSON Forms](https://jsonforms.io/) specification and is used to customize the appearance and behavior of the form fields.\n\nThe `uiSchema` includes the following elements:\n\n- `Layouts`: Used to structure the form layout. It includes properties like `type` to define the layout type (e.g., `Categorization`) and `elements` to define the child elements.\n- `Controls`: Used to define the form controls. It includes properties like `scope` to point to the corresponding schema property and `label` to define the control's label.\n- `Rules`: Used to define conditional visibility rules for form controls. It includes properties like `effect` to define the rule effect (e.g., `SHOW`) and `condition` to define the rule condition.\n\nThe `uiSchema` is iterative, meaning that new controls and layout elements can be added dynamically as the KYC process evolves. This allows for a flexible and dynamic form layout, enhancing the user experience by providing a structured and intuitive form design that can adapt to new requirements and changes over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment.hint.uiSchema","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","format":"uuid","uniqueKey":"processes.cryptoRiskAssessment.hint.formId","typeLabel":"string\u003cuuid>"}},"required":["type","schema","uiSchema"],"uniqueKey":"processes.cryptoRiskAssessment.hint","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.cryptoRiskAssessment","typeLabel":"object"},"selfCategorizationStatement":{"description":"The KYC self-categorization statement object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.selfCategorizationStatement.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.selfCategorizationStatement.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.selfCategorizationStatement.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.selfCategorizationStatement.verification","typeLabel":"object"},"input":{"description":"Input of the KYC process.","type":"object","properties":{"answers":{"description":"The answers of the form.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.input.answers","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","uniqueKey":"processes.selfCategorizationStatement.input.formId","typeLabel":"string"}},"required":["answers"],"uniqueKey":"processes.selfCategorizationStatement.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"result":{"description":"The result of the verification.","type":"string","enum":["approved","rejected"],"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.output.result","typeLabel":"enum\u003cstring>"},"attempts":{"description":"The attempts state of the verification.","type":"object","properties":{"used":{"description":"The number of attempts used.","type":"integer","isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.output.attempts.used","typeLabel":"integer"},"maximum":{"description":"The maximum number of attempts.","type":"integer","isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.output.attempts.maximum","typeLabel":"integer"}},"required":["used","maximum"],"uniqueKey":"processes.selfCategorizationStatement.output.attempts","typeLabel":"object"},"offboard":{"description":"The offboarding state of the verification.","type":"object","properties":{"endsAt":{"description":"The date and time when the offboard ends.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.output.offboard.endsAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"description":"The date and time when the offboarding was completed.","type":"string","format":"date-time","uniqueKey":"processes.selfCategorizationStatement.output.offboard.completedAt","typeLabel":"string\u003cdate-time>"}},"required":["endsAt"],"uniqueKey":"processes.selfCategorizationStatement.output.offboard","typeLabel":"object"},"expiresAt":{"type":"string","format":"date-time","description":"The date and time when the verification expires.","uniqueKey":"processes.selfCategorizationStatement.output.expiresAt","typeLabel":"string\u003cdate-time>"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","uniqueKey":"processes.selfCategorizationStatement.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"required":["result"],"uniqueKey":"processes.selfCategorizationStatement.output","typeLabel":"object"},"hint":{"description":"The hint for the KYC process.","type":"object","properties":{"type":{"description":"The type of the hint.","type":"string","enum":["form"],"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.hint.type","typeLabel":"enum\u003cstring>"},"schema":{"description":"The definition of the structure and validation rules for this KYC process form.\n\nIt follows the [JSON Schema](https://json-schema.org/) specification with the power of [JSON Forms](https://jsonforms.io/).\n\nThe schema is iterative, meaning that new questions and properties can be added dynamically as the KYC process evolves. This allows for a flexible and adaptive form structure that can accommodate changes and new requirements over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.hint.schema","typeLabel":"object"},"uiSchema":{"description":"The definition of the general layout and presentation of the form by means of different UI schema elements.\n\nIt follows the [JSON Forms](https://jsonforms.io/) specification and is used to customize the appearance and behavior of the form fields.\n\nThe `uiSchema` includes the following elements:\n\n- `Layouts`: Used to structure the form layout. It includes properties like `type` to define the layout type (e.g., `Categorization`) and `elements` to define the child elements.\n- `Controls`: Used to define the form controls. It includes properties like `scope` to point to the corresponding schema property and `label` to define the control's label.\n- `Rules`: Used to define conditional visibility rules for form controls. It includes properties like `effect` to define the rule effect (e.g., `SHOW`) and `condition` to define the rule condition.\n\nThe `uiSchema` is iterative, meaning that new controls and layout elements can be added dynamically as the KYC process evolves. This allows for a flexible and dynamic form layout, enhancing the user experience by providing a structured and intuitive form design that can adapt to new requirements and changes over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement.hint.uiSchema","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","format":"uuid","uniqueKey":"processes.selfCategorizationStatement.hint.formId","typeLabel":"string\u003cuuid>"}},"required":["type","schema","uiSchema"],"uniqueKey":"processes.selfCategorizationStatement.hint","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.selfCategorizationStatement","typeLabel":"object"},"taxDetails":{"description":"The KYC tax details object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.taxDetails.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.taxDetails.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.taxDetails.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.taxDetails.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.taxDetails.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.taxDetails.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.taxDetails.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.taxDetails.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.taxDetails.verification","typeLabel":"object"},"input":{"description":"The declared tax details.","type":"object","additionalProperties":true,"minProperties":1,"uniqueKey":"processes.taxDetails.input","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"result":{"description":"The result of the verification.","type":"string","enum":["approved","rejected"],"isRequired":true,"uniqueKey":"processes.taxDetails.output.result","typeLabel":"enum\u003cstring>"},"verifiedAt":{"description":"The date and time of the verification.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"processes.taxDetails.output.verifiedAt","typeLabel":"string\u003cdate-time>"}},"required":["result","verifiedAt"],"uniqueKey":"processes.taxDetails.output","typeLabel":"object"},"hint":{"description":"The hint for the KYC process.","type":"object","properties":{"type":{"description":"The type of the hint.","type":"string","enum":["form"],"isRequired":true,"uniqueKey":"processes.taxDetails.hint.type","typeLabel":"enum\u003cstring>"},"schema":{"description":"The definition of the structure and validation rules for this KYC process form.\n\nIt follows the [JSON Schema](https://json-schema.org/) specification with the power of [JSON Forms](https://jsonforms.io/).\n\nThe schema is iterative, meaning that new questions and properties can be added dynamically as the KYC process evolves. This allows for a flexible and adaptive form structure that can accommodate changes and new requirements over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.taxDetails.hint.schema","typeLabel":"object"},"uiSchema":{"description":"The definition of the general layout and presentation of the form by means of different UI schema elements.\n\nIt follows the [JSON Forms](https://jsonforms.io/) specification and is used to customize the appearance and behavior of the form fields.\n\nThe `uiSchema` includes the following elements:\n\n- `Layouts`: Used to structure the form layout. It includes properties like `type` to define the layout type (e.g., `Categorization`) and `elements` to define the child elements.\n- `Controls`: Used to define the form controls. It includes properties like `scope` to point to the corresponding schema property and `label` to define the control's label.\n- `Rules`: Used to define conditional visibility rules for form controls. It includes properties like `effect` to define the rule effect (e.g., `SHOW`) and `condition` to define the rule condition.\n\nThe `uiSchema` is iterative, meaning that new controls and layout elements can be added dynamically as the KYC process evolves. This allows for a flexible and dynamic form layout, enhancing the user experience by providing a structured and intuitive form design that can adapt to new requirements and changes over time.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"processes.taxDetails.hint.uiSchema","typeLabel":"object"},"formId":{"description":"The id of the form.","type":"string","format":"uuid","uniqueKey":"processes.taxDetails.hint.formId","typeLabel":"string\u003cuuid>"}},"required":["type","schema","uiSchema"],"uniqueKey":"processes.taxDetails.hint","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.taxDetails","typeLabel":"object"},"screening":{"description":"The KYC screening object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.screening.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.screening.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.screening.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.screening.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.screening.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.screening.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.screening.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.screening.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.screening.verification","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"result":{"description":"The result of the verification.","type":"string","enum":["approved","rejected"],"isRequired":true,"uniqueKey":"processes.screening.output.result","typeLabel":"enum\u003cstring>"}},"required":["result"],"uniqueKey":"processes.screening.output","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.screening","typeLabel":"object"},"risk":{"description":"The KYC risk object.","type":"object","properties":{"code":{"description":"The code of the KYC process.","type":"string","isRequired":true,"uniqueKey":"processes.risk.code","typeLabel":"string"},"status":{"description":"Status of the KYC process.","type":"string","enum":["ok","failed","running","pending","exempt"],"isRequired":true,"uniqueKey":"processes.risk.status","typeLabel":"enum\u003cstring>"},"verification":{"description":"Configuration of this process.","type":"object","properties":{"model":{"description":"The verification model to complete this process.","type":"string","enum":["none","partner-verified","uphold-verified"],"isRequired":true,"uniqueKey":"processes.risk.verification.model","typeLabel":"enum\u003cstring>"},"method":{"description":"Whether this process is verified automatically in the background or requires user action.","type":"string","enum":["automatic","manual"],"isRequired":true,"uniqueKey":"processes.risk.verification.method","typeLabel":"enum\u003cstring>"},"dependencies":{"description":"The processes that must be updated before you can update this one.","type":"array","items":{"type":"string","enum":["profile","email","phone","identity","proof-of-address","customer-due-diligence","enhanced-due-diligence","crypto-risk-assessment","self-categorization-statement","tax-details"],"uniqueKey":"processes.risk.verification.dependencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"processes.risk.verification.dependencies","typeLabel":"enum\u003cstring>[]"},"triggers":{"description":"Other processes that, once updated, trigger this process to run automatically. Only present when `method` is `automatic`.","type":"array","items":{"type":"string","enum":["profile","identity"],"uniqueKey":"processes.risk.verification.triggers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"processes.risk.verification.triggers","typeLabel":"enum\u003cstring>[]"}},"required":["model","method","dependencies"],"uniqueKey":"processes.risk.verification","typeLabel":"object"},"output":{"description":"Output of the KYC process.","type":"object","properties":{"result":{"description":"The result of the verification.","type":"string","enum":["approved","rejected"],"uniqueKey":"processes.risk.output.result","typeLabel":"enum\u003cstring>"}},"uniqueKey":"processes.risk.output","typeLabel":"object"}},"required":["code","status"],"isRequired":true,"uniqueKey":"processes.risk","typeLabel":"object"}},"required":["profile","address","email","phone","identity","proofOfAddress","customerDueDiligence","enhancedDueDiligence","cryptoRiskAssessment","selfCategorizationStatement","taxDetails","screening","risk"],"isRequired":true,"uniqueKey":"processes","typeLabel":"object"}},"required":["summary","processes"],"uniqueKey":"","typeLabel":"object"},"examples":{"KYC Overview OK":{"title":"KYC Overview OK","value":{"summary":{"reason":"none","status":"ok"},"processes":{"profile":{"code":"profile","status":"ok"},"address":{"code":"address","status":"ok"},"email":{"code":"email","status":"ok"},"phone":{"code":"phone","status":"ok"},"identity":{"code":"identity","status":"ok","type":"document-submission"},"proofOfAddress":{"code":"proof-of-address","status":"ok","type":"electronic-verification"},"customerDueDiligence":{"code":"customer-due-diligence","status":"ok"},"enhancedDueDiligence":{"code":"enhanced-due-diligence","status":"ok"},"cryptoRiskAssessment":{"code":"crypto-risk-assessment","status":"ok"},"selfCategorizationStatement":{"code":"self-categorization-statement","status":"ok"},"taxDetails":{"code":"tax-details","status":"ok"},"screening":{"code":"screening","status":"ok"},"risk":{"code":"risk","status":"ok"}}}},"KYC Overview OK Fully Detailed":{"title":"KYC Overview OK Fully Detailed","value":{"summary":{"reason":"none","status":"ok"},"processes":{"profile":{"code":"profile","status":"ok","verification":{"model":"none","method":"manual","dependencies":[],"rules":{"fullName":{"presence":"required","editable":true},"birthdate":{"presence":"required","editable":true},"birthplace":{"presence":"disallowed","editable":false,"rules":{"country":{"presence":"required","editable":false},"town":{"presence":"required","editable":false}}},"primaryCitizenship":{"presence":"required","editable":true},"otherCitizenships":{"presence":"disallowed","editable":false},"address":{"presence":"required","editable":true,"rules":{"subdivision":{"presence":"optional","editable":false},"city":{"presence":"required","editable":true},"line1":{"presence":"required","editable":true},"line2":{"presence":"optional","editable":true},"postalCode":{"presence":"required","editable":true}}}}},"input":{"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"}}},"address":{"code":"address","status":"ok","verification":{"model":"none","method":"manual","dependencies":[]},"input":{"address":{"country":"GB","subdivision":"GB-MAN","city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA"}}},"email":{"code":"email","status":"ok","verification":{"model":"partner-verified","method":"manual","dependencies":[]},"input":{"email":"[email protected]"},"output":{"verifiedAt":"2020-01-01T00:00:00.000Z"}},"phone":{"code":"phone","status":"ok","verification":{"model":"partner-verified","method":"manual","dependencies":[]},"input":{"phone":"+1234567890","country":"GB"},"output":{"verifiedAt":"2020-01-01T00:00:00.000Z"}},"identity":{"code":"identity","status":"ok","type":"document-submission","verification":{"model":"partner-verified","method":"manual","dependencies":["phone","profile"],"submittable":false},"input":{"media":[{"context":"photo-selfie","fileId":"470b2192-893f-4ce6-9daa-816d4c319a84"}]},"output":{"provider":"veriff","document":{"type":"passport","number":"7700225VH","country":"GB","expiresAt":"2026-03-13"},"person":{"givenName":"John","familyName":"Doe","birthdate":"1987-01-01","gender":"male","address":{"country":"GB","subdivision":"GB-MAN","city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA"}},"verifiedAt":"2020-01-01T00:00:00.000Z"}},"proofOfAddress":{"code":"proof-of-address","status":"ok","type":"document-submission","verification":{"model":"partner-verified","method":"manual","dependencies":["phone","profile"],"submittable":false},"input":{"media":[{"context":"address-proof","fileId":"459c0447-8916-4bad-bb67-f2354fcfb10b"}]},"output":{"provider":"sumsub","person":{"givenName":"John","familyName":"Doe","address":{"country":"GB","subdivision":"GB-MAN","city":"Manchester","line1":"1 High Street","line2":"Northern Quarter","postalCode":"M4 1AA"}},"verifiedAt":"2020-01-01T00:00:00.000Z"}},"customerDueDiligence":{"code":"customer-due-diligence","status":"ok","verification":{"model":"uphold-verified","method":"manual","dependencies":[]},"input":{"formId":"cb658d27-52cb-4d3b-856e-fd76faba1a6e","answers":{"intent":{"expected-activities":["cryptocurrency_investing","deposit_withdraw_crypto"]},"financial-information":{"source-of-funds":"salary","annual-income-range":"40000-60000-GBP","expected-annual-deposits-range":"0-5000-GBP"},"employment":{"status":"employed"},"employment-details":{"industry":"engineering"}}},"output":{"score":"low","expiresAt":"2025-01-01T00:00:00.000Z","verifiedAt":"2022-01-01T00:00:00.000Z"}},"enhancedDueDiligence":{"code":"enhanced-due-diligence","status":"ok","verification":{"model":"partner-verified","method":"manual","dependencies":["customer-due-diligence"]},"input":{"media":[{"context":"source-of-funds-proof","fileId":"57a3ecf2-5404-4654-9ece-feb504a69f86"}]},"output":{"verifiedAt":"2020-01-01T00:00:00.000Z"}},"cryptoRiskAssessment":{"code":"crypto-risk-assessment","status":"ok","verification":{"model":"uphold-verified","method":"manual","dependencies":[]},"input":{"formId":"7a0f4229-e3de-4dfd-8f91-9b1308b2dc33","answers":{"decision-making":{"who-makes-investment-decisions":"i_decide"},"loss-tolerance":{"acceptable-loss":"full_loss_possible"},"volatility-understanding":{"expected-price-behaviour":"highly_volatile"},"liquidity-awareness":{"selling-timeline":"may_be_delayed"},"regulatory-protection":{"compensation-coverage":"no_coverage"},"portfolio-allocation":{"share-of-net-assets":"small_share"},"complexity-acknowledgement":{"product-mechanics":"complex_and_risky"}}},"output":{"result":"approved","attempts":{"used":1,"maximum":5},"verifiedAt":"2022-01-01T00:00:00.000Z"}},"selfCategorizationStatement":{"code":"self-categorization-statement","status":"ok","verification":{"model":"uphold-verified","method":"manual","dependencies":[]},"input":{"formId":"ac33651f-f2d3-47c4-8e8d-06fb87361f5c","answers":{"investor":{"type":"restricted_investor"},"investor-profile":{"invested-less-than-10-percent":"yes","invested-percentage":"5","invest-less-than-10-percent":"yes","invest-percentage":"5","investor-type-confirmation":true}}},"output":{"result":"approved","attempts":{"used":1,"maximum":30},"expiresAt":"2025-01-01T00:00:00.000Z","verifiedAt":"2022-01-01T00:00:00.000Z"}},"taxDetails":{"code":"tax-details","status":"ok","verification":{"model":"uphold-verified","method":"manual","dependencies":["profile"]},"input":{"taxResidency":{"countries":["GB"]},"taxIdentification":{"documents":[{"type":"tin","country":"GB","number":"6405444702"}],"certify":true}},"output":{"result":"approved","verifiedAt":"2022-01-01T00:00:00.000Z"},"hint":{"type":"form","schema":{"type":"object","additionalProperties":false,"properties":{"taxResidency":{"title":"Tax Residency Declaration","type":"object","additionalProperties":false,"properties":{"countries":{"title":"In which countries are you a tax resident?","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["countries"]},"taxIdentification":{"title":"Tax Identification and Certification","type":"object","additionalProperties":false,"properties":{"documents":{"title":"Tax Identification Documents","type":"array","uniqueItems":true,"items":{"allOf":[{"type":"object","properties":{"country":{"title":"Country","type":"string","enum":["GB"]},"type":{"title":"Document type","type":"string","enum":["tin"]},"number":{"title":"Document number","type":"string","pattern":"^\\S.*\\S$|^\\S$"},"reason":{"title":"If you don't have a TIN, please select a reason","type":"string","oneOf":[{"const":"country-does-not-issue-document","title":"My country does not issue TINs or equivalent to its residents."},{"const":"user-unable-to-obtain-document","title":"I am unable to obtain a TIN."},{"const":"law-does-not-require-document","title":"The local law does not require me to have a TIN."}]},"justification":{"title":"I am unable to obtain a TIN because","type":"string","pattern":"^\\S.*\\S$|^\\S$","maxLength":1000}},"required":["country","type"]},{"if":{"type":"object","properties":{"reason":{"const":"user-unable-to-obtain-document"}},"required":["reason"]},"then":{"type":"object","required":["justification"]}},{"oneOf":[{"type":"object","required":["number"]},{"type":"object","required":["reason"]}]}]}},"certify":{"title":"I confirm that the information provided is accurate.","type":"boolean","const":true}},"required":["documents","certify"]}}},"uiSchema":{"type":"Categorization","elements":[{"label":"Tax Residency Declaration","type":"Category","elements":[{"label":"In which countries are you a tax resident?","type":"Control","scope":"#/properties/taxResidency/properties/countries","options":{"data":{"source":"countries","exclude":{"restrictions":[{"scope":"citizenship"}]}}}}]},{"label":"Tax Identification and Certification","type":"Category","elements":[{"label":"Tax Identification Documents","type":"Control","scope":"#/properties/taxIdentification/properties/documents","options":{"elementLabelProp":"country","disableAdd":true,"disableRemove":true,"showSortButtons":false,"detail":{"type":"ListWithDetail","elements":[{"type":"Group","elements":[{"label":"Document type","type":"Control","scope":"#/properties/type","options":{"readonly":true}},{"label":"Country","type":"Control","scope":"#/properties/country","options":{"readonly":true}},{"label":"Document number","type":"Control","scope":"#/properties/number"},{"label":"If you don't have a TIN, please select a reason","type":"Control","scope":"#/properties/reason"},{"label":"I am unable to obtain a TIN because","type":"Control","scope":"#/properties/justification"}]}]}}},{"label":"I confirm that the information provided is accurate.","type":"Control","scope":"#/properties/taxIdentification/properties/certify"}]}]}}},"screening":{"code":"screening","status":"ok","verification":{"model":"uphold-verified","method":"automatic","triggers":["profile","identity"],"dependencies":[]},"output":{"result":"approved"}},"risk":{"code":"risk","status":"ok","verification":{"model":"uphold-verified","method":"automatic","dependencies":[]},"output":{"result":"approved"}}}}},"KYC Overview Pending Fully Detailed":{"title":"KYC Overview Pending Fully Detailed","value":{"summary":{"reason":"none","status":"pending"},"processes":{"profile":{"code":"profile","status":"pending","verification":{"model":"none","method":"manual","dependencies":[],"rules":{"fullName":{"presence":"required","editable":true},"birthdate":{"presence":"required","editable":true},"birthplace":{"presence":"disallowed","editable":false,"rules":{"country":{"presence":"required","editable":false},"town":{"presence":"required","editable":false}}},"primaryCitizenship":{"presence":"disallowed","editable":false},"otherCitizenships":{"presence":"disallowed","editable":false},"address":{"presence":"required","editable":true,"rules":{"subdivision":{"presence":"optional","editable":false},"city":{"presence":"required","editable":true},"line1":{"presence":"required","editable":true},"line2":{"presence":"optional","editable":true},"postalCode":{"presence":"required","editable":true}}}}},"input":{"primaryCitizenship":"GB","address":{"country":"GB","subdivision":"GB-MAN"}}},"address":{"code":"address","status":"pending","verification":{"model":"none","method":"manual","dependencies":[]},"input":{"address":{"country":"GB","subdivision":"GB-MAN"}}},"email":{"code":"email","status":"pending","verification":{"model":"partner-verified","method":"manual","dependencies":[]},"input":{"email":"[email protected]"}},"phone":{"code":"phone","status":"pending","verification":{"model":"partner-verified","method":"manual","dependencies":[]}},"identity":{"code":"identity","status":"pending","type":"none","verification":{"model":"partner-verified","method":"manual","dependencies":["phone","profile"],"submittable":true}},"proofOfAddress":{"code":"proof-of-address","status":"pending","type":"none","verification":{"model":"partner-verified","method":"manual","dependencies":["phone","profile"],"submittable":true}},"customerDueDiligence":{"code":"customer-due-diligence","status":"pending","verification":{"model":"uphold-verified","method":"manual","dependencies":[]},"hint":{"type":"form","formId":"cb658d27-52cb-4d3b-856e-fd76faba1a6e","schema":{"type":"object","properties":{"intent":{"type":"object","title":"Financial Profile","description":"Intended account usage. Select all that apply.","unevaluatedProperties":false,"properties":{"expected-activities":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":5,"items":{"type":"string","oneOf":[{"const":"cryptocurrency_investing","title":"Trade cryptocurrencies"},{"const":"metals_or_commodities_investing","title":"Metals or Commodities investing"},{"const":"foreign_exchange_trading","title":"Currency conversion"},{"const":"deposit_withdraw_crypto","title":"Deposit or withdraw cryptocurrencies"},{"const":"international_payments_transfers","title":"Transfers between users"}]}}},"required":["expected-activities"]}}},"uiSchema":{"type":"Categorization","elements":[{"type":"Category","label":"Financial Profile","elements":[{"type":"Control","scope":"#/properties/intent/properties/expected-activities"}]}]}}},"enhancedDueDiligence":{"code":"enhanced-due-diligence","status":"exempt","verification":{"model":"partner-verified","method":"manual","dependencies":["customer-due-diligence"]}},"cryptoRiskAssessment":{"code":"crypto-risk-assessment","status":"pending","verification":{"model":"uphold-verified","method":"manual","dependencies":[]},"hint":{"type":"form","formId":"7a0f4229-e3de-4dfd-8f91-9b1308b2dc33","schema":{"type":"object","properties":{"decision-making":{"type":"object","title":"Decision making","description":"Who decides what cryptoassets are bought and sold?","properties":{"who-makes-investment-decisions":{"type":"string","oneOf":[{"const":"i_decide","title":"I decide"},{"const":"platform_decides","title":"Platform decides"},{"const":"joint_decision","title":"Joint decision"}]}},"required":["who-makes-investment-decisions"]}}},"uiSchema":{"type":"Categorization","elements":[{"type":"Category","label":"Decision making","elements":[{"type":"Control","scope":"#/properties/decision-making/properties/who-makes-investment-decisions"}]}]}}},"selfCategorizationStatement":{"code":"self-categorization-statement","status":"pending","verification":{"model":"uphold-verified","method":"manual","dependencies":[]},"hint":{"type":"form","formId":"ac33651f-f2d3-47c4-8e8d-06fb87361f5c","schema":{"type":"object","properties":{"investor":{"type":"object","title":"Client Categorization","description":"The FCA divides investors into 2 types. Choose the best fit for you.","minProperties":1,"unevaluatedProperties":false,"properties":{"type":{"type":"string","oneOf":[{"const":"restricted_investor","title":"Restricted Investor"},{"const":"high_net_worth_investor","title":"High-Net-Worth Investor"}]}},"required":["type"]}}},"uiSchema":{"type":"Categorization","elements":[{"type":"Category","label":"Client Categorization","elements":[{"type":"Control","scope":"#/properties/investor/properties/type"}]}]}}},"taxDetails":{"code":"tax-details","status":"pending","verification":{"model":"uphold-verified","method":"manual","dependencies":["profile"]},"hint":{"type":"form","schema":{"type":"object","additionalProperties":false,"properties":{"taxResidency":{"title":"Tax Residency Declaration","type":"object","additionalProperties":false,"properties":{"countries":{"title":"In which countries are you a tax resident?","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["countries"]}}},"uiSchema":{"type":"Categorization","elements":[{"label":"Tax Residency Declaration","type":"Category","elements":[{"label":"In which countries are you a tax resident?","type":"Control","scope":"#/properties/taxResidency/properties/countries","options":{"data":{"source":"countries","exclude":{"restrictions":[{"scope":"citizenship"}]}}}}]}]}}},"screening":{"code":"screening","status":"pending","verification":{"model":"uphold-verified","method":"automatic","triggers":["profile","identity"],"dependencies":[]}},"risk":{"code":"risk","status":"pending","verification":{"model":"uphold-verified","method":"automatic","dependencies":[]}}}}},"KYC Overview Pending Fully Detailed - US Taxpayer":{"title":"KYC Overview Pending Fully Detailed - US Taxpayer","value":{"summary":{"reason":"none","status":"pending"},"processes":{"profile":{"code":"profile","status":"ok"},"address":{"code":"address","status":"ok"},"email":{"code":"email","status":"ok"},"phone":{"code":"phone","status":"ok"},"identity":{"code":"identity","status":"ok","type":"document-submission"},"proofOfAddress":{"code":"proof-of-address","status":"ok","type":"electronic-verification"},"customerDueDiligence":{"code":"customer-due-diligence","status":"ok"},"enhancedDueDiligence":{"code":"enhanced-due-diligence","status":"ok"},"cryptoRiskAssessment":{"code":"crypto-risk-assessment","status":"ok"},"selfCategorizationStatement":{"code":"self-categorization-statement","status":"ok"},"taxDetails":{"code":"tax-details","status":"pending","verification":{"model":"uphold-verified","method":"manual","dependencies":["profile"]},"input":{"taxResidency":{"countries":["US"]},"taxIdentification":{"documents":[{"type":"tin","country":"US"}]}},"hint":{"type":"form","schema":{"type":"object","additionalProperties":false,"properties":{"taxResidency":{"title":"Tax Residency Declaration","type":"object","additionalProperties":false,"properties":{"countries":{"title":"In which countries are you a tax resident?","type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"allOf":[{"contains":{"const":"US"}}],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["countries"]},"taxIdentification":{"title":"Tax Identification and Certification","type":"object","additionalProperties":false,"properties":{"documents":{"title":"Tax Identification Documents","type":"array","uniqueItems":true,"allOf":[{"contains":{"type":"object","properties":{"type":{"const":"tin"},"country":{"const":"US"}},"required":["type","country"]},"minContains":1,"maxContains":1}],"items":{"type":"object","properties":{"type":{"title":"Document type","type":"string"},"country":{"title":"Country","type":"string"},"number":{"title":"Document number","type":"string","pattern":"^\\S.*\\S$|^\\S$","maxLength":15}},"required":["country","type","number"],"allOf":[{"oneOf":[{"type":"object","properties":{"type":{"const":"tin"},"country":{"const":"US"}},"required":["type","country"]}]}]}},"signature":{"title":"Signature","description":"Sign using your account's legal name: John Doe","type":"string","pattern":"^\\S.*\\S$|^\\S$","maxLength":200},"certify":{"title":"I confirm that the information provided is accurate.","type":"boolean","const":true}},"required":["documents","signature","certify"]}}},"uiSchema":{"type":"Categorization","elements":[{"label":"Tax Residency Declaration","type":"Category","elements":[{"label":"In which countries are you a tax resident?","type":"Control","scope":"#/properties/taxResidency/properties/countries","options":{"data":{"source":"countries","exclude":{"restrictions":[{"scope":"citizenship"}]}}}}]},{"label":"Tax Identification and Certification","type":"Category","elements":[{"label":"Tax Identification Documents","type":"ListWithDetail","scope":"#/properties/taxIdentification/properties/documents","options":{"elementLabelProp":"country","disableAdd":true,"disableRemove":true,"showSortButtons":false,"detail":{"type":"VerticalLayout","elements":[{"label":"Document type","type":"Control","scope":"#/properties/type","options":{"readonly":true}},{"label":"Country","type":"Control","scope":"#/properties/country","options":{"readonly":true}},{"label":"Document number","type":"Control","scope":"#/properties/number"},{"label":"If you don't have a TIN, please select a reason","type":"Control","scope":"#/properties/reason"},{"label":"I am unable to obtain a TIN because","type":"Control","scope":"#/properties/justification"}]}}},{"label":"Signature","type":"Control","scope":"#/properties/taxIdentification/properties/signature"},{"label":"I confirm that the information provided is accurate.","type":"Control","scope":"#/properties/taxIdentification/properties/certify"}]}]}}},"screening":{"code":"screening","status":"pending","verification":{"model":"uphold-verified","method":"automatic","triggers":["profile","identity"],"dependencies":[]}},"risk":{"code":"risk","status":"pending","verification":{"model":"uphold-verified","method":"automatic","dependencies":[]}}}}}},"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"},"0bb180a5-8c64-4b36-85af-071ebb44b234":{"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":{"Invalid Locale":{"title":"Invalid Locale","value":{"code":"locale_invalid","message":"The locale is invalid","details":{"context":"headers","property":"accept-language"}}}},"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":{"6bcf598a-8ffd-4e9f-ae98-7002562b5b5b":{"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.kyc:read"],"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.kyc:read"],"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":"Get overview - Uphold","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T10:48:57.485Z","originalFileLocation":"rest-apis/core-api/kyc/get-overview.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=\"Get the KYC overview of an individual 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=\"Get overview - Uphold\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the KYC overview of an individual 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/kyc/get-overview\">\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=KYC\u0026amp;title=Get+overview\u0026amp;description=Get+the+KYC+overview+of+an+individual+user.\u0026amp;theme=ff31b04fc4d9e649c4b1458d\u0026amp;signature=be81d53cb843f38ba227c7abc31685ecc9c2251158dc65780e73fd8dad083cb2\">\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=\"Get overview - Uphold\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the KYC overview of an individual user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uphold-d4756e17.mintlify.site/_mintlify/api/og/v2?division=KYC\u0026amp;title=Get+overview\u0026amp;description=Get+the+KYC+overview+of+an+individual+user.\u0026amp;theme=ff31b04fc4d9e649c4b1458d\u0026amp;signature=be81d53cb843f38ba227c7abc31685ecc9c2251158dc65780e73fd8dad083cb2\">\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/kyc/get-overview\">\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/kyc/get-overview.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/kyc/get-overview#webpage\",\"url\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview\",\"name\":\"Get overview\",\"description\":\"Get the KYC overview of an individual user.\",\"dateModified\":\"2026-11-12T10:48:57.485Z\",\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/concepts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"KYC\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/kyc/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get overview\",\"item\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview#apireference\",\"headline\":\"Get overview\",\"name\":\"Get overview\",\"description\":\"Get the KYC overview of an individual user.\",\"url\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview\",\"mainEntityOfPage\":{\"@id\":\"https://developer.uphold.com/rest-apis/core-api/kyc/get-overview#webpage\"},\"dateModified\":\"2026-11-12T10:48:57.485Z\",\"publisher\":{\"@id\":\"https://developer.uphold.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"}}]}\u003c/script>","agentPointerHref":"/rest-apis/core-api/kyc/get-overview.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","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","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","description":"Manage KYC processes on the Uphold platform to keep users compliant with regulatory requirements. Learn the process model, statuses, and verification flow.","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","description":"Update the email process for an individual user.","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":"Get overview - Uphold","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}