Get metadata retrieves the custom metadata associated with a given entity.The response includes an ETag header representing the current version of the metadata. You can use this value with the If-None-Match header in subsequent requests to efficiently check if the metadata has changed—if it hasn’t, the server returns 304 Not Modified without the response body, saving bandwidth.
Returns 404 Not Found if no metadata exists for the entity. Create metadata using the Set metadata endpoint.
Authorizations
Authorization
string
header
required
OAuth 2.0 authentication
Headers
If-None-Match
string
Retrieves the entity metadata only if it does not match the given revision.
Pattern: ^(?:W\/)?"([A-Fa-f0-9]{64})"$
Path Parameters
entity
enum<string>
required
The type of entity whose metadata is being accessed.
Available options:
orders
entityId
string
required
The unique identifier of the entity whose metadata is being accessed.
Response
Metadata retrieved.
metadata
object
required
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":"6aff7462afc1438007a3c992","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"REST APIs","count":194},{"language":"default","tag":"Core API","count":139},{"language":"default","tag":"Developer Guides","count":73},{"language":"default","tag":"Webhooks","count":43},{"language":"default","tag":"KYC","count":27},{"language":"default","tag":"KYB","count":25},{"language":"default","tag":"Deposit","count":22},{"language":"default","tag":"via Widget","count":19},{"language":"default","tag":"Withdrawal","count":19},{"language":"default","tag":"Bank transfers","count":16}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"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/on-off-ramp-api/metadata/get-metadata","slug":"/rest-apis/on-off-ramp-api/metadata/get-metadata","pageMetadata":{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json get /on-off-ramp/{entity}/{entityId}/metadata","title":"Get metadata","description":"Retrieve metadata for a given entity.","href":"/rest-apis/on-off-ramp-api/metadata/get-metadata"},"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: \"Retrieve metadata for a given entity.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const RestEndpointSubjects=({subjects=[]})=>{const _components={a:`a`,..._provideComponents()},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);const subjectToIconMap={\"client\":`browser`,\"user:individual\":`user`,\"user:business\":`briefcase`};if(subjects.length===0){return null}return _jsx(_Fragment,{children:subjects.map(subject=>_jsx(_components.a,{href:`/rest-apis/authentication#subjects`,className:`mint-border-0 mint-opacity-85 hover:mint-opacity-100 mint-transition-opacity`,children:_jsx(Badge,{stroke:true,size:`lg`,icon:subjectToIconMap[subject],color:`gray`,className:`mint-mr-1`,children:subject})},subject))})};function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note,_MdxComponentBoundary}=_components;if(!Note)_missingMdxReference(`Note`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`RestEndpointSubjects`,children:_jsx(RestEndpointSubjects,{subjects:[`user:individual`,`user:business`]})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Get metadata`}),` retrieves the custom metadata associated with a given entity.`]}),`\n`,_jsxs(_components.p,{children:[`The response includes an `,_jsx(_components.code,{children:`ETag`}),` header representing the current version of the metadata. You can use this value with the `,_jsx(_components.code,{children:`If-None-Match`}),` header in subsequent requests to efficiently check if the metadata has changed—if it hasn’t, the server returns `,_jsx(_components.code,{children:`304 Not Modified`}),` without the response body, saving bandwidth.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`404 Not Found`}),` if no metadata exists for the entity. Create metadata using the `,_jsx(_components.a,{href:`/rest-apis/on-off-ramp-api/metadata/set-metadata`,children:`Set metadata`}),` endpoint.`]})})]})}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/on-off-ramp-openapi.mintlify.json get /on-off-ramp/{entity}/{entityId}/metadata","title":"Get metadata","description":"Retrieve metadata for a given entity.","href":"/rest-apis/on-off-ramp-api/metadata/get-metadata"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[156,780,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[],"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":"on-off-ramp.get-metadata","summary":"Get metadata","description":"Retrieve metadata for a given entity.","tags":["Metadata"],"x-uphold":{"operation":{"notImplementedIn":["production"]},"security":{"OAuth2":{"subjects":["user:business","user:individual"]}}},"parameters":["33a942c4-6f6f-4ea9-9c3c-7b1d1a4ddd27","8179afd0-6606-4265-9ef9-cc4cf732c1ad","466d2c2d-cebc-4094-b688-09a4549a8eaa"],"responses":{"200":"6605b922-db68-4b3c-b08f-8e3543670b4e","304":"8fe3315c-af11-4301-a373-48a7d2f8555c","404":"1cfc15ea-5001-4547-b14b-47c010a13bb6"},"method":"get","type":"path","servers":["c928d37a-dd07-4516-800e-e58e5a083754","ad27e03d-fd63-41e0-a472-0599e47f3fe8"],"security":["e3a72d4c-c974-477a-844a-11ddb3364b4b"],"path":"/on-off-ramp/{entity}/{entityId}/metadata","baseUrlOptions":["https://api.enterprise.sandbox.uphold.com","https://api.enterprise.uphold.com"],"title":"Get metadata","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"33a942c4-6f6f-4ea9-9c3c-7b1d1a4ddd27":{"name":"entity","description":"The type of entity whose metadata is being accessed.","in":"path","required":true,"schema":{"type":"string","enum":["orders"],"isRequired":true,"description":"The type of entity whose metadata is being accessed.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"examples":{"Order Entity":{"value":"orders"}}},"8179afd0-6606-4265-9ef9-cc4cf732c1ad":{"name":"entityId","description":"The unique identifier of the entity whose metadata is being accessed.","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier of the entity whose metadata is being accessed.","uniqueKey":"","typeLabel":"string"},"examples":{"Order ID":{"value":"623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0"}}},"466d2c2d-cebc-4094-b688-09a4549a8eaa":{"name":"If-None-Match","description":"Retrieves the entity metadata only if it does not match the given revision.","in":"header","style":"simple","explode":false,"schema":{"type":"string","pattern":"^(?:W\\/)?\"([A-Fa-f0-9]{64})\"$","description":"Retrieves the entity metadata only if it does not match the given revision.","uniqueKey":"","typeLabel":"string"},"examples":{"Metadata Revision":{"value":"\"b59c6960e8c802ec287f3892b398b7b58eb4790640414f2c2b048ff22f873d72\""}}}},"responses":{"6605b922-db68-4b3c-b08f-8e3543670b4e":{"description":"Metadata retrieved.","headers":{"ETag":{"description":"The entity metadata revision.","schema":{"type":"string","pattern":"^\"[A-Fa-f0-9]{64}\"$"},"examples":{"ETag":{"value":"\"9ff2666faa58fabfc282eb90016e7182fe785d37dcdb861c6469cccaec13c876\""}}},"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"}}}},"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":true,"minProperties":1,"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"}},"required":["metadata"],"uniqueKey":"","typeLabel":"object"},"examples":{"Metadata Retrieved":{"title":"Metadata Retrieved","value":{"metadata":{"externalId":123}}}},"exampleType":"examples"}},"exampleType":"examples"},"8fe3315c-af11-4301-a373-48a7d2f8555c":{"description":"Metadata not modified.","headers":{"ETag":{"description":"The entity metadata revision.","schema":{"type":"string","pattern":"^\"[A-Fa-f0-9]{64}\"$"},"examples":{"ETag":{"value":"\"9ff2666faa58fabfc282eb90016e7182fe785d37dcdb861c6469cccaec13c876\""}}},"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"}}}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1cfc15ea-5001-4547-b14b-47c010a13bb6":{"description":"Resource not found.","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":{"Metadata Not Found":{"title":"Metadata Not Found","value":{"code":"entity_not_found","message":"The entity metadata cannot be found","details":{"entity":"metadata"}}},"Entity Not Found":{"title":"Entity Not Found","value":{"code":"entity_not_found","message":"The \u003centity> cannot be found","details":{"entity":"\u003centity>"}}}},"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":{"e3a72d4c-c974-477a-844a-11ddb3364b4b":{"OAuth2":{"type":"oauth2","description":"OAuth 2.0 authentication","flows":{"clientCredentials":{"tokenUrl":"/core/oauth2/token","scopes":{"on-off-ramp.orders:create":"Grants access to create orders.","on-off-ramp.orders:read":"Grants access to view orders.","on-off-ramp.orders.metadata:read":"Grants access to view orders metadata.","on-off-ramp.orders.metadata:write":"Grants access to modify orders metadata.","on-off-ramp.orders.quotes:create":"Grants access to create order quotes."}}},"scopes":[],"schemeName":"OAuth2"}}},"servers":{"c928d37a-dd07-4516-800e-e58e5a083754":{"url":"https://api.enterprise.sandbox.uphold.com","description":"Sandbox"},"ad27e03d-fd63-41e0-a472-0599e47f3fe8":{"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":{"on-off-ramp.orders:create":"Grants access to create orders.","on-off-ramp.orders:read":"Grants access to view orders.","on-off-ramp.orders.metadata:read":"Grants access to view orders metadata.","on-off-ramp.orders.metadata:write":"Grants access to modify orders metadata.","on-off-ramp.orders.quotes:create":"Grants access to create order quotes."}}},"scopes":[],"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/on-off-ramp-openapi.mintlify.json"},"subdomain":"uphold-d4756e17","siteName":"Uphold","title":"Get metadata - Uphold","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T17:08:44.565Z","originalFileLocation":"rest-apis/on-off-ramp-api/metadata/get-metadata.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=\"Retrieve metadata for a given entity.\">\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 metadata - Uphold\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve metadata for a given entity.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Uphold\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata\">\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=Metadata\u0026amp;title=Get+metadata\u0026amp;description=Retrieve+metadata+for+a+given+entity.\u0026amp;theme=ff31b04fc4d9e649c4b1458d\u0026amp;signature=e0e59af83b782ab58eb9d94d9b45e0819c714da19dbcc08460818bafc3ade6ea\">\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 metadata - Uphold\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve metadata for a given entity.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uphold-d4756e17.mintlify.site/_mintlify/api/og/v2?division=Metadata\u0026amp;title=Get+metadata\u0026amp;description=Retrieve+metadata+for+a+given+entity.\u0026amp;theme=ff31b04fc4d9e649c4b1458d\u0026amp;signature=e0e59af83b782ab58eb9d94d9b45e0819c714da19dbcc08460818bafc3ade6ea\">\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/on-off-ramp-api/metadata/get-metadata\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/rest-apis/on-off-ramp-api/metadata/get-metadata.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/on-off-ramp-api/metadata/get-metadata#webpage\",\"url\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata\",\"name\":\"Get metadata\",\"description\":\"Retrieve metadata for a given entity.\",\"dateModified\":\"2026-11-19T17:08:44.565Z\",\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"On \u0026 Off Ramp API\",\"item\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Metadata\",\"item\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/set-metadata\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get metadata\",\"item\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata#apireference\",\"headline\":\"Get metadata\",\"name\":\"Get metadata\",\"description\":\"Retrieve metadata for a given entity.\",\"url\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata\",\"mainEntityOfPage\":{\"@id\":\"https://developer.uphold.com/rest-apis/on-off-ramp-api/metadata/get-metadata#webpage\"},\"dateModified\":\"2026-11-19T17:08:44.565Z\",\"publisher\":{\"@id\":\"https://developer.uphold.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.uphold.com#website\"}}]}\u003c/script>","agentPointerHref":"/rest-apis/on-off-ramp-api/metadata/get-metadata.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":[{"title":"Users API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/users/introduction"},{"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","icon":"book-open","href":"/rest-apis/core-api/kyc/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyc","title":"Get overview","href":"/rest-apis/core-api/kyc/get-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/email","title":"Update email","href":"/rest-apis/core-api/kyc/update-email"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/phone","title":"Update phone","href":"/rest-apis/core-api/kyc/update-phone"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/profile","title":"Update profile","href":"/rest-apis/core-api/kyc/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/address","title":"Update address","href":"/rest-apis/core-api/kyc/update-address"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/identity","title":"Update identity","href":"/rest-apis/core-api/kyc/update-identity"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/proof-of-address","title":"Update proof-of-address","href":"/rest-apis/core-api/kyc/update-proof-of-address"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/customer-due-diligence","title":"Update customer due diligence","href":"/rest-apis/core-api/kyc/update-customer-due-diligence"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/enhanced-due-diligence","title":"Update enhanced due diligence","href":"/rest-apis/core-api/kyc/update-enhanced-due-diligence"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/crypto-risk-assessment","title":"Update crypto risk assessment","href":"/rest-apis/core-api/kyc/update-crypto-risk-assessment"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/self-categorization-statement","title":"Update self-categorization statement","href":"/rest-apis/core-api/kyc/update-self-categorization-statement"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyc/processes/tax-details","title":"Update tax details","href":"/rest-apis/core-api/kyc/update-tax-details"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.email.status-changed","title":"Email status changed","href":"/rest-apis/core-api/kyc/webhooks/email-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.phone.status-changed","title":"Phone status changed","href":"/rest-apis/core-api/kyc/webhooks/phone-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.profile.status-changed","title":"Profile status changed","href":"/rest-apis/core-api/kyc/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.address.status-changed","title":"Address status Changed","href":"/rest-apis/core-api/kyc/webhooks/address-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.identity.status-changed","title":"Identity status changed","href":"/rest-apis/core-api/kyc/webhooks/identity-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.proof-of-address.status-changed","title":"Proof-of-address status changed","href":"/rest-apis/core-api/kyc/webhooks/proof-of-address-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.customer-due-diligence.status-changed","title":"Customer due diligence status changed","href":"/rest-apis/core-api/kyc/webhooks/customer-due-diligence-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.enhanced-due-diligence.status-changed","title":"Enhanced due diligence status changed","href":"/rest-apis/core-api/kyc/webhooks/enhanced-due-diligence-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.crypto-risk-assessment.status-changed","title":"Crypto risk assessment status changed","href":"/rest-apis/core-api/kyc/webhooks/crypto-risk-assessment-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.self-categorization-statement.status-changed","title":"Self categorization statement status changed","href":"/rest-apis/core-api/kyc/webhooks/self-categorization-statement-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.tax-details.status-changed","title":"Tax details status changed","href":"/rest-apis/core-api/kyc/webhooks/tax-details-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.screening.status-changed","title":"Screening status changed","href":"/rest-apis/core-api/kyc/webhooks/screening-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyc.risk.status-changed","title":"Risk status changed","href":"/rest-apis/core-api/kyc/webhooks/risk-status-changed"}]}]},{"group":"KYB","pages":[{"title":"KYB API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/kyb/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb","title":"Get overview","href":"/rest-apis/core-api/kyb/get-overview"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/profile","title":"Update profile","href":"/rest-apis/core-api/kyb/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/documents","title":"Update documents","href":"/rest-apis/core-api/kyb/update-documents"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/processes/financial-institution","title":"Update financial institution","href":"/rest-apis/core-api/kyb/update-financial-institution"},{"group":"Associated persons","icon":"users","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb/associated-persons","sidebarTitle":"List persons","title":"List associated persons","href":"/rest-apis/core-api/kyb/associated-persons/list-associated-persons"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons","sidebarTitle":"Create person","title":"Create associated person","href":"/rest-apis/core-api/kyb/associated-persons/create-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/kyb/associated-persons/{personId}","sidebarTitle":"Get person","title":"Get associated person","href":"/rest-apis/core-api/kyb/associated-persons/get-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json delete /core/kyb/associated-persons/{personId}","sidebarTitle":"Delete person","title":"Delete associated person","href":"/rest-apis/core-api/kyb/associated-persons/delete-associated-person"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/profile","sidebarTitle":"Update person profile","title":"Update associated person profile","href":"/rest-apis/core-api/kyb/associated-persons/update-profile"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/identity","sidebarTitle":"Update person identity","title":"Update associated person identity","href":"/rest-apis/core-api/kyb/associated-persons/update-identity"},{"openapi":"_media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/proof-of-address","sidebarTitle":"Update person proof-of-address","title":"Update associated person proof-of-address","href":"/rest-apis/core-api/kyb/associated-persons/update-proof-of-address"},{"group":"Test helpers","icon":"bolt","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons/{personId}/test-helpers/identity-outcome","sidebarTitle":"Set desired outcome for IDV Process","title":"Set identity verification outcome","href":"/rest-apis/core-api/kyb/associated-persons/test-helpers/identity-outcome"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons/{personId}/test-helpers/proof-of-address-outcome","sidebarTitle":"Set desired outcome for POA Process","title":"Set proof of address verification outcome","href":"/rest-apis/core-api/kyb/associated-persons/test-helpers/proof-of-address-outcome"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.created","sidebarTitle":"Person created","title":"Associated person created","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/associated-person-created"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.deleted","sidebarTitle":"Person deleted","title":"Associated person deleted","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/associated-person-deleted"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.profile.status-changed","sidebarTitle":"Person profile status changed","title":"Associated person profile status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.identity.status-changed","sidebarTitle":"Person identity status changed","title":"Associated person identity status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/identity-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-person.proof-of-address.status-changed","sidebarTitle":"Person proof-of-address status changed","title":"Associated person proof-of-address status changed","href":"/rest-apis/core-api/kyb/associated-persons/webhooks/proof-of-address-status-changed"}]}]},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/kyb/processes/attestation/trigger","title":"Trigger attestation","href":"/rest-apis/core-api/kyb/trigger-attestation"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.profile.status-changed","title":"Profile status changed","href":"/rest-apis/core-api/kyb/webhooks/profile-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.associated-persons.status-changed","title":"Associated persons status changed","href":"/rest-apis/core-api/kyb/webhooks/associated-persons-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.documents.status-changed","title":"Documents status changed","href":"/rest-apis/core-api/kyb/webhooks/documents-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.financial-institution.status-changed","title":"Financial institution status changed","href":"/rest-apis/core-api/kyb/webhooks/financial-institution-status-changed"},{"openapi":"_media/specs/core-openapi.mintlify.json webhook core.kyb.attestation.status-changed","title":"Attestation status changed","href":"/rest-apis/core-api/kyb/webhooks/attestation-status-changed"}]}]},{"group":"Capabilities","pages":[{"title":"Capabilities API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/capabilities/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/capabilities","title":"List capabilities","href":"/rest-apis/core-api/capabilities/list-user-capabilities"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/capabilities/{capability}","title":"Get capability","href":"/rest-apis/core-api/capabilities/get-user-capability"}]},{"group":"Terms of service","pages":[{"title":"Terms of Service API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/terms-of-service/introduction"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/terms-of-service","title":"List terms of service","href":"/rest-apis/core-api/terms-of-service/list-terms-of-service"},{"openapi":"_media/specs/core-openapi.mintlify.json get /core/terms-of-service/{termsOfService}","title":"Get terms of service","href":"/rest-apis/core-api/terms-of-service/get-terms-of-service"},{"openapi":"_media/specs/core-openapi.mintlify.json post /core/terms-of-service/{termsOfService}/accept","title":"Accept terms of service","href":"/rest-apis/core-api/terms-of-service/accept-terms-of-service"}]},{"group":"Files","pages":[{"title":"Files API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/core-api/files/introduction"},{"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":"On \u0026 Off Ramp API","tag":"Preview","pages":[{"title":"On \u0026 Off Ramp API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/on-off-ramp-api/introduction"},{"group":"Orders","pages":[{"title":"Orders API introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/rest-apis/on-off-ramp-api/orders/introduction"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json post /on-off-ramp/orders/quote","title":"Create quote","href":"/rest-apis/on-off-ramp-api/orders/create-quote"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json get /on-off-ramp/orders","title":"List orders","href":"/rest-apis/on-off-ramp-api/orders/list-orders"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json post /on-off-ramp/orders","title":"Create order","href":"/rest-apis/on-off-ramp-api/orders/create-order"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json get /on-off-ramp/orders/{orderId}","title":"Get order","href":"/rest-apis/on-off-ramp-api/orders/get-order"},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json webhook on-off-ramp.order.created","title":"Order created","href":"/rest-apis/on-off-ramp-api/orders/webhooks/order-created"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json webhook on-off-ramp.order.status-changed","title":"Order status changed","href":"/rest-apis/on-off-ramp-api/orders/webhooks/order-status-changed"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json webhook on-off-ramp.order.timeline-updated","title":"Order timeline updated","href":"/rest-apis/on-off-ramp-api/orders/webhooks/order-timeline-updated"}]}]},{"group":"Assets","pages":[{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json get /on-off-ramp/rails","title":"List rails","href":"/rest-apis/on-off-ramp-api/assets/list-rails"}]},{"group":"Metadata","pages":[{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json put /on-off-ramp/{entity}/{entityId}/metadata","title":"Set metadata","description":"Create or update metadata for a given entity.","href":"/rest-apis/on-off-ramp-api/metadata/set-metadata"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json get /on-off-ramp/{entity}/{entityId}/metadata","title":"Get metadata","href":"/rest-apis/on-off-ramp-api/metadata/get-metadata"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json delete /on-off-ramp/{entity}/{entityId}/metadata","title":"Delete metadata","description":"Delete metadata for a given entity.","href":"/rest-apis/on-off-ramp-api/metadata/delete-metadata"},{"openapi":"_media/specs/on-off-ramp-openapi.mintlify.json patch /on-off-ramp/{entity}/{entityId}/metadata","title":"Update metadata","href":"/rest-apis/on-off-ramp-api/metadata/update-metadata"}]}]},{"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 metadata - Uphold","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}