Remove collateral, create withdraw request.
Learn more about Fireblocks Off Exchange in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Fireblocks Developer Docs","colors":{"primary":"#0052ec","light":"#0052ec","dark":"#0052ec"},"logo":{"light":"https://mintcdn.com/fireblocks-43c4b3ee/8uV7V_rBjqF0ZDAg/images/fb-devs.svg?fit=max\u0026auto=format\u0026n=8uV7V_rBjqF0ZDAg\u0026q=85\u0026s=1e870435fece62854968ac125be4db2c","dark":"https://mintcdn.com/fireblocks-43c4b3ee/8uV7V_rBjqF0ZDAg/images/fb-devs.svg?fit=max\u0026auto=format\u0026n=8uV7V_rBjqF0ZDAg\u0026q=85\u0026s=1e870435fece62854968ac125be4db2c","href":"/"},"favicon":"https://mintcdn.com/fireblocks-43c4b3ee/8uV7V_rBjqF0ZDAg/images/favicon.svg?fit=max\u0026auto=format\u0026n=8uV7V_rBjqF0ZDAg\u0026q=85\u0026s=76ab361a473a62b34d4c41436329c14d","api":{"openapi":"https://swagger.fireblocks.com/openapi.yaml","playground":{"display":"simple"}},"navbar":{"links":[{"href":"/docs/building-with-ai","label":"Connect your AI agent"},{"href":"https://www.fireblocks.com/developer-sandbox-sign-up","label":"Try in Sandbox"}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"GTM-WFS69RT4"}},"contextual":{"options":["copy","view","chatgpt","claude","grok","windsurf","cursor","vscode","perplexity","devin"],"display":"header"},"markdown":{"schema":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fireblocks-43c4b3ee","hasAudioNarration":false,"actualSubdomain":"fireblocks-43c4b3ee","customDomains":["developers.fireblocks.com"],"gitSource":{"type":"github","owner":"fireblocks-ext","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae5844b659f6d05f2378eff","collectionId":"2f2fabcd-6b80-454c-93f4-f26bcbec5184","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae5844b659f6d05f2378eff"},"feedback":{"contextualFeedback":{"allowEmail":true},"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae5844b659f6d05f2378eff","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API","count":543},{"language":"default","tag":"API Endpoints","count":507},{"language":"default","tag":"Guides","count":210},{"language":"default","tag":"Compliance","count":45},{"language":"default","tag":"Vaults","count":40},{"language":"default","tag":"Transactions","count":34},{"language":"default","tag":"Tokenization","count":34},{"language":"default","tag":"API Co-Signers","count":29},{"language":"default","tag":"Identity \u0026 Compliance","count":28},{"language":"default","tag":"TRLink","count":28}],"searchSettings":{"isFiltersEnabled":false,"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"@keyframes fb-float{0%,to{transform:translateY(0)}50%{transform:translateY(-14px)}}@keyframes fb-fade-up{0%{opacity:0;transform:translateY(24px)}to{opacity:1;transform:translateY(0)}}#content{display:flex!important;flex-direction:column;flex:1!important}#changelog-iframe{aspect-ratio:unset!important}@font-face{font-family:'Ufficio Sans';font-weight:600;font-style:normal;font-display:swap;src:local('Ufficio Sans')}:root{--fb-navy:#212647;--fb-navy-light:#2C365F;--fb-bandwidth:#678BFF;--fb-bandwidth-hover:#5470d8;--fb-grey:#F9FAFC;--fb-grey-200:#E5E7EB;--fb-grey-60:rgba(249, 250, 252, 0.6);--fb-gold:#FFC64E;--fb-white:#FFFFFF;--fb-periwinkle:#E8EDFF;--fb-blue:#4569F3;--fb-max-w:1040px;--fb-gutter:48px;--fb-nav-top-h:60px;--fb-nav-tabs-h:40px}@media (max-width:768px){:root{--fb-gutter:20px}}body:has(.fb-landing) #sidebar{display:none!important}body:has(.fb-landing) #content-container{margin-left:0!important}body:has(.fb-landing) #content-area{width:100%!important;min-width:0!important;max-width:none!important;margin-top:0!important}body:has(.fb-landing) #navbar{position:absolute!important;left:-9999px!important;top:-9999px!important;width:1px!important;height:1px!important;overflow:hidden!important;pointer-events:none!important}body:has(.fb-landing) #content-container{padding-top:0!important}.fb-nav{position:fixed;top:0;left:0;right:var(--assistant-sheet-width, 0px);z-index:30;background-color:var(--fb-white);border-bottom:none;box-shadow:0 2px 8px rgba(33,38,71,.06);font-family:'Figtree',system-ui,-apple-system,sans-serif}.fb-nav-inner{display:flex;align-items:center;height:100%}.fb-nav-row--top{height:var(--fb-nav-top-h)}.fb-nav-row--top .fb-nav-inner{gap:32px}.fb-nav-row--tabs{height:var(--fb-nav-tabs-h);border-top:none}.fb-nav-row--tabs .fb-nav-inner{gap:28px}.fb-nav-brand{display:flex;align-items:center;flex-shrink:0}.fb-nav-logo{height:26px;width:auto;display:block}.fb-nav-kbd,.fb-nav-search{color:#6b7280;border:1px solid var(--fb-grey-200)}.fb-nav-search{display:flex;align-items:center;justify-content:space-between;gap:12px;flex:1;max-width:440px;margin:0 auto;height:38px;padding:0 12px;border-radius:8px;background-color:var(--fb-grey);font-size:14px;cursor:pointer}.fb-nav-search:hover{border-color:var(--fb-bandwidth);background-color:var(--fb-white)}.fb-nav-kbd{font-family:'JetBrains Mono',ui-monospace,SFMono-Regular,Menlo,monospace;font-size:11px;border-radius:4px;padding:2px 6px;background-color:var(--fb-white)}.fb-nav-actions{display:flex;align-items:center;gap:20px;flex-shrink:0;margin-left:auto}.fb-nav-link,.fb-nav-signin,.fb-nav-tab{font-size:14px;font-weight:500;white-space:nowrap}.fb-nav-link{color:var(--fb-navy)}.fb-nav-link:hover{color:var(--fb-bandwidth)}.fb-nav-signin,.fb-nav-tab{align-items:center}.fb-nav-signin{display:inline-flex;height:36px;padding:0 16px;border-radius:8px;background-color:var(--fb-bandwidth);color:var(--fb-white)}.fb-nav-signin:hover{background-color:var(--fb-bandwidth-hover);color:var(--fb-white)}.fb-nav-tab{position:relative;display:flex;height:100%;color:#6b7280}.fb-nav-tab--active,.fb-nav-tab:hover{color:var(--fb-navy)}.fb-nav-tab--active::after{content:'';position:absolute;left:0;right:0;bottom:-1px;height:2px;background-color:var(--fb-bandwidth)}.fb-landing{padding-top:calc(var(--fb-nav-top-h) + var(--fb-nav-tabs-h))}@media (max-width:768px){.fb-nav-link,.fb-nav-search{display:none}}.fb-landing{font-family:'Figtree',system-ui,-apple-system,sans-serif;color:var(--fb-navy);font-size:16px;line-height:110%}.fb-landing :where(h1, h2, h3, h4, h5){font-family:'Ufficio Sans','Figtree',system-ui,sans-serif;font-weight:600;letter-spacing:-.01em;margin:0}.fb-h1,.fb-h2{font-size:80px;line-height:96%}.fb-h2{font-size:56px}.fb-h3{font-size:48px;line-height:98%}.fb-h4{font-size:36px;line-height:102%}.fb-h5{font-size:28px;line-height:114%}@media (max-width:768px){.fb-h1{font-size:48px}.fb-h2{font-size:40px}.fb-h3{font-size:32px}.fb-h4{font-size:28px}.fb-h5{font-size:24px}}.fb-body-l{font-size:16px;line-height:110%}.fb-body-m,.fb-body-s{font-size:14px;line-height:110%}.fb-body-s{font-size:12px}.fb-bg-navy,.fb-card-light:hover{background-color:var(--fb-navy)}.fb-bg-navy-light{background-color:var(--fb-navy-light)}.fb-bg-grey{background-color:var(--fb-grey)}.fb-bg-white{background-color:var(--fb-white)}.fb-bg-bandwidth{background-color:var(--fb-bandwidth)}.fb-bg-blue{background-color:var(--fb-blue)}.fb-text-navy{color:var(--fb-navy)}.fb-text-white{color:var(--fb-white)}.fb-text-grey{color:var(--fb-grey)}.fb-text-grey-60{color:var(--fb-grey-60)}.fb-card-light:hover .fb-card-label,.fb-text-bandwidth{color:var(--fb-bandwidth)}.fb-text-gold{color:var(--fb-gold)}.fb-border-grey-200{border:1px solid var(--fb-grey-200)}.fb-mono,.fb-mono-accent{font-family:'JetBrains Mono',ui-monospace,SFMono-Regular,Menlo,monospace}.fb-mono-accent{color:var(--fb-bandwidth);font-size:12px;letter-spacing:0}.fb-landing a,.fb-landing button{transition:background-color .2s ease,color .2s ease,border-color .2s ease}.fb-card-light{background-color:var(--fb-white);border:1px solid var(--fb-grey-200);border-top:3px solid var(--fb-bandwidth);border-radius:12px;padding:24px;color:var(--fb-navy);text-decoration:none;display:flex;flex-direction:column;transition:background-color .2s ease,color .2s ease,border-color .2s ease,transform .2s ease,box-shadow .2s ease}.fb-card-light:hover{color:var(--fb-grey);border-color:var(--fb-navy);border-top-color:var(--fb-bandwidth);transform:translateY(-4px);box-shadow:0 8px 24px rgba(33,38,71,.12)}.fb-card-light:hover .fb-card-title{color:var(--fb-grey)}.fb-card-light:hover .fb-card-desc{color:rgba(255,255,255,.7)}.fb-card-light:hover .fb-mono-accent{color:var(--fb-gold)}.fb-card-light:hover .fb-card-summary{color:var(--fb-grey)}.fb-card-dark,.fb-cta-primary{color:var(--fb-white);text-decoration:none}.fb-card-dark{background-color:var(--fb-navy-light);border-radius:12px;padding:32px;display:block;transition:background-color .2s ease}.fb-card-dark:hover{background-color:#37426e}.fb-card-dark:hover .fb-cta-text,.fb-dynamic-section .fb-card-dark:hover .fb-card-label,.fb-dynamic-section .fb-card-dark:hover .fb-mono-accent{color:var(--fb-gold)}.fb-dynamic-section .fb-card-dark:hover{background-color:rgba(255,255,255,.12)}.fb-cta-primary{display:inline-flex;align-items:center;gap:8px;background-color:var(--fb-bandwidth);font-family:'Figtree',system-ui,sans-serif;font-weight:700;font-size:16px;padding:16px 32px;border-radius:8px;border:0;cursor:pointer}.fb-cta-primary:hover{background-color:var(--fb-bandwidth-hover);color:var(--fb-white)}.fb-cta-outline{background-color:transparent;border:1px solid rgba(33,38,71,.25);color:var(--fb-navy);text-decoration:none}.fb-cta-outline:hover{background-color:rgba(33,38,71,.06);border-color:var(--fb-navy);color:var(--fb-navy)}.fb-cta-text{color:var(--fb-bandwidth);font-weight:700;text-decoration:none}.fb-consent a:hover,.fb-cta-text:hover,.fb-customer-stories-cta:hover .fb-customer-stories-link,.fb-dynamic-section .fb-section-cta:hover{color:var(--fb-gold)}.fb-input{background-color:var(--fb-white);color:var(--fb-navy);border:1px solid var(--fb-grey-200);border-radius:12px;padding:12px 16px;font-family:'Figtree',system-ui,sans-serif;font-size:16px;outline:0;height:48px;width:100%;transition:border-color .2s ease}.fb-input:focus{border-color:var(--fb-bandwidth)}.fb-input--error{border-color:#ff648b}.fb-tab{background-color:transparent;color:var(--fb-navy);border:1px solid var(--fb-grey-200);padding:8px 16px;font-family:'Figtree',system-ui,sans-serif;font-weight:700;font-size:14px;border-radius:24px;cursor:pointer}.fb-tab--active,.fb-tab:hover{background-color:var(--fb-navy);color:var(--fb-grey);border-color:var(--fb-navy)}.fb-code-block{background-color:var(--fb-navy-light);border:1px solid #3a4677;border-radius:12px;padding:16px 20px;font-family:'JetBrains Mono',ui-monospace,monospace;color:var(--fb-grey);font-size:14px;display:flex;align-items:center;justify-content:space-between;gap:16px;min-width:0}.fb-code-block .fb-mono{overflow-x:auto;white-space:nowrap;min-width:0;flex:1;scrollbar-width:none;-ms-overflow-style:none}.fb-code-block .fb-mono::-webkit-scrollbar{display:none}.fb-code-block--light{background-color:var(--fb-white);border:1px solid var(--fb-grey-200);color:var(--fb-navy)}.fb-copy-btn,.fb-eyebrow{font-family:'Figtree',system-ui,sans-serif;font-weight:700;font-size:12px;border-radius:8px}.fb-copy-btn{background-color:transparent;color:inherit;border:1px solid currentColor;padding:4px 12px;cursor:pointer;opacity:.7}.fb-copy-btn:hover{opacity:1}.fb-eyebrow{display:inline-block;letter-spacing:.08em;color:var(--fb-bandwidth);background-color:rgba(103,139,255,.12);padding:8px 16px}.fb-list-triangle{list-style:none;padding:0;margin:0}.fb-list-triangle li{padding-left:16px;position:relative;margin-bottom:8px}.fb-list-triangle li::before{content:'';position:absolute;left:0;top:6px;width:0;height:0;border-left:6px solid var(--fb-bandwidth);border-top:4px solid transparent;border-bottom:4px solid transparent}.fb-section{padding:96px 0}@media (max-width:1024px){.fb-section{padding:72px 0}}@media (max-width:768px){.fb-section{padding:56px 0}}.fb-measure{max-width:720px}.fb-stack-lg{margin-bottom:48px}.fb-section-note{font-family:'Figtree',system-ui,sans-serif;font-size:13px;line-height:150%;color:var(--fb-navy);background-color:rgba(255,198,78,.16);border-left:3px solid var(--fb-gold);border-radius:6px;padding:10px 14px;margin:0 0 24px;max-width:720px}.fb-section-cta{display:inline-block;margin-top:32px}.fb-dynamic-section .fb-section-cta{color:var(--fb-white)}.fb-dynamic-top{display:grid;grid-template-columns:minmax(0,1fr) minmax(0,1fr);gap:48px;align-items:center;margin-bottom:48px}.fb-dynamic-top .fb-section-sub{margin-bottom:0}.fb-dynamic-video{display:block;width:100%;max-width:420px;margin-left:auto;aspect-ratio:1/1;object-fit:cover;border-radius:12px}@media (max-width:900px){.fb-dynamic-top{grid-template-columns:1fr;gap:32px}.fb-dynamic-video{margin:0 auto}}.fb-section-title{margin:0 0 20px}.fb-section-sub{max-width:720px;margin:0 0 48px;line-height:160%}.fb-container,.fb-nav-inner{width:100%;max-width:calc(var(--fb-max-w) + (2*var(--fb-gutter)));margin:0 auto;padding:0 var(--fb-gutter)}.fb-grid-quick{display:grid;grid-template-columns:repeat(4,1fr);gap:16px}.fb-grid-use-cases{display:grid;grid-template-columns:repeat(2,1fr);gap:24px}.fb-customer-stories-cta{position:relative;display:flex;align-items:center;justify-content:space-between;gap:24px;margin-top:32px;padding:32px 40px;max-width:none;border-radius:16px;overflow:hidden;text-decoration:none}.fb-customer-stories-bg{position:absolute;inset:0;width:100%;height:100%;object-fit:cover;pointer-events:none}.fb-customer-stories-content{position:relative;z-index:1;display:flex;align-items:center;justify-content:space-between;gap:24px;width:100%}.fb-customer-stories-label{display:block;font-weight:700;font-size:18px;color:var(--fb-white);margin-bottom:4px}.fb-customer-stories-text{display:block;color:rgba(255,255,255,.85);font-size:15px;line-height:1.5}.fb-customer-stories-link{color:var(--fb-white);font-weight:700;font-size:16px;white-space:nowrap;flex-shrink:0;transition:color .2s ease}@media (max-width:640px){.fb-customer-stories-content{flex-direction:column;align-items:flex-start}}.fb-grid-community{display:grid;grid-template-columns:repeat(3,1fr);gap:24px}.fb-grid-feed{display:grid;grid-template-columns:1fr;gap:16px}@media (min-width:769px){.fb-grid-feed{grid-template-columns:repeat(2,1fr)}}.fb-hero-section{position:relative;overflow:hidden;background:linear-gradient(135deg,#e8edff 0,#d4deff 60%,#c2d1ff 100%)}.fb-hero-bg{position:absolute;right:5%;bottom:-10%;width:440px;height:440px;opacity:.3;pointer-events:none;animation:fb-float 6s ease-in-out infinite}.fb-hero-bg img{display:block;width:100%;height:100%;object-fit:contain}.fb-hero-banner{position:relative;z-index:1;padding:72px var(--fb-gutter) 64px}.fb-hero-copy{margin-bottom:32px}.fb-hero-title{margin:0 0 8px;animation:fb-fade-up .6s ease-out both}.fb-hero-sub{margin:0;color:rgba(33,38,71,.7);line-height:150%;max-width:650px;animation:fb-fade-up .6s ease-out .35s both}.fb-gs-card{background:rgba(255,255,255,.15);backdrop-filter:blur(4px);-webkit-backdrop-filter:blur(4px);border:1px solid rgba(255,255,255,.35);border-radius:16px;animation:fb-fade-up .6s ease-out .65s both;box-shadow:0 8px 32px rgba(33,38,71,.12),0 2px 6px rgba(33,38,71,.06),inset 0 1px 0 rgba(255,255,255,.3)}.fb-gs-card-content{padding:28px 32px}.fb-hero-actions{margin-top:0;opacity:0;transform:translateY(20px);transition:opacity .5s ease-out,transform .5s ease-out}.fb-gs-step.fb-visible,.fb-hero-actions.fb-visible{opacity:1;transform:translateY(0)}.fb-gs-steps{list-style:none;margin:0 0 40px;padding:0;width:100%}.fb-gs-step{position:relative;display:grid;grid-template-columns:28px minmax(0,1fr);gap:12px;padding-bottom:20px;opacity:0;transform:translateY(20px);transition:opacity .5s ease-out,transform .5s ease-out}.fb-gs-step:last-child{padding-bottom:0}.fb-gs-step:not(:last-child)::before{content:'';position:absolute;left:13px;top:30px;bottom:4px;width:2px;background:rgba(33,38,71,.1)}.fb-gs-badge{position:relative;z-index:1;width:28px;height:28px;border-radius:50%;display:flex;align-items:center;justify-content:center;background:var(--fb-navy);color:var(--fb-white);font-family:'Figtree',system-ui,sans-serif;font-weight:700;font-size:12px}.fb-gs-step-main{min-width:0;padding-top:4px}.fb-gs-step-desc,.fb-gs-step-title{font-family:'Figtree',system-ui,sans-serif}.fb-gs-step-title{font-weight:700;font-size:18px;line-height:1.2;color:var(--fb-navy);margin:0 0 6px}.fb-gs-step-desc{font-size:14px;line-height:1.5;color:rgba(33,38,71,.72);margin:0}.fb-gs-tabs{display:flex;flex-wrap:wrap;gap:6px;margin:14px 0 12px}.fb-gs-tab{background:0 0;border:1px solid var(--fb-grey-200);color:var(--fb-navy);font-family:'Figtree',system-ui,sans-serif;font-weight:600;font-size:13px;padding:6px 12px;border-radius:20px;cursor:pointer}.fb-gs-tab:hover{border-color:var(--fb-bandwidth);color:var(--fb-bandwidth)}.fb-gs-tab--active{background:var(--fb-navy);border-color:var(--fb-navy)}.fb-gs-tab--active,.fb-gs-tab--active:hover{color:var(--fb-white)}.fb-gs-tab-panel{min-height:48px;display:flex;align-items:center}.fb-gs-code{padding:8px 12px;font-size:12px;border-radius:8px;max-width:480px}.fb-gs-inline-endpoint{font-size:13px;color:var(--fb-navy)}.fb-gs-add-btn{padding:8px 16px;font-size:13px}.fb-gs-step--compact{padding-bottom:0}.fb-gs-step--compact .fb-gs-step-main{padding-top:4px}.fb-gs-prompt{margin-top:12px;padding:12px 14px 12px 16px;border-left:3px solid var(--fb-bandwidth);border-radius:8px;background:rgba(103,139,255,.08);font-family:'Figtree',system-ui,sans-serif;font-size:14px;font-style:italic;line-height:1.45;color:var(--fb-navy)}@media (max-width:768px){.fb-hero-banner{padding:48px var(--fb-gutter) 40px}.fb-gs-card-content{padding:28px 24px}.fb-hero-bg{width:280px;height:280px;opacity:.2}}.fb-section--tight{padding:0 0 48px}.fb-newsletter-card{position:relative;overflow:hidden;background-color:var(--fb-bandwidth);border-radius:20px;padding:40px 40px 32px}.fb-feed-card-img img,.fb-newsletter-card-bg{width:100%;height:100%;object-fit:cover;pointer-events:none}.fb-newsletter-card-bg{position:absolute;inset:0}.fb-newsletter-blurb,.fb-newsletter-card-title,.fb-newsletter-form{position:relative;z-index:1}.fb-newsletter-card-title{margin:0 0 8px}.fb-newsletter-blurb{line-height:160%;margin:0 0 24px}.fb-newsletter-form{display:flex;flex-direction:column;gap:12px}.fb-newsletter-input-row{display:flex;gap:12px;align-items:flex-end}.fb-newsletter-field{flex:1;display:flex;flex-direction:column;gap:6px;max-width:400px}.fb-consent,.fb-field-label{font-family:'Figtree',system-ui,sans-serif}.fb-field-label{font-weight:700;font-size:14px;color:var(--fb-grey)}.fb-consent{font-size:12px;line-height:150%;color:rgba(249,250,252,.85);margin:0;max-width:480px}.fb-consent a{color:var(--fb-bandwidth);font-weight:700}.fb-subscribe-btn{height:48px;white-space:nowrap;flex-shrink:0;background-color:var(--fb-white);color:var(--fb-navy)}.fb-subscribe-btn:hover{background-color:var(--fb-bandwidth);color:var(--fb-white)}@media (max-width:640px){.fb-newsletter-card{padding:32px 24px 28px;border-radius:16px}.fb-newsletter-input-row{flex-direction:column;align-items:stretch}.fb-subscribe-btn{align-self:flex-start}}@media (max-width:1024px){.fb-grid-quick{grid-template-columns:repeat(2,1fr)}}@media (max-width:768px){.fb-grid-community,.fb-grid-quick,.fb-grid-use-cases{grid-template-columns:1fr}}.fb-tab-strip{display:flex;gap:8px;flex-wrap:wrap;margin-bottom:32px}@media (max-width:768px){.fb-tab-strip{overflow-x:auto;flex-wrap:nowrap;-webkit-overflow-scrolling:touch}}.fb-divider{height:1px;background-color:var(--fb-grey-200);margin:64px 0;border:0}.fb-text-error{color:#ff648b}.fb-cta-row{display:flex;gap:12px;flex-wrap:wrap}.fb-code-block.justify-start{justify-content:flex-start}.fb-card-label{font-family:'Figtree',system-ui,sans-serif;font-weight:700;font-size:13px;color:var(--fb-bandwidth);display:block;margin-bottom:6px;letter-spacing:.02em}.fb-card-desc,.fb-card-summary,.fb-card-title{font-family:'Figtree',system-ui,sans-serif;margin:0 0 12px}.fb-card-desc{font-size:13px;color:rgba(33,38,71,.6);line-height:150%;flex:1}.fb-card-summary,.fb-card-title{font-weight:700;font-size:16px;color:var(--fb-navy);line-height:130%}.fb-card-summary{font-weight:400;font-size:14px;margin:0 0 16px;line-height:140%;opacity:.8}.fb-feed-card{display:flex;flex-direction:column;text-decoration:none;background-color:var(--fb-white);border:1px solid var(--fb-grey-200);border-radius:12px;overflow:hidden;color:var(--fb-navy);transition:background-color .2s ease,color .2s ease,border-color .2s ease}.fb-feed-card-img{position:relative;width:100%;height:180px;left:-1px;overflow:hidden;flex-shrink:0}.fb-feed-card-img img{display:block}.fb-feed-card--upcoming .fb-feed-card-img img{object-position:center 40%}.fb-feed-card-body{padding:24px;flex:1;display:flex;flex-direction:column}.fb-feed-card-body .fb-card-summary{flex:1}.fb-feed-card-body .fb-feed-tags{margin-top:auto;padding-top:8px}.fb-feed-card:hover{background-color:var(--fb-navy);border-color:var(--fb-navy)}.fb-feed-card:hover,.fb-feed-card:hover .fb-card-summary,.fb-feed-card:hover .fb-card-title,.fb-feed-card:hover .fb-feed-meta{color:var(--fb-grey)}.fb-feed-card:hover .fb-feed-cta{color:var(--fb-gold)}.fb-feed-card:hover .fb-feed-tag{background-color:rgba(249,250,252,.12);color:var(--fb-grey);border-color:rgba(249,250,252,.25)}.fb-feed-card:hover .fb-feed-location{color:var(--fb-grey);opacity:.85}.fb-feed-card--upcoming{border-color:var(--fb-bandwidth);box-shadow:0 0 0 1px var(--fb-bandwidth)}.fb-feed-location,.fb-upcoming-badge{align-items:center;font-family:'Figtree',system-ui,sans-serif}.fb-upcoming-badge{position:absolute;top:12px;left:12px;display:inline-flex;gap:4px;font-weight:700;font-size:11px;letter-spacing:.08em;color:var(--fb-white);background-color:var(--fb-bandwidth);padding:5px 12px;border-radius:6px;z-index:1}.fb-feed-location{display:flex;gap:6px;font-size:13px;font-weight:600;color:var(--fb-navy);opacity:.7;margin-top:8px}.fb-feed-location svg{flex-shrink:0}.fb-feed-card .fb-card-title:last-child{margin-bottom:0}.fb-feed-card:has(.fb-feed-tags) .fb-card-summary{margin-bottom:12px}.fb-feed-card:has(.fb-feed-location) .fb-card-summary{margin-bottom:4px}.fb-feed-meta{font-family:'Figtree',system-ui,sans-serif;font-weight:700;font-size:12px;letter-spacing:.06em;color:var(--fb-bandwidth);margin-bottom:12px;display:flex;justify-content:space-between;align-items:center;gap:16px}.fb-feed-meta-category,.fb-feed-meta-label{text-transform:uppercase}.fb-feed-meta-category{color:var(--fb-bandwidth)}.fb-feed-tags{display:flex;flex-wrap:wrap;gap:8px;margin-top:4px}.fb-feed-tag,.fb-footer-links a{font-family:'Figtree',system-ui,sans-serif}.fb-feed-tag{display:inline-block;font-weight:600;font-size:12px;color:var(--fb-navy);background-color:var(--fb-grey);border:1px solid var(--fb-grey-200);border-radius:20px;padding:6px 14px;transition:background-color .2s ease,color .2s ease,border-color .2s ease}.fb-feed-cta{color:var(--fb-bandwidth);font-weight:700;white-space:nowrap}.fb-bounty-strip{margin-top:32px;padding-top:32px;border-top:1px solid var(--fb-grey-200)}.fb-bounty-intro .fb-card-summary{margin-bottom:0}.fb-bounty-links,.fb-bounty-strip{display:grid;grid-template-columns:1fr;gap:16px}.fb-bounty-card .fb-feed-card-body{padding:20px 24px}@media (min-width:769px){.fb-bounty-strip{grid-template-columns:1fr 2fr;align-items:center}.fb-bounty-links{grid-template-columns:repeat(2,1fr)}}.fb-card-dark .fb-card-label{color:var(--fb-bandwidth)}.fb-card-dark .fb-card-title,.fb-footer-links a:hover{color:var(--fb-white)}.fb-card-dark .fb-card-summary{color:var(--fb-grey);opacity:1}.fb-final-cta-inner{text-align:center;display:flex;flex-direction:column;align-items:center;max-width:640px;margin:0 auto}.fb-final-cta .fb-cta-row{margin-top:12px;justify-content:center}.fb-final-cta .fb-cta-outline{border-color:rgba(249,250,252,.4);color:var(--fb-white)}.fb-final-cta .fb-cta-outline:hover{background-color:rgba(249,250,252,.08);border-color:var(--fb-white);color:var(--fb-white)}.fb-footer{border-top:1px solid rgba(249,250,252,.1);padding:24px 0}.fb-footer-inner,.fb-footer-links{display:flex;align-items:center;gap:24px}.fb-footer-inner{justify-content:space-between}.fb-footer-links{flex-wrap:wrap}.fb-footer-links a{color:rgba(249,250,252,.5);text-decoration:none;font-size:13px;transition:color .2s ease}.fb-footer-badges img{display:block;height:40px;width:auto}@media (max-width:768px){.fb-footer-inner{flex-direction:column;align-items:flex-start;gap:16px}.fb-footer-links{gap:12px 20px}.fb-footer-badges img{height:32px}}.get-started-section{padding:0 1.5rem;border-radius:14px;border:1px solid rgba(0,82,236,.2);background:linear-gradient(135deg,rgba(0,82,236,.04),rgba(0,52,154,.06));margin-bottom:2rem}html[data-theme=dark] .get-started-section{border-color:rgba(0,82,236,.25);background:linear-gradient(135deg,rgba(0,82,236,.08),rgba(0,42,120,.1))}#ot-sdk-btn-floating .ot-floating-button__back,#ot-sdk-btn-floating .ot-floating-button__front{inset:0;width:100%;height:100%}#ot-sdk-btn-floating .ot-floating-button__close,#ot-sdk-btn-floating .ot-floating-button__open{position:relative;width:100%;height:100%;margin:0;padding:0}#ot-sdk-btn-floating .ot-floating-button__close svg{position:absolute;top:50%;left:50%;width:16px;height:16px;margin:0;transform:translate(-50%,-50%)}.fb-as-card{position:relative;margin-bottom:24px;padding:20px 48px 20px 20px;border:1px solid rgba(9,9,11,.1);border-radius:12px;background:linear-gradient(23deg,rgba(0,82,236,.06),transparent)}.fb-as-card-title{font-size:16px;font-weight:600;color:#09090b}.fb-as-card-sub,.fb-as-text{margin-top:4px;font-size:14px;line-height:1.5;color:#52525b}.fb-as-card-actions{display:flex;flex-wrap:wrap;align-items:center;gap:12px;margin-top:16px}.fb-as-note{flex:1 1 240px;min-width:0;width:auto;margin:0;font-size:12px;color:#71717a}.fb-as-btn,.fb-as-details summary{cursor:pointer;color:#0052ec;font-size:14px}.fb-as-btn{padding:6px 16px;border:1px solid #0052ec;border-radius:9999px;background:0 0;font-weight:600}.fb-as-btn:hover{background:rgba(0,82,236,.06)}.fb-as-icon-btn{display:inline-flex;padding:4px;border:0;border-radius:6px;background:0 0;color:#71717a;cursor:pointer}.fb-as-icon-btn:hover{background:rgba(9,9,11,.05);color:#09090b}.fb-as-dismiss{position:absolute;top:12px;right:12px}.fb-as-backdrop{position:fixed;inset:0;z-index:1000;display:flex;align-items:center;justify-content:center;padding:16px;background:rgba(0,0,0,.5)}.fb-as-dialog{width:100%;max-width:32rem;border:1px solid rgba(9,9,11,.1);border-radius:16px;background:#fff;box-shadow:0 20px 40px rgba(0,0,0,.25)}.fb-as-dialog-head{display:flex;align-items:center;justify-content:space-between;padding:20px 24px 0}.fb-as-dialog-title{font-size:18px;font-weight:600;color:#09090b}.fb-as-dialog-body{padding:16px 24px}.fb-as-dialog-foot{display:flex;justify-content:flex-end;padding:12px 24px;border-top:1px solid rgba(9,9,11,.1)}.fb-as-status{display:flex;gap:10px;align-items:flex-start;padding:10px 12px;border:1px solid rgba(22,163,74,.6);border-radius:8px;background:rgba(22,163,74,.1);color:#166534;font-size:14px;line-height:1.5}.fb-as-status--warn{border-color:rgba(245,158,11,.6);background:rgba(245,158,11,.1);color:#92400e}.fb-as-status-icon{display:inline-flex;flex-shrink:0;margin-top:2px}.fb-as-safety{font-size:13px;line-height:1.5;color:#71717a}.fb-as-details,.fb-as-safety{margin-top:12px}.fb-as-details summary{width:fit-content;font-weight:500}.fb-as-prompt{position:relative;margin-top:8px;padding:12px 40px 12px 12px;border:1px solid rgba(9,9,11,.1);border-radius:8px;background:#fafafa}.fb-as-prompt pre{margin:0;padding:0;background:0 0;white-space:pre-wrap;word-break:break-word;font-family:'JetBrains Mono',monospace;font-size:12px;color:#27272a}.fb-as-copy{position:absolute;top:8px;right:8px}.fb-as-strong{margin-top:16px;font-weight:500;color:#3f3f46}.fb-as-steps{margin:4px 0 0;padding-left:20px;list-style:decimal;font-size:14px;line-height:1.5;color:#3f3f46}.fb-as-steps li+li{margin-top:6px}.fb-as-link{display:inline-block;margin-top:12px;color:#0052ec;font-size:14px;font-weight:500}:is(.dark, [data-theme='dark']) .fb-as-card{border-color:rgba(255,255,255,.1);background:linear-gradient(23deg,rgba(0,82,236,.18),transparent)}:is(.dark, [data-theme='dark']) .fb-as-card-title,:is(.dark, [data-theme='dark']) .fb-as-dialog-title{color:#fff}:is(.dark, [data-theme='dark']) .fb-as-card-sub,:is(.dark, [data-theme='dark']) .fb-as-steps,:is(.dark, [data-theme='dark']) .fb-as-strong,:is(.dark, [data-theme='dark']) .fb-as-text{color:#d4d4d8}:is(.dark, [data-theme='dark']) .fb-as-icon-btn,:is(.dark, [data-theme='dark']) .fb-as-note{color:#a1a1aa}:is(.dark, [data-theme='dark']) .fb-as-icon-btn:hover{background:rgba(255,255,255,.1);color:#fff}:is(.dark, [data-theme='dark']) .fb-as-btn,:is(.dark, [data-theme='dark']) .fb-as-details summary{color:#678bff}:is(.dark, [data-theme='dark']) .fb-as-status{color:#86efac}:is(.dark, [data-theme='dark']) .fb-as-status--warn{color:#fcd34d}:is(.dark, [data-theme='dark']) .fb-as-safety{color:#a1a1aa}:is(.dark, [data-theme='dark']) .fb-as-link{border-color:#678bff;color:#678bff}:is(.dark, [data-theme='dark']) .fb-as-dialog{border-color:rgba(255,255,255,.1);background:#18181b}:is(.dark, [data-theme='dark']) .fb-as-dialog-foot,:is(.dark, [data-theme='dark']) .fb-as-prompt{border-color:rgba(255,255,255,.1)}:is(.dark, [data-theme='dark']) .fb-as-prompt{background:#09090b}:is(.dark, [data-theme='dark']) .fb-as-prompt pre{color:#e4e4e7}"}],"page":{"pagePath":"api-reference/off-exchanges/remove-collateral","slug":"/api-reference/off-exchanges/remove-collateral","pageMetadata":{"title":"Remove Collateral","description":"Remove collateral, create withdraw request.\nLearn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).\nEndpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /off_exchange/remove","href":"/api-reference/off-exchanges/remove-collateral","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Remove collateral, create withdraw request.\\nLearn more about Fireblocks Off Exchange in the following \", _jsx(_components.a, {\n href: \"https://developers.fireblocks.com/docs/off-exchange\",\n children: \"guide\"\n }), \".\\nEndpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Remove Collateral","description":"Remove collateral, create withdraw request.\nLearn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).\nEndpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /off_exchange/remove","href":"/api-reference/off-exchanges/remove-collateral","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fireblocks-43c4b3ee/2b4293c42168c590/onetrust.js","/_mintlify/custom/fireblocks-43c4b3ee/8dce45030d12e791/agent-setup-banner.js","/_mintlify/custom/fireblocks-43c4b3ee/5d85baf5323ffc87/changelog-embed.js"],"openApiReferenceData":{"operation":{"summary":"Remove Collateral","description":"Remove collateral, create withdraw request.\nLearn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).\nEndpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.","tags":["Off exchanges"],"x-rate-limit-category":"write","x-lifecycle":{"state":"ga"},"parameters":["5c5f391e-d81a-47a1-99b3-88cba93df78a"],"requestBody":"ac516e59-1c63-47c6-83a8-00c46fa215f9","responses":{"200":"b737208d-efa6-467d-bcac-e63e3778e567","default":"f7f3b9ac-17bc-4eb5-a9b2-43aca262e900"},"operationId":"removeOffExchange","x-readme":{"code-samples":[{"language":"typescript","code":"const response: Promise\u003cFireblocksResponse\u003cCreateTransactionResponse>> = fireblocks.offExchanges.removeOffExchange(offExchangesApiRemoveOffExchangeRequest);","name":"Fireblocks SDK TypeScript example"},{"language":"java","code":"CompletableFuture\u003cApiResponse\u003cCreateTransactionResponse>> response = fireblocks.offExchanges().removeOffExchange(removeCollateralRequestBody, idempotencyKey);","name":"Fireblocks SDK Java example"},{"language":"python","code":"response = fireblocks.off_exchanges.remove_off_exchange(remove_collateral_request_body, idempotency_key);","name":"Fireblocks SDK Python example"}]},"x-codeSamples":[{"lang":"TypeScript","source":"const response: Promise\u003cFireblocksResponse\u003cCreateTransactionResponse>> = fireblocks.offExchanges.removeOffExchange(offExchangesApiRemoveOffExchangeRequest);"},{"lang":"Java","source":"CompletableFuture\u003cApiResponse\u003cCreateTransactionResponse>> response = fireblocks.offExchanges().removeOffExchange(removeCollateralRequestBody, idempotencyKey);"},{"lang":"Python","source":"response = fireblocks.off_exchanges.remove_off_exchange(remove_collateral_request_body, idempotency_key);"}],"method":"post","type":"path","servers":["faba5ef0-79cc-44c8-83a9-99abf6131993","4a950989-e32e-4fab-b303-8cd91145921d"],"security":[],"path":"/off_exchange/remove","baseUrlOptions":["https://api.fireblocks.io/v1","https://sandbox-api.fireblocks.io/v1"],"title":"Remove Collateral","codeSamples":[{"lang":"TypeScript","source":"const response: Promise\u003cFireblocksResponse\u003cCreateTransactionResponse>> = fireblocks.offExchanges.removeOffExchange(offExchangesApiRemoveOffExchangeRequest);"},{"lang":"Java","source":"CompletableFuture\u003cApiResponse\u003cCreateTransactionResponse>> response = fireblocks.offExchanges().removeOffExchange(removeCollateralRequestBody, idempotencyKey);"},{"lang":"Python","source":"response = fireblocks.off_exchanges.remove_off_exchange(remove_collateral_request_body, idempotency_key);"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"5c5f391e-d81a-47a1-99b3-88cba93df78a":{"name":"Idempotency-Key","in":"header","description":"A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.","required":false,"schema":{"type":"string","isRequired":false,"description":"A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"transactionRequest":{"type":"object","properties":{"operation":{"type":"string","default":"TRANSFER","enum":["TRANSFER","BURN","CONTRACT_CALL","PROGRAM_CALL","SOROBAN_CALL","MINT","RAW","TYPED_MESSAGE","APPROVE","ENABLE_ASSET","CANTON_CALL"],"description":"* `TRANSFER` - The default value for an operation. Transfers funds from one account to another. UTXO blockchains allow multi-input and multi-output transfers. All other blockchains allow transfers with one source address and one destination address.\n* `MINT` - Mints new tokens. Supported for Stellar, Ripple and EVM-based blockchains.\n* `BURN` - Burns tokens. Supported for Stellar, Ripple and EVM-based blockchains.\n* `CONTRACT_CALL` - Calls a smart contract method for web3 operations on any EVM blockchain. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.\n* `PROGRAM_CALL` - Execute multiple instructions on Solana blockchain. The @solana/web3.js library is recommended for building program call transactions.\n\n* `SOROBAN_CALL` - Invokes a Soroban smart contract on the Stellar blockchain. The call is submitted as a base64-encoded, unsigned Stellar `TransactionEnvelope` in `extraParameters.sorobanCallData.envelopeXdr`, which is the same artifact a Soroban dApp hands a wallet. Fireblocks decodes the envelope, determines the footprint, resource fee, sequence number and authorization entries itself, and signs a transaction it rebuilt - the submitted envelope must therefore carry no signatures and no authorization entries. `assetId` is the fee asset (`XLM` or `XLM_TEST`), not the token being moved, and `destination` is the contract wallet or, when enabled for your workspace, a `ONE_TIME_ADDRESS` holding a Stellar contract address (`C...`). `amount` must be omitted or `0`. Fee estimation is not supported for this operation.\n\n* `TYPED_MESSAGE` - An off-chain message in either Ethereum Personal Message or EIP712 format. Use it to sign specific readable messages that are not actual transactions. [Learn more about typed messages](https://developers.fireblocks.com/docs/typed-message-signing).\n* `RAW` - An off-chain message with no predefined format. Use it to sign any message with your private key, including protocols such as blockchains and custom transaction types that are not natively supported by Fireblocks. [Learn more about raw signing transactions.](https://developers.fireblocks.com/docs/raw-message-signing)\n* `APPROVE` - Enables the approve function for a smart contract or wallet to withdraw from a designated wallet. [Learn more](https://support.fireblocks.io/hc/en-us/articles/4404616097426-Amount-Cap-for-Approve-transactions).\n* `ENABLE_ASSET` - Algorand, DigitalBits, Solana, and Stellar require an on-chain transaction to create an asset wallet and enable the deposit address. This transaction is automatically created when adding assets on these blockchains at a vault account.\n* `CANTON_CALL` - A customer-initiated Canton operation, such as withdrawing an allocation or responding to an onboarding offer. Note that not every Canton transaction carries this operation — an incoming Canton transfer offer is a `TRANSFER` — so use the top-level `cantonDetails` rather than `operation` to identify a Canton transaction.\n","uniqueKey":"transactionRequest.operation","typeLabel":"enum\u003cstring>"},"note":{"type":"string","description":"Custom note, not sent to the blockchain, to describe the transaction at your Fireblocks workspace.","example":"Ticket 123","uniqueKey":"transactionRequest.note","typeLabel":"string"},"externalTxId":{"type":"string","description":"This parameter allows you to add a unique ID of your own to help prevent duplicate transactions. No specific format is required for this parameter.\nAfter you submit a transaction with an external ID, Fireblocks will automatically reject all future transactions with the same ID. Using an external ID primarily helps in situations where, even though a submitted transaction responds with an error due to an internet outage, the transaction was still sent to and processed on the blockchain. Use the [Get a specific transaction by external transaction ID](https://developers.fireblocks.com/reference/gettransactionbyexternalid) endpoint to validate whether these transactions have been processed.","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"transactionRequest.externalTxId","typeLabel":"string"},"feeCurrency":{"type":"string","x-fb-entity":"asset","description":"For Tempo-based transactions only, the asset used to pay the transaction's network fee, as an asset ID ([see supported assets](https://developers.fireblocks.com/api-reference/blockchains-\u0026-assets/list-assets)). For any other blockchain, this value is ignored. This feature is currently in beta and might be subject to changes.","example":"PATHUSD_TEMPO_54V8","uniqueKey":"transactionRequest.feeCurrency","typeLabel":"string"},"assetId":{"type":"string","description":"The ID of the asset to transfer, for `TRANSFER`, `MINT` or `BURN` operations. [See the list of supported assets and their IDs on Fireblocks.](https://developers.fireblocks.com/reference/gettrlinksupportedasset#/)","x-fb-entity":"asset","example":"ETH","uniqueKey":"transactionRequest.assetId","typeLabel":"string"},"source":{"type":"object","description":"The source of the transaction.","properties":{"type":{"type":"string","enum":["VAULT_ACCOUNT","EXCHANGE_ACCOUNT","CONNECTED_ACCOUNT","INTERNAL_WALLET","EXTERNAL_WALLET","CONTRACT","NETWORK_CONNECTION","FIAT_ACCOUNT","COMPOUND","GAS_STATION","ONE_TIME_ADDRESS","UNKNOWN","END_USER_WALLET","PROGRAM_CALL","MULTI_DESTINATION","OEC_PARTNER","WALLET_POOL","SOROBAN_CONTRACT"],"isRequired":true,"uniqueKey":"transactionRequest.source.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["BINANCE","BINANCEUS","BITFINEX","BITHUMB","BITMEX","BITSO","BITSTAMP","BITTREX","BLINC","BYBIT","CIRCLE","COINBASEEXCHANGE","COINBASEPRO","COINMETRO","COINSPRO","CRYPTOCOM","DERIBIT","GEMINI","HITBTC","HUOBI","INDEPENDENTRESERVE","KORBIT","KRAKEN","KRAKENINTL","KUCOIN","LIQUID","OKCOIN","OKEX","PAXOS","POLONIEX","External","Internal","VIRTUAL_ACCOUNT"],"uniqueKey":"transactionRequest.source.subType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"transactionRequest.source.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"transactionRequest.source.name","typeLabel":"string"},"walletId":{"type":"string","format":"uuid","uniqueKey":"transactionRequest.source.walletId","typeLabel":"string\u003cuuid>"},"isCollateral":{"type":"boolean","example":true,"description":"indicate if the source is collateral account","uniqueKey":"transactionRequest.source.isCollateral","typeLabel":"boolean"}},"required":["type"],"uniqueKey":"transactionRequest.source","typeLabel":"object"},"destination":{"type":"object","description":"The destination of the transaction.","properties":{"type":{"type":"string","enum":["VAULT_ACCOUNT","EXCHANGE_ACCOUNT","CONNECTED_ACCOUNT","INTERNAL_WALLET","EXTERNAL_WALLET","CONTRACT","NETWORK_CONNECTION","FIAT_ACCOUNT","COMPOUND","GAS_STATION","ONE_TIME_ADDRESS","UNKNOWN","END_USER_WALLET","PROGRAM_CALL","MULTI_DESTINATION","OEC_PARTNER","WALLET_POOL","SOROBAN_CONTRACT"],"isRequired":true,"uniqueKey":"transactionRequest.destination.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["BINANCE","BINANCEUS","BITFINEX","BITHUMB","BITMEX","BITSO","BITSTAMP","BITTREX","BLINC","BYBIT","CIRCLE","COINBASEEXCHANGE","COINBASEPRO","COINMETRO","COINSPRO","CRYPTOCOM","DERIBIT","GEMINI","HITBTC","HUOBI","INDEPENDENTRESERVE","KORBIT","KRAKEN","KRAKENINTL","KUCOIN","LIQUID","OKCOIN","OKEX","PAXOS","POLONIEX","External","Internal","VIRTUAL_ACCOUNT"],"uniqueKey":"transactionRequest.destination.subType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"transactionRequest.destination.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"transactionRequest.destination.name","typeLabel":"string"},"walletId":{"type":"string","format":"uuid","uniqueKey":"transactionRequest.destination.walletId","typeLabel":"string\u003cuuid>"},"oneTimeAddress":{"type":"object","properties":{"address":{"type":"string","isRequired":true,"uniqueKey":"transactionRequest.destination.oneTimeAddress.address","typeLabel":"string"},"tag":{"type":"string","uniqueKey":"transactionRequest.destination.oneTimeAddress.tag","typeLabel":"string"}},"required":["address"],"uniqueKey":"transactionRequest.destination.oneTimeAddress","typeLabel":"object"},"isCollateral":{"type":"boolean","example":true,"description":"indicate if the destination is collateral account","uniqueKey":"transactionRequest.destination.isCollateral","typeLabel":"boolean"}},"required":["type"],"uniqueKey":"transactionRequest.destination","typeLabel":"object"},"destinations":{"type":"array","description":"For UTXO based blockchains, you can send a single transaction to multiple destinations.","items":{"type":"object","properties":{"amount":{"type":"string","uniqueKey":"transactionRequest.destinations.items.[INDEX].amount","typeLabel":"string"},"destination":{"type":"object","description":"The destination of the transaction.","properties":{"type":{"type":"string","enum":["VAULT_ACCOUNT","EXCHANGE_ACCOUNT","CONNECTED_ACCOUNT","INTERNAL_WALLET","EXTERNAL_WALLET","CONTRACT","NETWORK_CONNECTION","FIAT_ACCOUNT","COMPOUND","GAS_STATION","ONE_TIME_ADDRESS","UNKNOWN","END_USER_WALLET","PROGRAM_CALL","MULTI_DESTINATION","OEC_PARTNER","WALLET_POOL","SOROBAN_CONTRACT"],"isRequired":true,"uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["BINANCE","BINANCEUS","BITFINEX","BITHUMB","BITMEX","BITSO","BITSTAMP","BITTREX","BLINC","BYBIT","CIRCLE","COINBASEEXCHANGE","COINBASEPRO","COINMETRO","COINSPRO","CRYPTOCOM","DERIBIT","GEMINI","HITBTC","HUOBI","INDEPENDENTRESERVE","KORBIT","KRAKEN","KRAKENINTL","KUCOIN","LIQUID","OKCOIN","OKEX","PAXOS","POLONIEX","External","Internal","VIRTUAL_ACCOUNT"],"uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.subType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.name","typeLabel":"string"},"walletId":{"type":"string","format":"uuid","uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.walletId","typeLabel":"string\u003cuuid>"},"oneTimeAddress":{"type":"object","properties":{"address":{"type":"string","isRequired":true,"uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.oneTimeAddress.address","typeLabel":"string"},"tag":{"type":"string","uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.oneTimeAddress.tag","typeLabel":"string"}},"required":["address"],"uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.oneTimeAddress","typeLabel":"object"},"isCollateral":{"type":"boolean","example":true,"description":"indicate if the destination is collateral account","uniqueKey":"transactionRequest.destinations.items.[INDEX].destination.isCollateral","typeLabel":"boolean"}},"required":["type"],"uniqueKey":"transactionRequest.destinations.items.[INDEX].destination","typeLabel":"object"},"travelRuleMessageId":{"type":"string","description":"The ID of the travel rule message from any travel rule provider. Used for travel rule supporting functionality to associate transactions with existing travel rule messages.","example":"trm_12345678-1234-1234-1234-123456789012","uniqueKey":"transactionRequest.destinations.items.[INDEX].travelRuleMessageId","typeLabel":"string"},"customerRefId":{"type":"string","description":"The ID for AML providers to associate the owner of funds with transactions.","example":"abcdef","uniqueKey":"transactionRequest.destinations.items.[INDEX].customerRefId","typeLabel":"string"}},"uniqueKey":"transactionRequest.destinations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.destinations","typeLabel":"object[]"},"amount":{"oneOf":[{"type":"string","description":"For `TRANSFER` operations, the requested amount to transfer, in the asset’s unit. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","example":"0.02","uniqueKey":"transactionRequest.amount.oneOf.0","typeLabel":"string"},{"type":"number","description":"For `TRANSFER` operations, the requested amount to transfer, in the asset’s unit. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","example":0.02,"uniqueKey":"transactionRequest.amount.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.amount","typeLabel":"string | number"},"treatAsGrossAmount":{"type":"boolean","description":"\"When set to `true`, the fee will be deducted from the requested amount.\"\n\n**Note**: This parameter can only be considered if a transaction’s asset is a base asset, such as ETH or MATIC. If the asset can’t be used for transaction fees, like USDC, this parameter is ignored and the fee is deducted from the relevant base asset wallet in the source account.","example":false,"uniqueKey":"transactionRequest.treatAsGrossAmount","typeLabel":"boolean"},"forceSweep":{"type":"boolean","description":"For Polkadot, Kusama and Westend transactions only. When set to true, Fireblocks will empty the asset wallet.\n\n **Note:** If set to true when the source account is exactly 1 DOT, the transaction will fail. Any amount more or less than 1 DOT succeeds. This is a Polkadot blockchain limitation.\n\n **Note:** `forceSweep` and `treatAsGrossAmount` can also be used to empty a TON/GRAM wallet.","example":false,"uniqueKey":"transactionRequest.forceSweep","typeLabel":"boolean"},"feeLevel":{"type":"string","description":"For UTXO, EVM-based, or Solana blockchains only. Defines the blockchain fee level which will be payed for the transaction. Alternatively, specific fee estimation parameters exist below.","enum":["LOW","MEDIUM","HIGH"],"example":"MEDIUM","uniqueKey":"transactionRequest.feeLevel","typeLabel":"enum\u003cstring>"},"fee":{"oneOf":[{"type":"string","description":"For UTXO-based blockchains, the fee per bytes in the asset’s smallest unit (Satoshi, Latoshi, etc.). For Ripple, the fee for the transaction. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","uniqueKey":"transactionRequest.fee.oneOf.0","typeLabel":"string"},{"type":"number","description":"For UTXO-based blockchains, the fee per bytes in the asset’s smallest unit (Satoshi, Latoshi, etc.). For Ripple, the fee for the transaction. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","uniqueKey":"transactionRequest.fee.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.fee","typeLabel":"string | number"},"priorityFee":{"oneOf":[{"type":"string","description":"For Ethereum-based blockchains only, the fee for EIP-1559 transaction pricing mechanism. Value is in Gwei. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","example":"2","uniqueKey":"transactionRequest.priorityFee.oneOf.0","typeLabel":"string"},{"type":"number","description":"For Ethereum-based blockchains only, the fee for EIP-1559 transaction pricing mechanism. Value is in Gwei. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","example":2,"uniqueKey":"transactionRequest.priorityFee.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.priorityFee","typeLabel":"string | number"},"failOnLowFee":{"type":"boolean","description":"When set to `true`, in case the current `MEDIUM` fee level is higher than the one specified in the transaction, the transaction will fail to avoid getting stuck with no confirmations.","uniqueKey":"transactionRequest.failOnLowFee","typeLabel":"boolean"},"maxFee":{"description":"The maximum fee (gas price or fee per byte) that should be payed for the transaction. In case the current value of the requested `feeLevel` is higher than this requested maximum fee. Represented by a numeric string for accurate precision.","type":"string","example":"120","uniqueKey":"transactionRequest.maxFee","typeLabel":"string"},"maxTotalFee":{"description":"For BTC-based blockchains only. The maximum fee (in the units of the fee-paying asset) that should be paid for the transaction.","type":"string","example":"88","uniqueKey":"transactionRequest.maxTotalFee","typeLabel":"string"},"gasLimit":{"oneOf":[{"type":"string","description":"For EVM-based blockchains only. Units of gas required to process the transaction. Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","example":"21000","uniqueKey":"transactionRequest.gasLimit.oneOf.0","typeLabel":"string"},{"type":"number","description":"For EVM-based blockchains only. Units of gas required to process the transaction. Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","example":21000,"uniqueKey":"transactionRequest.gasLimit.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.gasLimit","typeLabel":"string | number"},"gasPrice":{"oneOf":[{"type":"string","description":"For non-EIP-1559, EVM-based transactions. Price per gas unit (in Ethereum this is specified in Gwei). Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","uniqueKey":"transactionRequest.gasPrice.oneOf.0","typeLabel":"string"},{"type":"number","description":"For non-EIP-1559, EVM-based transactions. Price per gas unit (in Ethereum this is specified in Gwei). Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.","uniqueKey":"transactionRequest.gasPrice.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.gasPrice","typeLabel":"string | number"},"networkFee":{"oneOf":[{"type":"string","description":"For EVM-based blockchains only. The total transaction fee in the blockchain’s largest unit. Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated. - The transaction blockchain fee.\n- For Ethereum, you can't pass gasPrice, gasLimit and networkFee all together.\n- A numeric value representation is required.","uniqueKey":"transactionRequest.networkFee.oneOf.0","typeLabel":"string"},{"type":"number","description":"For EVM-based blockchains only. The total transaction fee in the blockchain’s largest unit. Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated. - The transaction blockchain fee.\n- For Ethereum, you can't pass gasPrice, gasLimit and networkFee all together.\n- A numeric value representation is required.","uniqueKey":"transactionRequest.networkFee.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.networkFee","typeLabel":"string | number"},"replaceTxByHash":{"type":"string","description":"For EVM-based blockchains only. In case a transaction is stuck, specify the hash of the stuck transaction to replace it by this transaction with a higher fee, or to replace it with this transaction with a zero fee and drop it from the blockchain.","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"transactionRequest.replaceTxByHash","typeLabel":"string"},"extraParameters":{"type":"object","description":"Additional protocol / operation specific key-value parameters:\n\nFor UTXO-based blockchain input selection, add the key `inputsSelection` with the value set to the [input selection structure.](https://developers.fireblocks.com/reference/transaction-objects#inputsselection) The inputs can be retrieved from the [Retrieve Unspent Inputs endpoint.](https://developers.fireblocks.com/reference/getunspentinputs)\n\nFor `RAW` operations, add the key `rawMessageData` with the value set to the [raw message data structure.](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata)\n\nFor `SOROBAN_CALL` operations, add the key `sorobanCallData` with the value set to an object containing `envelopeXdr` - a base64 encoded, unsigned Stellar `TransactionEnvelope` holding the contract invocation.\n\nFor `CONTRACT_CALL` operations, add the key `contractCallData` with the value set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.\nFor **exchange compliance (e.g., Binance) and Travel Rule purposes**, include the key `piiData` containing a **custom JSON structure** with Personally Identifiable Information (PII) relevant to the transaction. This data must be fully **encrypted by the sender** before being submitted to the Fireblocks API. The recommended encryption method is **hybrid encryption** using AES-256-GCM for the payload and RSA-OAEP for key exchange, with the recipient exchange's public key. [development libraries](https://developers.fireblocks.com/docs/a-developers-guide-to-constructing-encrypted-pii-messages-for-binance-via-fireblocks)\n\n**Note:** `rawMessageData`, `contractCallData`, `sorobanCallData`, and `inputsSelection` cannot be used together in the same call.\n","additionalProperties":true,"properties":{"nodeControls":{"oneOf":[{"type":"object","description":"Configure special node requirements. For routing transactions to a custom node: Set `type` to `NODE_ROUTER` and `tag` to the pre-configured tag value. **For MEV protection:** Set only the `type` property to `MEV` (tag is not required at this stage).\n**Note:** This is a premium feature that should be enabled in your workspace. Please contact your Customer Success Manager/Fireblocks Support for more info.","additionalProperties":true,"uniqueKey":"transactionRequest.extraParameters.nodeControls.oneOf.0","typeLabel":"object"},{"description":"Configure special node requirements. For routing transactions to a custom node: Set `type` to `NODE_ROUTER` and `tag` to the pre-configured tag value. **For MEV protection:** Set only the `type` property to `MEV` (tag is not required at this stage).\n**Note:** This is a premium feature that should be enabled in your workspace. Please contact your Customer Success Manager/Fireblocks Support for more info.","enum":[null],"uniqueKey":"transactionRequest.extraParameters.nodeControls.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.nodeControls","typeLabel":"object | any"},"rawMessageData":{"oneOf":[{"type":"object","description":"Object containing messages for raw signing and the algorithm to be used. The value should be set to the [raw message data structure.](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata)","additionalProperties":true,"uniqueKey":"transactionRequest.extraParameters.rawMessageData.oneOf.0","typeLabel":"object"},{"description":"Object containing messages for raw signing and the algorithm to be used. The value should be set to the [raw message data structure.](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata)","enum":[null],"uniqueKey":"transactionRequest.extraParameters.rawMessageData.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.rawMessageData","typeLabel":"object | any"},"contractCallData":{"oneOf":[{"type":"string","description":"Hex encoded contract call data as a string. For `CONTRACT_CALL` operations, the value should be set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.","uniqueKey":"transactionRequest.extraParameters.contractCallData.oneOf.0","typeLabel":"string"},{"description":"Hex encoded contract call data as a string. For `CONTRACT_CALL` operations, the value should be set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.","enum":[null],"uniqueKey":"transactionRequest.extraParameters.contractCallData.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.contractCallData","typeLabel":"string | any"},"programCallData":{"oneOf":[{"type":"string","description":"BASE64 encoded Solana unsigned serialized transaction object.","uniqueKey":"transactionRequest.extraParameters.programCallData.oneOf.0","typeLabel":"string"},{"description":"BASE64 encoded Solana unsigned serialized transaction object.","enum":[null],"uniqueKey":"transactionRequest.extraParameters.programCallData.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.programCallData","typeLabel":"string | any"},"sorobanCallData":{"oneOf":[{"type":"object","description":"For `SOROBAN_CALL` operations, the Soroban contract invocation to execute. Contains a base64 encoded, unsigned Stellar `TransactionEnvelope` in `envelopeXdr`.","required":["envelopeXdr"],"example":{"envelopeXdr":"AAAAAgAAAADY9Dsm0l3jGATEXrPeC0hP+G9/40p+SPjeCi8WpxPhNgAAAGQAAAAAAAAAAgAAAAEAAAAAAAAAAAAAAABqndlQAAAAAAAAAAEAAAAAAAAAGAAAAAAAAAABCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkAAAAHZGVwb3NpdAAAAAABAAAACgAAAAAAAAAAAAAAAAC+vCAAAAAAAAAAAAAAAAA="},"properties":{"envelopeXdr":{"type":"string","format":"byte","minLength":1,"maxLength":176128,"description":"A base64 encoded, unsigned Stellar `TransactionEnvelope` carrying exactly one `invokeHostFunction` operation that invokes a contract.\n\nThe API only checks that the value is present. The envelope is decoded and validated after the transaction is created, and a transaction whose envelope fails validation is not signed and ends as `FAILED`. An envelope is rejected if it carries signatures or authorization entries, a memo or a fee-bump wrapper, if its source account is not the Stellar address of the vault account, or if it has no bounded time window.\n\nA Stellar transaction cannot exceed 132096 bytes, about 176128 base64 characters.","example":"AAAAAgAAAADY9Dsm0l3jGATEXrPeC0hP+G9/40p+SPjeCi8WpxPhNgAAAGQAAAAAAAAAAgAAAAEAAAAAAAAAAAAAAABqndlQAAAAAAAAAAEAAAAAAAAAGAAAAAAAAAABCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkAAAAHZGVwb3NpdAAAAAABAAAACgAAAAAAAAAAAAAAAAC+vCAAAAAAAAAAAAAAAAA=","isRequired":true,"uniqueKey":"transactionRequest.extraParameters.sorobanCallData.oneOf.0.envelopeXdr","typeLabel":"string\u003cbyte>"}},"uniqueKey":"transactionRequest.extraParameters.sorobanCallData.oneOf.0","typeLabel":"object"},{"description":"For `SOROBAN_CALL` operations, the Soroban contract invocation to execute. Contains a base64 encoded, unsigned Stellar `TransactionEnvelope` in `envelopeXdr`.","enum":[null],"example":{"envelopeXdr":"AAAAAgAAAADY9Dsm0l3jGATEXrPeC0hP+G9/40p+SPjeCi8WpxPhNgAAAGQAAAAAAAAAAgAAAAEAAAAAAAAAAAAAAABqndlQAAAAAAAAAAEAAAAAAAAAGAAAAAAAAAABCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkAAAAHZGVwb3NpdAAAAAABAAAACgAAAAAAAAAAAAAAAAC+vCAAAAAAAAAAAAAAAAA="},"uniqueKey":"transactionRequest.extraParameters.sorobanCallData.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.sorobanCallData","typeLabel":"object | any"},"inputsSelection":{"oneOf":[{"type":"object","description":"For UTXO based blockchains, selections of inputs for the transaction. The value should be set to the [input selection structure.](https://developers.fireblocks.com/reference/transaction-objects#inputsselection) The inputs can be retrieved from the [Retrieve Unspent Inputs endpoint.](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-unspent-inputs)","additionalProperties":true,"uniqueKey":"transactionRequest.extraParameters.inputsSelection.oneOf.0","typeLabel":"object"},{"description":"For UTXO based blockchains, selections of inputs for the transaction. The value should be set to the [input selection structure.](https://developers.fireblocks.com/reference/transaction-objects#inputsselection) The inputs can be retrieved from the [Retrieve Unspent Inputs endpoint.](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-unspent-inputs)","enum":[null],"uniqueKey":"transactionRequest.extraParameters.inputsSelection.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.inputsSelection","typeLabel":"object | any"},"allowBaseAssetAddress":{"oneOf":[{"type":"boolean","description":"Transfers to unmanaged wallets only. When true, if the destination doesn't have a whitelisted address for the requested asset, we'll use the destination's whitelisted address of the base asset (e.g., use the ETH address for an ERC-20). If the requested asset's whitelisted address exists, it is used.\n**Note:** This is a premium feature that should be enabled in your workspace. Please contact your Customer Success Manager or Fireblocks Support for more information.","uniqueKey":"transactionRequest.extraParameters.allowBaseAssetAddress.oneOf.0","typeLabel":"boolean"},{"description":"Transfers to unmanaged wallets only. When true, if the destination doesn't have a whitelisted address for the requested asset, we'll use the destination's whitelisted address of the base asset (e.g., use the ETH address for an ERC-20). If the requested asset's whitelisted address exists, it is used.\n**Note:** This is a premium feature that should be enabled in your workspace. Please contact your Customer Success Manager or Fireblocks Support for more information.","enum":[null],"uniqueKey":"transactionRequest.extraParameters.allowBaseAssetAddress.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.allowBaseAssetAddress","typeLabel":"boolean | any"},"piiData":{"oneOf":[{"type":"object","description":"For exchange compliance (e.g., Binance) and Travel Rule purposes, contains a custom JSON structure with Personally Identifiable Information (PII) relevant to the transaction. This data must be fully encrypted by the sender before being submitted to the Fireblocks API. The recommended encryption method is hybrid encryption using AES-256-GCM for the payload and RSA-OAEP for key exchange, with the recipient exchange's public key. [Learn more](https://developers.fireblocks.com/docs/a-developers-guide-to-constructing-encrypted-pii-messages-for-binance-via-fireblocks)","additionalProperties":true,"uniqueKey":"transactionRequest.extraParameters.piiData.oneOf.0","typeLabel":"object"},{"description":"For exchange compliance (e.g., Binance) and Travel Rule purposes, contains a custom JSON structure with Personally Identifiable Information (PII) relevant to the transaction. This data must be fully encrypted by the sender before being submitted to the Fireblocks API. The recommended encryption method is hybrid encryption using AES-256-GCM for the payload and RSA-OAEP for key exchange, with the recipient exchange's public key. [Learn more](https://developers.fireblocks.com/docs/a-developers-guide-to-constructing-encrypted-pii-messages-for-binance-via-fireblocks)","enum":[null],"uniqueKey":"transactionRequest.extraParameters.piiData.oneOf.1","typeLabel":"any"}],"uniqueKey":"transactionRequest.extraParameters.piiData","typeLabel":"object | any"}},"uniqueKey":"transactionRequest.extraParameters","typeLabel":"object"},"utxoSelectionParams":{"type":"object","description":"For UTXO-based blockchains only. Controls which UTXOs are used for automatic selection. Cannot be used together with extraParameters.inputsSelection. This feature is currently in beta and might be subject to changes.\n","properties":{"selectionStrategy":{"type":"string","enum":["AMOUNT_ASC","AMOUNT_DESC"],"description":"Optional override for the UTXO selection strategy configured at the vault/tenant level.\n","uniqueKey":"transactionRequest.utxoSelectionParams.selectionStrategy","typeLabel":"enum\u003cstring>"},"filters":{"type":"object","description":"Narrow the UTXO candidate pool. All specified filters are AND-ed together. This feature is currently in beta and might be subject to changes.\n","properties":{"includeAllLabels":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.utxoSelectionParams.filters.includeAllLabels.items.[INDEX]","typeLabel":"string"},"description":"Only include UTXOs that have ALL of these labels.","example":["cold-storage"],"uniqueKey":"transactionRequest.utxoSelectionParams.filters.includeAllLabels","typeLabel":"string[]"},"includeAnyLabels":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.utxoSelectionParams.filters.includeAnyLabels.items.[INDEX]","typeLabel":"string"},"description":"Only include UTXOs that have at least one of these labels.","example":["vip","high-value"],"uniqueKey":"transactionRequest.utxoSelectionParams.filters.includeAnyLabels","typeLabel":"string[]"},"excludeAnyLabels":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.utxoSelectionParams.filters.excludeAnyLabels.items.[INDEX]","typeLabel":"string"},"description":"Exclude UTXOs that have any of these labels.","example":["deprecated"],"uniqueKey":"transactionRequest.utxoSelectionParams.filters.excludeAnyLabels","typeLabel":"string[]"},"address":{"type":"string","description":"Only include UTXOs from this specific address.","example":"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa","uniqueKey":"transactionRequest.utxoSelectionParams.filters.address","typeLabel":"string"},"minAmount":{"type":"string","description":"Minimum UTXO amount in the asset's base unit (e.g., BTC).","example":"0.001","uniqueKey":"transactionRequest.utxoSelectionParams.filters.minAmount","typeLabel":"string"},"maxAmount":{"type":"string","description":"Maximum UTXO amount in the asset's base unit (e.g., BTC).","example":"9.999","uniqueKey":"transactionRequest.utxoSelectionParams.filters.maxAmount","typeLabel":"string"}},"uniqueKey":"transactionRequest.utxoSelectionParams.filters","typeLabel":"object"},"inputSelection":{"type":"object","description":"Explicitly control which UTXOs to include or exclude. This feature is currently in beta and might be subject to changes.\n","properties":{"inputsToSpend":{"type":"array","items":{"type":"object","properties":{"txHash":{"type":"string","example":"b34f0c3ce612f1e5a5c19d6b1e6b5e3e7f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c","isRequired":true,"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToSpend.items.[INDEX].txHash","typeLabel":"string"},"index":{"type":"integer","description":"The output index (vout)","example":0,"isRequired":true,"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToSpend.items.[INDEX].index","typeLabel":"integer"}},"required":["txHash","index"],"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToSpend.items.[INDEX]","typeLabel":"object"},"description":"Force-include specific UTXOs by txHash and index.","uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToSpend","typeLabel":"object[]"},"inputsToExclude":{"type":"array","items":{"type":"object","properties":{"txHash":{"type":"string","example":"b34f0c3ce612f1e5a5c19d6b1e6b5e3e7f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c","isRequired":true,"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToExclude.items.[INDEX].txHash","typeLabel":"string"},"index":{"type":"integer","description":"The output index (vout)","example":0,"isRequired":true,"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToExclude.items.[INDEX].index","typeLabel":"integer"}},"required":["txHash","index"],"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToExclude.items.[INDEX]","typeLabel":"object"},"description":"Exclude specific UTXOs from selection.","uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.inputsToExclude","typeLabel":"object[]"},"fillFeeForSelectedInputs":{"type":"boolean","description":"When true and inputsToSpend is provided, automatically add more UTXOs to cover the transaction fee. Requires inputsToSpend.\n","example":true,"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection.fillFeeForSelectedInputs","typeLabel":"boolean"}},"uniqueKey":"transactionRequest.utxoSelectionParams.inputSelection","typeLabel":"object"}},"uniqueKey":"transactionRequest.utxoSelectionParams","typeLabel":"object"},"customerRefId":{"type":"string","description":"The ID for AML providers to associate the owner of funds with transactions.","example":"abcdef","uniqueKey":"transactionRequest.customerRefId","typeLabel":"string"},"travelRuleMessage":{"type":"object","properties":{"originator":{"type":"object","description":"Personal identifiable information related to the transaction","properties":{"originatorPersons":{"type":"array","description":"Information about the originator of the transaction","items":{"type":"object","properties":{"naturalPerson":{"type":"object","properties":{"name":{"type":"array","items":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX]","typeLabel":"object"},"description":"An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema.","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.name","typeLabel":"object[]"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema.","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification","typeLabel":"object"},"dateAndPlaceOfBirth":{"type":"object","description":"Represents the date and place of birth for a natural person","properties":{"dateOfBirth":{"type":"string","description":"Date of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.dateOfBirth","typeLabel":"string"},"placeOfBirth":{"type":"string","description":"Place of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.placeOfBirth","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier for the customer within the organization's context. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.customerIdentification","typeLabel":"string"},"countryOfResidence":{"type":"string","description":"The ISO-3166 Alpha-2 country code of the natural person's residence. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.countryOfResidence","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson.customerNumber","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].naturalPerson","typeLabel":"object"},"legalPerson":{"type":"object","properties":{"name":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of local name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of phonetic name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.name","typeLabel":"object"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"The array of geographic addresses associated with the legal person.","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.nationalIdentification","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier that identifies the customer in the organization's context. The value must be encrypted.","example":"QmRY9AA4Uit2JRTxDzfzshrJdTK86Kf5HriA3dXDnihDmy","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.customerIdentification","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmXvyML3AJUFpBbJqL5NVp7Vn7xNkuedTsSMk93duLCNW8","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.customerNumber","typeLabel":"string"},"countryOfRegistration":{"type":"string","description":"The ISO-3166 Alpha-2 country code where the legal person is registered. The value must be encrypted.","example":"QmeoTk6UPruEAYNbJEAHdQYc53ap9BXmpnPMcuvs8wutdr","uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson.countryOfRegistration","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX].legalPerson","typeLabel":"object"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.originatorPersons","typeLabel":"object[]"},"beneficiaryPersons":{"type":"array","description":"Information about the beneficiary of the transaction","items":{"type":"object","properties":{"naturalPerson":{"type":"object","properties":{"name":{"type":"array","items":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX]","typeLabel":"object"},"description":"An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema.","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.name","typeLabel":"object[]"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema.","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification","typeLabel":"object"},"dateAndPlaceOfBirth":{"type":"object","description":"Represents the date and place of birth for a natural person","properties":{"dateOfBirth":{"type":"string","description":"Date of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.dateOfBirth","typeLabel":"string"},"placeOfBirth":{"type":"string","description":"Place of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.placeOfBirth","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier for the customer within the organization's context. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.customerIdentification","typeLabel":"string"},"countryOfResidence":{"type":"string","description":"The ISO-3166 Alpha-2 country code of the natural person's residence. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.countryOfResidence","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson.customerNumber","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].naturalPerson","typeLabel":"object"},"legalPerson":{"type":"object","properties":{"name":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of local name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of phonetic name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.name","typeLabel":"object"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"The array of geographic addresses associated with the legal person.","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier that identifies the customer in the organization's context. The value must be encrypted.","example":"QmRY9AA4Uit2JRTxDzfzshrJdTK86Kf5HriA3dXDnihDmy","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.customerIdentification","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmXvyML3AJUFpBbJqL5NVp7Vn7xNkuedTsSMk93duLCNW8","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.customerNumber","typeLabel":"string"},"countryOfRegistration":{"type":"string","description":"The ISO-3166 Alpha-2 country code where the legal person is registered. The value must be encrypted.","example":"QmeoTk6UPruEAYNbJEAHdQYc53ap9BXmpnPMcuvs8wutdr","uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson.countryOfRegistration","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX].legalPerson","typeLabel":"object"}},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.beneficiaryPersons","typeLabel":"object[]"},"accountNumber":{"type":"array","description":"Beneficiary account number. The value must be encrypted.","items":{"type":"string","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.originator.accountNumber.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transactionRequest.travelRuleMessage.originator.accountNumber","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.originator","typeLabel":"object"},"beneficiary":{"type":"object","description":"Personal identifiable information related to the transaction","properties":{"originatorPersons":{"type":"array","description":"Information about the originator of the transaction","items":{"type":"object","properties":{"naturalPerson":{"type":"object","properties":{"name":{"type":"array","items":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name.items.[INDEX]","typeLabel":"object"},"description":"An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.name","typeLabel":"object[]"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.nationalIdentification","typeLabel":"object"},"dateAndPlaceOfBirth":{"type":"object","description":"Represents the date and place of birth for a natural person","properties":{"dateOfBirth":{"type":"string","description":"Date of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.dateOfBirth","typeLabel":"string"},"placeOfBirth":{"type":"string","description":"Place of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.placeOfBirth","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier for the customer within the organization's context. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.customerIdentification","typeLabel":"string"},"countryOfResidence":{"type":"string","description":"The ISO-3166 Alpha-2 country code of the natural person's residence. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.countryOfResidence","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson.customerNumber","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].naturalPerson","typeLabel":"object"},"legalPerson":{"type":"object","properties":{"name":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of local name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of phonetic name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.name","typeLabel":"object"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"The array of geographic addresses associated with the legal person.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.nationalIdentification","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier that identifies the customer in the organization's context. The value must be encrypted.","example":"QmRY9AA4Uit2JRTxDzfzshrJdTK86Kf5HriA3dXDnihDmy","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.customerIdentification","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmXvyML3AJUFpBbJqL5NVp7Vn7xNkuedTsSMk93duLCNW8","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.customerNumber","typeLabel":"string"},"countryOfRegistration":{"type":"string","description":"The ISO-3166 Alpha-2 country code where the legal person is registered. The value must be encrypted.","example":"QmeoTk6UPruEAYNbJEAHdQYc53ap9BXmpnPMcuvs8wutdr","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson.countryOfRegistration","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX].legalPerson","typeLabel":"object"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.originatorPersons","typeLabel":"object[]"},"beneficiaryPersons":{"type":"array","description":"Information about the beneficiary of the transaction","items":{"type":"object","properties":{"naturalPerson":{"type":"object","properties":{"name":{"type":"array","items":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","properties":{"primaryIdentifier":{"type":"string","description":"The primary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary identifier of the name. The value must be encrypted.","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].secondaryIdentifier","typeLabel":"string"},"nameIdentifierType":{"type":"string","description":"The type of the name identifier. The value must be encrypted. The value must be one of the following: [LEGL, DBA, TRAD, NICK, ALIA, MAID, FORM, PREV, BORN, OTHR].","example":"QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX].nameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX].phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name.items.[INDEX]","typeLabel":"object"},"description":"An array of structured name identifiers for the natural person, referencing the TravelRuleNaturalPersonNameIdentifier schema.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.name","typeLabel":"object[]"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"An array of geographic addresses associated with the natural person, referencing the TravelRuleGeographicAddress schema.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.nationalIdentification","typeLabel":"object"},"dateAndPlaceOfBirth":{"type":"object","description":"Represents the date and place of birth for a natural person","properties":{"dateOfBirth":{"type":"string","description":"Date of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.dateOfBirth","typeLabel":"string"},"placeOfBirth":{"type":"string","description":"Place of birth. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth.placeOfBirth","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.dateAndPlaceOfBirth","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier for the customer within the organization's context. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.customerIdentification","typeLabel":"string"},"countryOfResidence":{"type":"string","description":"The ISO-3166 Alpha-2 country code of the natural person's residence. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.countryOfResidence","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson.customerNumber","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].naturalPerson","typeLabel":"object"},"legalPerson":{"type":"object","properties":{"name":{"type":"object","properties":{"nameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.nameIdentifier","typeLabel":"object[]"},"localNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of local name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.localNameIdentifier","typeLabel":"object[]"},"phoneticNameIdentifier":{"type":"array","items":{"type":"object","required":["legalPersonName","legalPersonNameIdentifierType"],"properties":{"legalPersonName":{"type":"string","description":"Name by which the legal person is known. The value must be encrypted.","example":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonName","typeLabel":"string"},"legalPersonNameIdentifierType":{"type":"string","description":"Specifies the type of name for a legal person (IVMS101 LegalPersonNameTypeCode). Acceptable values are: - 'LEGL': Legal name - official name under which the organisation is registered. - 'SHRT': Short name of the organisation. - 'TRAD': Trading name - name used by the business for commercial purposes. The value must be encrypted.","example":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e","isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX].legalPersonNameIdentifierType","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier.items.[INDEX]","typeLabel":"object"},"description":"An array of phonetic name identifiers of the legal person.","example":[{"legalPersonName":"QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q","legalPersonNameIdentifierType":"QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"}],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name.phoneticNameIdentifier","typeLabel":"object[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.name","typeLabel":"object"},"geographicAddress":{"type":"array","items":{"type":"object","properties":{"streetName":{"type":"string","description":"Name of a street or thoroughfare. The value must be encrypted.","example":"QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].streetName","typeLabel":"string"},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government. The value must be encrypted.","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townName","typeLabel":"string"},"country":{"type":"string","description":"Nation with its own government (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].country","typeLabel":"string"},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street. The value must be encrypted.","example":"QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingNumber","typeLabel":"string"},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers added to a postal address to assist the sorting of mail. The value must be encrypted.","example":"QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postCode","typeLabel":"string"},"addressType":{"type":"string","description":"Specifies the type of address. Acceptable values are: - 'HOME': Residential, the home address - 'BIZZ': Business, the business address - 'GEOG': Geographic, an unspecified physical (geographical) address The value must be encrypted.","example":"Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressType","typeLabel":"string"},"department":{"type":"string","description":"Identification of a division of a large organisation or building. The value must be encrypted.","example":"QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].department","typeLabel":"string"},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building. The value must be encrypted.","example":"QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].subDepartment","typeLabel":"string"},"buildingName":{"type":"string","description":"Name of the building or house. The value must be encrypted.","example":"QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].buildingName","typeLabel":"string"},"floor":{"type":"string","description":"Floor or storey within a building. The value must be encrypted.","example":"QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].floor","typeLabel":"string"},"postBox":{"type":"string","description":"Numbered box in a post office. The value must be encrypted.","example":"QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].postBox","typeLabel":"string"},"room":{"type":"string","description":"Building room number. The value must be encrypted.","example":"QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].room","typeLabel":"string"},"townLocationName":{"type":"string","description":"Specific location name within the town. The value must be encrypted.","example":"QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].townLocationName","typeLabel":"string"},"districtName":{"type":"string","description":"Identifies a subdivision within a country subdivision. The value must be encrypted.","example":"QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].districtName","typeLabel":"string"},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, or province. The value must be encrypted.","example":"QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].countrySubDivision","typeLabel":"string"},"addressLine":{"type":"array","items":{"type":"string","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine.items.[INDEX]","typeLabel":"string"},"description":"Information that locates and identifies a specific address, presented in free format text. Each item must be encrypted.","example":["QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"],"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX].addressLine","typeLabel":"string[]"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress.items.[INDEX]","typeLabel":"object"},"description":"The array of geographic addresses associated with the legal person.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.geographicAddress","typeLabel":"object[]"},"nationalIdentification":{"type":"object","description":"Represents a national identifier for a person or entity","properties":{"countryOfIssue":{"type":"string","description":"Country that issued the national identifier (ISO-3166 Alpha-2 country code). The value must be encrypted.","example":"QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.countryOfIssue","typeLabel":"string"},"nationalIdentifier":{"type":"string","description":"National identifier (max 35 characters). The value must be encrypted.","example":"QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifier","typeLabel":"string"},"nationalIdentifierType":{"type":"string","description":"Type of national identifier. Acceptable values include: - 'PASSPORT': Passport number - 'NATIONAL_ID': National identification number - 'TAX_ID': Tax identification number - 'SOCIAL_SECURITY': Social security number The value must be encrypted.","example":"QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.nationalIdentifierType","typeLabel":"string"},"registrationAuthority":{"type":"string","description":"Registration authority (format -> RA followed by 6 digits). The value must be encrypted.","example":"QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification.registrationAuthority","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.nationalIdentification","typeLabel":"object"},"customerIdentification":{"type":"string","description":"A unique identifier that identifies the customer in the organization's context. The value must be encrypted.","example":"QmRY9AA4Uit2JRTxDzfzshrJdTK86Kf5HriA3dXDnihDmy","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.customerIdentification","typeLabel":"string"},"customerNumber":{"type":"string","description":"A distinct identifier that uniquely identifies the customer within the organization. The value must be encrypted.","example":"QmXvyML3AJUFpBbJqL5NVp7Vn7xNkuedTsSMk93duLCNW8","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.customerNumber","typeLabel":"string"},"countryOfRegistration":{"type":"string","description":"The ISO-3166 Alpha-2 country code where the legal person is registered. The value must be encrypted.","example":"QmeoTk6UPruEAYNbJEAHdQYc53ap9BXmpnPMcuvs8wutdr","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson.countryOfRegistration","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX].legalPerson","typeLabel":"object"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.beneficiaryPersons","typeLabel":"object[]"},"accountNumber":{"type":"array","description":"Beneficiary account number. The value must be encrypted.","items":{"type":"string","example":"QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt","uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.accountNumber.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary.accountNumber","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiary","typeLabel":"object"},"originatorVASPdid":{"type":"string","description":"The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange's account is created in the Notabene network.","example":"did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2","uniqueKey":"transactionRequest.travelRuleMessage.originatorVASPdid","typeLabel":"string"},"beneficiaryVASPdid":{"type":"string","description":"The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange's account is created in the Notabene network.","example":"did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryVASPdid","typeLabel":"string"},"originatorVASPname":{"type":"string","description":"The name of the VASP acting as the transaction originator.","example":"Originator VASP Ltd.","uniqueKey":"transactionRequest.travelRuleMessage.originatorVASPname","typeLabel":"string"},"beneficiaryVASPname":{"type":"string","description":"The name of the VASP acting as the transaction beneficiary.","example":"Beneficiary VASP Inc.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryVASPname","typeLabel":"string"},"beneficiaryVASPwebsite":{"type":"string","description":"The website of the VASP acting as the transaction beneficiary.","example":"https://www.beneficiaryvasp.com","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryVASPwebsite","typeLabel":"string"},"transactionBlockchainInfo":{"type":"object","description":"Information about the blockchain transaction.","properties":{"txHash":{"type":"string","description":"The hash of the transaction","example":6.685730843558756e+76,"uniqueKey":"transactionRequest.travelRuleMessage.transactionBlockchainInfo.txHash","typeLabel":"string"},"origin":{"type":"string","description":"The origin address of the transaction","example":8.41132469470587e+47,"uniqueKey":"transactionRequest.travelRuleMessage.transactionBlockchainInfo.origin","typeLabel":"string"},"destination":{"type":"string","description":"The destination address of the transaction","example":8.41132469470587e+47,"uniqueKey":"transactionRequest.travelRuleMessage.transactionBlockchainInfo.destination","typeLabel":"string"}},"uniqueKey":"transactionRequest.travelRuleMessage.transactionBlockchainInfo","typeLabel":"object"},"encrypted":{"type":"string","description":"Encrypted data related to the transaction.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","uniqueKey":"transactionRequest.travelRuleMessage.encrypted","typeLabel":"string"},"protocol":{"type":"string","enum":["IVMS101","TRLight","TRP","OpenVASP","GTR"],"description":"The protocol used to perform the travel rule.","example":"IVMS101","uniqueKey":"transactionRequest.travelRuleMessage.protocol","typeLabel":"enum\u003cstring>"},"targetProtocol":{"type":"string","description":"The target protocol for GTR (Global Travel Rule) transfers.","example":"GTR","uniqueKey":"transactionRequest.travelRuleMessage.targetProtocol","typeLabel":"string"},"skipBeneficiaryDataValidation":{"type":"boolean","description":"Whether to skip validation of beneficiary data.","example":false,"uniqueKey":"transactionRequest.travelRuleMessage.skipBeneficiaryDataValidation","typeLabel":"boolean"},"travelRuleBehavior":{"type":"boolean","description":"Whether to check if the transaction complies with the travel rule in the beneficiary VASP's jurisdiction.","example":true,"uniqueKey":"transactionRequest.travelRuleMessage.travelRuleBehavior","typeLabel":"boolean"},"originatorRef":{"type":"string","description":"A reference ID related to the originator of the transaction.","example":"ORG123456","uniqueKey":"transactionRequest.travelRuleMessage.originatorRef","typeLabel":"string"},"beneficiaryRef":{"type":"string","description":"A reference ID related to the beneficiary of the transaction.","example":"BEN654321","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryRef","typeLabel":"string"},"travelRuleBehaviorRef":{"type":"string","description":"A reference ID related to the travel rule behavior.","example":"TRB987654","uniqueKey":"transactionRequest.travelRuleMessage.travelRuleBehaviorRef","typeLabel":"string"},"originatorProof":{"type":"object","description":"Ownership proof related to the originator of the transaction.","properties":{"type":{"type":"string","description":"The type of ownership proof. Example values: - `eip-191`: Ethereum signature proof - `eip-712`: Ethereum typed data signature proof - `bip-137`: Bitcoin signature proof - `microtransfer`: Microtransaction (Satoshi test) - `screenshot`: Uploaded screenshot of the wallet - `self-declaration`: Checkbox attestation of ownership","example":"eip-191","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.type","typeLabel":"string"},"proof":{"type":"string","description":"The cryptographic signature, transaction hash, or other proof depending on the type. Examples: - For `eip-191`: `0x3dd4a17a...ce4a2bcd1b` - For `microtransfer`: The transaction hash `H3V8GXBy39Dz...tr3TSTkY=`","example":"0x3dd4a17a...ce4a2bcd1b","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.proof","typeLabel":"string"},"attestation":{"type":"string","description":"A human-readable statement of wallet ownership. Required for signature proofs and self-declarations. Examples: - `I certify that ETH account 0x896B...0b9b belongs to me.` - `I hereby declare that the blockchain address 0xa437bEed902AF9338B7DEB23848e195d85019510 is under my control.`","example":"I certify that ETH account 0x896B...0b9b belongs to me.","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.attestation","typeLabel":"string"},"address":{"type":"string","description":"The wallet address being verified. Examples: - For Ethereum: `0x896B...0b9b` - For Bitcoin: `1442...dxhsQ`","example":"0x896B...0b9b","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.address","typeLabel":"string"},"wallet_provider":{"type":"string","description":"The wallet provider or method used for verification. Examples: - For Metamask: `Metamask` - For manual signature: `manual`","example":"Metamask","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.wallet_provider","typeLabel":"string"},"url":{"type":"string","description":"The URL for the uploaded screenshot (for `screenshot` proof types only). Example: `https://example.com/uploaded_image.png`","example":"https://example.com/uploaded_image.png","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.url","typeLabel":"string"},"did":{"type":"string","description":"The Decentralized Identifier (DID) associated with the ownership proof.","example":"did:key:z6Mkf12345Zabcdef12345","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.did","typeLabel":"string"},"status":{"type":"string","description":"The status of the ownership proof verification.","example":"verified","uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.status","typeLabel":"string"},"confirmed":{"type":"boolean","description":"Whether the user confirmed ownership of the wallet (for `self-declaration` proofs). Example: `true`","example":true,"uniqueKey":"transactionRequest.travelRuleMessage.originatorProof.confirmed","typeLabel":"boolean"}},"uniqueKey":"transactionRequest.travelRuleMessage.originatorProof","typeLabel":"object"},"beneficiaryProof":{"type":"object","description":"Ownership proof related to the originator of the transaction.","properties":{"type":{"type":"string","description":"The type of ownership proof. Example values: - `eip-191`: Ethereum signature proof - `eip-712`: Ethereum typed data signature proof - `bip-137`: Bitcoin signature proof - `microtransfer`: Microtransaction (Satoshi test) - `screenshot`: Uploaded screenshot of the wallet - `self-declaration`: Checkbox attestation of ownership","example":"eip-191","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.type","typeLabel":"string"},"proof":{"type":"string","description":"The cryptographic signature, transaction hash, or other proof depending on the type. Examples: - For `eip-191`: `0x3dd4a17a...ce4a2bcd1b` - For `microtransfer`: The transaction hash `H3V8GXBy39Dz...tr3TSTkY=`","example":"0x3dd4a17a...ce4a2bcd1b","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.proof","typeLabel":"string"},"attestation":{"type":"string","description":"A human-readable statement of wallet ownership. Required for signature proofs and self-declarations. Examples: - `I certify that ETH account 0x896B...0b9b belongs to me.` - `I hereby declare that the blockchain address 0xa437bEed902AF9338B7DEB23848e195d85019510 is under my control.`","example":"I certify that ETH account 0x896B...0b9b belongs to me.","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.attestation","typeLabel":"string"},"address":{"type":"string","description":"The wallet address being verified. Examples: - For Ethereum: `0x896B...0b9b` - For Bitcoin: `1442...dxhsQ`","example":"0x896B...0b9b","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.address","typeLabel":"string"},"wallet_provider":{"type":"string","description":"The wallet provider or method used for verification. Examples: - For Metamask: `Metamask` - For manual signature: `manual`","example":"Metamask","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.wallet_provider","typeLabel":"string"},"url":{"type":"string","description":"The URL for the uploaded screenshot (for `screenshot` proof types only). Example: `https://example.com/uploaded_image.png`","example":"https://example.com/uploaded_image.png","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.url","typeLabel":"string"},"did":{"type":"string","description":"The Decentralized Identifier (DID) associated with the ownership proof.","example":"did:key:z6Mkf12345Zabcdef12345","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.did","typeLabel":"string"},"status":{"type":"string","description":"The status of the ownership proof verification.","example":"verified","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.status","typeLabel":"string"},"confirmed":{"type":"boolean","description":"Whether the user confirmed ownership of the wallet (for `self-declaration` proofs). Example: `true`","example":true,"uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof.confirmed","typeLabel":"boolean"}},"uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryProof","typeLabel":"object"},"beneficiaryDid":{"type":"string","description":"The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the `beneficiaryRef`. - If neither `beneficiaryRef` nor `beneficiaryDid` is provided in the `txCreate` payload, \n a new random DID is generated for every transaction.","example":"did:key:z6Mkf67890Zghijkl67890","uniqueKey":"transactionRequest.travelRuleMessage.beneficiaryDid","typeLabel":"string"},"originatorDid":{"type":"string","description":"The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the `originatorRef`. - If neither `originatorRef` nor `originatorDid` is provided in the `txCreate` payload, \n a new random DID is generated for every transaction.","example":"did:key:z6Mkf12345Zabcdef12345","uniqueKey":"transactionRequest.travelRuleMessage.originatorDid","typeLabel":"string"},"isNonCustodial":{"type":"boolean","description":"Indicates if the transaction involves a non-custodial wallet.","example":true,"uniqueKey":"transactionRequest.travelRuleMessage.isNonCustodial","typeLabel":"boolean"}},"required":["originator","beneficiary"],"uniqueKey":"transactionRequest.travelRuleMessage","typeLabel":"object"},"travelRuleMessageId":{"type":"string","description":"The ID of the travel rule message from any travel rule provider. Used for travel rule supporting functionality to associate transactions with existing travel rule messages.","example":"trm_12345678-1234-1234-1234-123456789012","uniqueKey":"transactionRequest.travelRuleMessageId","typeLabel":"string"},"autoStaking":{"type":"boolean","description":"This feature is no longer supported.","deprecated":true,"uniqueKey":"transactionRequest.autoStaking","typeLabel":"boolean"},"networkStaking":{"oneOf":[{"type":"string","description":"This feature is no longer supported.","deprecated":true,"uniqueKey":"transactionRequest.networkStaking.oneOf.0","typeLabel":"string"},{"type":"number","description":"This feature is no longer supported.","deprecated":true,"uniqueKey":"transactionRequest.networkStaking.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.networkStaking","typeLabel":"string | number"},"cpuStaking":{"oneOf":[{"type":"string","description":"This feature is no longer supported.","deprecated":true,"uniqueKey":"transactionRequest.cpuStaking.oneOf.0","typeLabel":"string"},{"type":"number","description":"This feature is no longer supported.","deprecated":true,"uniqueKey":"transactionRequest.cpuStaking.oneOf.1","typeLabel":"number"}],"uniqueKey":"transactionRequest.cpuStaking","typeLabel":"string | number"},"useGasless":{"type":"boolean","description":"- Override the default gasless configuration by sending true\\false","uniqueKey":"transactionRequest.useGasless","typeLabel":"boolean"},"configurations":{"type":"object","properties":{"expiresAfterSeconds":{"type":"number","description":"The number of seconds the transaction is valid for before it expires. After the specified duration, the transaction will expire if it has not been broadcasted.","minimum":300,"maximum":86400,"example":3600,"uniqueKey":"transactionRequest.configurations.expiresAfterSeconds","typeLabel":"number"}},"uniqueKey":"transactionRequest.configurations","typeLabel":"object"}},"uniqueKey":"transactionRequest","typeLabel":"object"},"isDstCollateral":{"type":"boolean","description":"optional","uniqueKey":"isDstCollateral","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"transactionRequest":{"operation":"TRANSFER","note":"Ticket 123","externalTxId":"00000000-0000-0000-0000-000000000000","feeCurrency":"PATHUSD_TEMPO_54V8","assetId":"ETH","destinations":[{"amount":"\u003cstring>","travelRuleMessageId":"trm_12345678-1234-1234-1234-123456789012","customerRefId":"abcdef"}],"amount":"0.02","treatAsGrossAmount":false,"forceSweep":false,"feeLevel":"MEDIUM","fee":"\u003cstring>","priorityFee":"2","failOnLowFee":true,"maxFee":"120","maxTotalFee":"88","gasLimit":"21000","gasPrice":"\u003cstring>","networkFee":"\u003cstring>","replaceTxByHash":"00000000-0000-0000-0000-000000000000","extraParameters":{"nodeControls":{},"rawMessageData":{},"contractCallData":"\u003cstring>","programCallData":"\u003cstring>","sorobanCallData":{"envelopeXdr":"AAAAAgAAAADY9Dsm0l3jGATEXrPeC0hP+G9/40p+SPjeCi8WpxPhNgAAAGQAAAAAAAAAAgAAAAEAAAAAAAAAAAAAAABqndlQAAAAAAAAAAEAAAAAAAAAGAAAAAAAAAABCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkAAAAHZGVwb3NpdAAAAAABAAAACgAAAAAAAAAAAAAAAAC+vCAAAAAAAAAAAAAAAAA="},"inputsSelection":{},"allowBaseAssetAddress":true,"piiData":{}},"utxoSelectionParams":{"filters":{"includeAllLabels":["cold-storage"],"includeAnyLabels":["vip","high-value"],"excludeAnyLabels":["deprecated"],"address":"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa","minAmount":"0.001","maxAmount":"9.999"},"inputSelection":{"inputsToSpend":[{"txHash":"b34f0c3ce612f1e5a5c19d6b1e6b5e3e7f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c","index":0}],"inputsToExclude":[{"txHash":"b34f0c3ce612f1e5a5c19d6b1e6b5e3e7f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c","index":0}],"fillFeeForSelectedInputs":true}},"customerRefId":"abcdef","travelRuleMessageId":"trm_12345678-1234-1234-1234-123456789012","autoStaking":true,"networkStaking":"\u003cstring>","cpuStaking":"\u003cstring>","useGasless":true,"configurations":{"expiresAfterSeconds":3600}},"isDstCollateral":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b737208d-efa6-467d-bcac-e63e3778e567":{"description":"A transaction object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the transaction.","uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","description":"The primary status of the transaction. For details, see [Primary transaction statuses.] (https://developers.fireblocks.com/reference/primary-transaction-statuses)","uniqueKey":"status","typeLabel":"string"},"systemMessages":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WARN","BLOCK"],"uniqueKey":"systemMessages.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A response from Fireblocks that communicates a message about the health of the process being performed. If this object is returned with data, you should expect potential delays or incomplete transaction statuses.","example":"Slow transaction processing. Outgoing transactions might be stuck.","uniqueKey":"systemMessages.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"systemMessages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"systemMessages","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"\u003cstring>","systemMessages":[{"type":"WARN","message":"Slow transaction processing. Outgoing transactions might be stuck."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f7f3b9ac-17bc-4eb5-a9b2-43aca262e900":{"description":"Error Response","headers":{"X-Request-ID":{"schema":{"type":"string"},"description":"Unique ID correlated to the API request. Please provide it in any support ticket you create or on Github issues related to Fireblocks SDKs"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"number","uniqueKey":"code","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":123}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"faba5ef0-79cc-44c8-83a9-99abf6131993":{"url":"https://api.fireblocks.io/v1","description":"Fireblocks Production Environment Base URL"},"4a950989-e32e-4fab-b303-8cd91145921d":{"url":"https://sandbox-api.fireblocks.io/v1","description":"Fireblocks Sandbox Environment Base URL"}}},"originalFileLocation":"https://swagger.fireblocks.com/openapi.yaml"},"subdomain":"fireblocks-43c4b3ee","siteName":"Fireblocks Developer Docs","title":"Remove Collateral - Fireblocks Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T15:04:12.215Z","originalFileLocation":"api-reference/off-exchanges/remove-collateral.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following guide. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fireblocks Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Remove Collateral - Fireblocks Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following guide. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fireblocks Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fireblocks-43c4b3ee.mintlify.app/_mintlify/api/og/v2?division=Off+exchanges\u0026amp;title=Remove+Collateral\u0026amp;description=Remove+collateral%2C+create+withdraw+request.%0ALearn+more+about+Fireblocks+Off+Exchange+in+the+following+%5Bguide%5D%28https%3A%2F%2Fdevelopers.fireblocks.com%2Fdocs%2Foff-exchang\u0026amp;theme=d93ff4f62f14635b5a1559e2\u0026amp;signature=d5e96cf31a96e33ce2be8147cf5b6c713de8631718afc07f1451790e3dc703f9\">\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=\"Remove Collateral - Fireblocks Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following guide. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fireblocks-43c4b3ee.mintlify.app/_mintlify/api/og/v2?division=Off+exchanges\u0026amp;title=Remove+Collateral\u0026amp;description=Remove+collateral%2C+create+withdraw+request.%0ALearn+more+about+Fireblocks+Off+Exchange+in+the+following+%5Bguide%5D%28https%3A%2F%2Fdevelopers.fireblocks.com%2Fdocs%2Foff-exchang\u0026amp;theme=d93ff4f62f14635b5a1559e2\u0026amp;signature=d5e96cf31a96e33ce2be8147cf5b6c713de8631718afc07f1451790e3dc703f9\">\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/fireblocks-43c4b3ee/mewVW9F9TG280EVD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fireblocks Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0052ec\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/off-exchanges/remove-collateral.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.fireblocks.com/#organization\",\"name\":\"Fireblocks Developer Docs\",\"url\":\"https://developers.fireblocks.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fireblocks-43c4b3ee/8uV7V_rBjqF0ZDAg/images/fb-devs.svg?fit=max\u0026auto=format\u0026n=8uV7V_rBjqF0ZDAg\u0026q=85\u0026s=1e870435fece62854968ac125be4db2c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.fireblocks.com#website\",\"name\":\"Fireblocks Developer Docs\",\"url\":\"https://developers.fireblocks.com\",\"publisher\":{\"@id\":\"https://developers.fireblocks.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral#webpage\",\"url\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral\",\"name\":\"Remove Collateral\",\"description\":\"Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following guide. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.\",\"dateModified\":\"2026-10-30T15:04:12.215Z\",\"isPartOf\":{\"@id\":\"https://developers.fireblocks.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://developers.fireblocks.com/reference/api-endpoints-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Off exchanges\",\"item\":\"https://developers.fireblocks.com/api-reference/off-exchanges/add-collateral\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Remove Collateral\",\"item\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral#apireference\",\"headline\":\"Remove Collateral\",\"name\":\"Remove Collateral\",\"description\":\"Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following guide. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.\",\"url\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral\",\"mainEntityOfPage\":{\"@id\":\"https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral#webpage\"},\"dateModified\":\"2026-10-30T15:04:12.215Z\",\"publisher\":{\"@id\":\"https://developers.fireblocks.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.fireblocks.com#website\"}}]}\u003c/script>","siteName":"Fireblocks Developer Docs","nav":{"global":null,"tabs":[{"tab":"Home","hidden":true,"searchable":true,"pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/introduction"}]},{"tab":"SDKs \u0026 Tools","pages":[{"title":"SDKs \u0026 Tools","href":"/reference/typescript-sdk"}]},{"tab":"API","groups":[{"group":"Introduction","pages":[{"title":"API Overview","href":"/reference/api-overview"},{"title":"Authenticate","href":"/reference/signing-a-request-jwt-structure"},{"title":"API Idempotency","href":"/reference/api-idempotency"},{"title":"Rate Limiting","href":"/reference/rate-limiting"},{"title":"Transaction Sources \u0026 Destinations","href":"/reference/transaction-sources-destinations"},{"title":"Postman Guide","href":"/reference/explore-postman-collection"}]},{"group":"Errors \u0026 Statuses","pages":[{"title":"API responses and error codes","href":"/reference/api-error-codes"},{"title":"Handle API Errors","href":"/reference/handling-api-errors"},{"group":"Embedded Wallet Errors","pages":[{"title":"Common errors","href":"/reference/common-errors"},{"title":"EW API errors","href":"/reference/ew-api-errors"},{"title":"Android SDK errors","href":"/reference/android-sdk-errors"},{"title":"iOS SDK errors","href":"/reference/ios-sdk-errors"},{"title":"JavaScript SDK errors","href":"/reference/javascript-sdk-errors"}]},{"group":"Transaction Statuses","pages":[{"title":"Statuses","href":"/reference/statuses"},{"title":"Sub-Statuses","href":"/reference/sub-statuses"}]}]},{"group":"Data Objects","pages":[{"title":"Data Objects","href":"/reference/data-objects"},{"title":"Audit Log Events","href":"/reference/audit-log-events"},{"title":"Vault Objects","href":"/reference/vault-objects"},{"title":"Exchange Account Objects","href":"/reference/exchange-objects"},{"title":"Fiat Account Objects","href":"/reference/fiat-account-objects"},{"title":"Network Connection Objects","href":"/reference/network-objects"},{"title":"Internal/External Wallet Objects","href":"/reference/internalexternal-wallet-objects"},{"title":"Contract Objects","href":"/reference/contract-objects"},{"title":"Blockchain \u0026 Asset Objects","href":"/reference/supported-assets-object"},{"title":"Transaction Objects","href":"/reference/transaction-objects"},{"title":"Transaction Authorization Objects","href":"/reference/transaction-authorization-objects"},{"title":"Fee Estimation Objects","href":"/reference/fee-estimation-objects"},{"title":"Transaction Screening Objects","href":"/reference/transaction-screening-objects"},{"title":"Raw Signing Objects","href":"/reference/raw-signing-objects"},{"title":"Payments Objects","href":"/reference/payments-objects"},{"title":"Gas Station Objects","href":"/reference/gas-station-objects"},{"title":"User Object","href":"/reference/user-object"},{"title":"Webhook Object","href":"/reference/webhook-object"},{"title":"NFT Objects","href":"/reference/nft-objects"},{"title":"Web3 Connection Objects","href":"/reference/web3-connection-objects"},{"title":"General Objects","href":"/reference/general-objects"}]},{"group":"API Endpoints","pages":[{"title":"API Endpoints Overview","sidebarTitle":"Overview","href":"/reference/api-endpoints-overview"},{"group":"Admin Quorum","pages":[{"title":"Update admin quorum threshold","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /admin_quorum","href":"/api-reference/admin-quorum/update-admin-quorum-threshold"}]},{"group":"Api User","pages":[{"title":"Get API Keys","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/api_users","href":"/api-reference/api-user/get-api-keys"},{"title":"Create API Key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /management/api_users","href":"/api-reference/api-user/create-api-key"},{"title":"Issue API user pairing token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /management/api_users/{userId}/pairing_token","href":"/api-reference/api-user/issue-api-user-pairing-token"}]},{"group":"Approvals (Beta)","pages":[{"title":"List approval requests","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /approvals","href":"/api-reference/approvals-beta/list-approval-requests"},{"title":"Get a single approval request","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /approvals/{requestId}","href":"/api-reference/approvals-beta/get-a-single-approval-request"},{"title":"Approve an approval request","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /approvals/{requestId}/approve","href":"/api-reference/approvals-beta/approve-an-approval-request"},{"title":"Reject an approval request","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /approvals/{requestId}/reject","href":"/api-reference/approvals-beta/reject-an-approval-request"},{"title":"List approval keys","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/api_users/{userId}/approval_keys","href":"/api-reference/approvals-beta/list-approval-keys"},{"title":"Register an approval key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /management/api_users/{userId}/approval_keys","href":"/api-reference/approvals-beta/register-an-approval-key"},{"title":"Delete an approval key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /management/api_users/{userId}/approval_keys/{keyId}","href":"/api-reference/approvals-beta/delete-an-approval-key"}]},{"group":"Audit Logs","pages":[{"title":"Get audit logs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/audit_logs","href":"/api-reference/audit-logs/get-audit-logs"}]},{"group":"Blockchain link (Beta)","pages":[{"title":"List blockchains with pagination and filtering","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /blockchain_link/blockchains","href":"/api-reference/blockchain-link-beta/list-blockchains-with-pagination-and-filtering"},{"title":"Create a new blockchain","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /blockchain_link/blockchains","href":"/api-reference/blockchain-link-beta/create-a-new-blockchain"},{"title":"Get a blockchain by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /blockchain_link/blockchains/{blockchainId}","href":"/api-reference/blockchain-link-beta/get-a-blockchain-by-id"},{"title":"Update a blockchain","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /blockchain_link/blockchains/{blockchainId}","href":"/api-reference/blockchain-link-beta/update-a-blockchain"},{"title":"Delete a blockchain","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /blockchain_link/blockchains/{blockchainId}","href":"/api-reference/blockchain-link-beta/delete-a-blockchain"},{"title":"Activate a blockchain (triggers activation workflow)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /blockchain_link/blockchains/{blockchainId}/activate","href":"/api-reference/blockchain-link-beta/activate-a-blockchain-triggers-activation-workflow"},{"title":"Trigger validation workflow","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /blockchain_link/blockchains/{blockchainId}/validate","href":"/api-reference/blockchain-link-beta/trigger-validation-workflow"},{"title":"Get tenant billing info","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /blockchain_link/blockchains/billing_info","href":"/api-reference/blockchain-link-beta/get-tenant-billing-info"},{"title":"Get the test wallet address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /blockchain_link/blockchains/test_wallet_address","href":"/api-reference/blockchain-link-beta/get-the-test-wallet-address"}]},{"group":"Blockchains \u0026 assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /assets","href":"/api-reference/blockchains-\u0026-assets/list-assets"},{"title":"Register an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /assets","href":"/api-reference/blockchains-\u0026-assets/register-an-asset"},{"title":"Get an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /assets/{id}","href":"/api-reference/blockchains-\u0026-assets/get-an-asset"},{"title":"Update the user’s metadata for an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /assets/{id}","href":"/api-reference/blockchains-\u0026-assets/update-the-user’s-metadata-for-an-asset"},{"title":"Set asset price","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /assets/prices/{id}","href":"/api-reference/blockchains-\u0026-assets/set-asset-price"},{"title":"List blockchains","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /blockchains","href":"/api-reference/blockchains-\u0026-assets/list-blockchains"},{"title":"Get a Blockchain by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /blockchains/{id}","href":"/api-reference/blockchains-\u0026-assets/get-a-blockchain-by-id"},{"title":"List assets (Legacy)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /supported_assets","href":"/api-reference/blockchains-\u0026-assets/list-assets-legacy"}]},{"group":"Canton (Beta)","pages":[{"title":"Make a Canton call","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /operations/canton/calls","href":"/api-reference/canton-beta/make-a-canton-call"},{"title":"Answer an offer","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /operations/canton/offers/{offerId}/responses","href":"/api-reference/canton-beta/answer-an-offer"}]},{"group":"Compliance","pages":[{"title":"Get your customer's address registry default","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /address_registry/customer","href":"/api-reference/compliance/get-your-customers-address-registry-default"},{"title":"Opt your customer in to the address registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /address_registry/customer","href":"/api-reference/compliance/opt-your-customer-in-to-the-address-registry"},{"title":"Opt your customer out of the address registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /address_registry/customer","href":"/api-reference/compliance/opt-your-customer-out-of-the-address-registry"},{"title":"Look up legal entity by blockchain address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /address_registry/legal_entities/{address}","href":"/api-reference/compliance/look-up-legal-entity-by-blockchain-address"},{"title":"Create a Proof of Ownership PDF for an address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /address_registry/proof_of_ownership_exports","href":"/api-reference/compliance/create-a-proof-of-ownership-pdf-for-an-address"},{"title":"Verify a Proof of Ownership export","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /address_registry/proof_of_ownership_exports/verify","href":"/api-reference/compliance/verify-a-proof-of-ownership-export"},{"title":"Get address registry status for this workspace","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /address_registry/tenant","href":"/api-reference/compliance/get-address-registry-status-for-this-workspace"},{"title":"Opt this workspace in to the address registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /address_registry/tenant","href":"/api-reference/compliance/opt-this-workspace-in-to-the-address-registry"},{"title":"Opt this workspace out of the address registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /address_registry/tenant","href":"/api-reference/compliance/opt-this-workspace-out-of-the-address-registry"},{"title":"List vault-level address registry opt-outs (paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /address_registry/vaults","href":"/api-reference/compliance/list-vault-level-address-registry-opt-outs-paginated"},{"title":"Add vault accounts to the address registry opt-out list","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /address_registry/vaults","href":"/api-reference/compliance/add-vault-accounts-to-the-address-registry-opt-out-list"},{"title":"Remove all vault-level address registry opt-outs for the workspace","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /address_registry/vaults","href":"/api-reference/compliance/remove-all-vault-level-address-registry-opt-outs-for-the-workspace"},{"title":"Get whether a vault account is opted out of the address registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /address_registry/vaults/{vaultAccountId}","href":"/api-reference/compliance/get-whether-a-vault-account-is-opted-out-of-the-address-registry"},{"title":"Remove a single vault account from the address registry opt-out list","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /address_registry/vaults/{vaultAccountId}","href":"/api-reference/compliance/remove-a-single-vault-account-from-the-address-registry-opt-out-list"},{"title":"List counterparty groups","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /counterparty_groups","href":"/api-reference/compliance/list-counterparty-groups"},{"title":"Create a counterparty group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /counterparty_groups","href":"/api-reference/compliance/create-a-counterparty-group"},{"title":"Get a counterparty group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /counterparty_groups/{groupId}","href":"/api-reference/compliance/get-a-counterparty-group"},{"title":"Delete a counterparty group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /counterparty_groups/{groupId}","href":"/api-reference/compliance/delete-a-counterparty-group"},{"title":"Update a counterparty group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /counterparty_groups/{groupId}","href":"/api-reference/compliance/update-a-counterparty-group"},{"title":"List legal entities (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /legal_entities","href":"/api-reference/compliance/list-legal-entities-paginated"},{"title":"Register a new legal entity","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /legal_entities","href":"/api-reference/compliance/register-a-new-legal-entity"},{"title":"Get a legal entity","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /legal_entities/{legalEntityId}","href":"/api-reference/compliance/get-a-legal-entity"},{"title":"Update legal entity","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /legal_entities/{legalEntityId}","href":"/api-reference/compliance/update-legal-entity"},{"title":"Delete a legal entity","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /legal_entities/{legalEntityId}","href":"/api-reference/compliance/delete-a-legal-entity"},{"title":"List vault accounts for a legal entity (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /legal_entities/{legalEntityId}/vaults","href":"/api-reference/compliance/list-vault-accounts-for-a-legal-entity-paginated"},{"title":"Assign vault accounts to a legal entity","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /legal_entities/{legalEntityId}/vaults","href":"/api-reference/compliance/assign-vault-accounts-to-a-legal-entity"},{"title":"Update AML Configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/aml/policy_configuration","href":"/api-reference/compliance/update-aml-configuration"},{"title":"AML - View Post-Screening Policy","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/aml/post_screening_policy","href":"/api-reference/compliance/aml--view-post-screening-policy"},{"title":"AML - View Screening Policy","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/aml/screening_policy","href":"/api-reference/compliance/aml--view-screening-policy"},{"title":"Set AML Verdict (BYORK Super Light)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/aml/verdict/manual","href":"/api-reference/compliance/set-aml-verdict-byork-super-light"},{"title":"Activate ARS (Address Registry Screening)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/ars/config/activate","href":"/api-reference/compliance/activate-ars-address-registry-screening"},{"title":"Deactivate ARS (Address Registry Screening)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/ars/config/deactivate","href":"/api-reference/compliance/deactivate-ars-address-registry-screening"},{"title":"Get BYORK Light configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/byork/config","href":"/api-reference/compliance/get-byork-light-configuration"},{"title":"Activate BYORK Light","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/byork/config/activate","href":"/api-reference/compliance/activate-byork-light"},{"title":"Deactivate BYORK Light","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/byork/config/deactivate","href":"/api-reference/compliance/deactivate-byork-light"},{"title":"Set BYORK Light timeouts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/byork/config/timeouts","href":"/api-reference/compliance/set-byork-light-timeouts"},{"title":"Get BYORK Light verdict","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/byork/verdict","href":"/api-reference/compliance/get-byork-light-verdict"},{"title":"Set BYORK Light verdict","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/byork/verdict","href":"/api-reference/compliance/set-byork-light-verdict"},{"title":"Tenant - Screening Configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/configurations","href":"/api-reference/compliance/tenant--screening-configuration"},{"title":"Provides all the compliance details for the given screened transaction.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/transaction/{txId}","href":"/api-reference/compliance/provides-all-the-compliance-details-for-the-given-screened-transaction"},{"title":"Bypass Screening Policy","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/transaction/{txId}/bypass_screening_policy","href":"/api-reference/compliance/bypass-screening-policy"},{"title":"Rescreen a rejected transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/transaction/{txId}/rescreen","href":"/api-reference/compliance/rescreen-a-rejected-transaction"},{"title":"Update Travel Rule Configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/travel_rule/policy_configuration","href":"/api-reference/compliance/update-travel-rule-configuration"},{"title":"Travel Rule - View Post-Screening Policy","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/post_screening_policy","href":"/api-reference/compliance/travel-rule--view-post-screening-policy"},{"title":"Travel Rule - View Screening Policy","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/screening_policy","href":"/api-reference/compliance/travel-rule--view-screening-policy"}]},{"group":"Compliance Screening Configuration","pages":[{"title":"Get AML Screening Policy Configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/aml/policy_configuration","href":"/api-reference/compliance-screening-configuration/get-aml-screening-policy-configuration"},{"title":"Get Travel Rule Screening Policy Configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/policy_configuration","href":"/api-reference/compliance-screening-configuration/get-travel-rule-screening-policy-configuration"}]},{"group":"Compliance Orchestrator (Beta)","pages":[{"title":"Trigger a Compliance Orchestrator screening","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /compliance/orchestrator/screenings","href":"/api-reference/compliance-orchestrator-beta/trigger-a-compliance-orchestrator-screening"},{"title":"Get a Compliance Orchestrator screening's result","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /compliance/orchestrator/screenings/{screeningId}","href":"/api-reference/compliance-orchestrator-beta/get-a-compliance-orchestrator-screenings-result"},{"title":"Get a Compliance Orchestrator workflow","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /compliance/orchestrator/workflows/{workflowId}","href":"/api-reference/compliance-orchestrator-beta/get-a-compliance-orchestrator-workflow"},{"title":"Update a Compliance Orchestrator workflow's status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /compliance/orchestrator/workflows/{workflowId}/status","href":"/api-reference/compliance-orchestrator-beta/update-a-compliance-orchestrator-workflows-status"}]},{"group":"Connected Accounts","pages":[{"title":"Get connected accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts","href":"/api-reference/connected-accounts/get-connected-accounts"},{"title":"Add a connected account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /connected_accounts","href":"/api-reference/connected-accounts/add-a-connected-account"},{"title":"Get connected account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/{accountId}","href":"/api-reference/connected-accounts/get-connected-account"},{"title":"Disconnect connected account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /connected_accounts/{accountId}","href":"/api-reference/connected-accounts/disconnect-connected-account"},{"title":"Get allowlist for connected account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/{accountId}/allowlist","href":"/api-reference/connected-accounts/get-allowlist-for-connected-account"},{"title":"Get a single allowlist entry for a connected account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/{accountId}/allowlist/{allowlistId}","href":"/api-reference/connected-accounts/get-a-single-allowlist-entry-for-a-connected-account"},{"title":"Sync allowlist for connected account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /connected_accounts/{accountId}/allowlist/sync","href":"/api-reference/connected-accounts/sync-allowlist-for-connected-account"},{"title":"Get balances for an account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/{accountId}/balances","href":"/api-reference/connected-accounts/get-balances-for-an-account"},{"title":"Update connected account credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /connected_accounts/{accountId}/credentials","href":"/api-reference/connected-accounts/update-connected-account-credentials"},{"title":"Get supported trading pairs for an account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/{accountId}/manifest/capabilities/trading/pairs","href":"/api-reference/connected-accounts/get-supported-trading-pairs-for-an-account"},{"title":"Get exchange rates for an account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/{accountId}/rates","href":"/api-reference/connected-accounts/get-exchange-rates-for-an-account"},{"title":"Rename Connected Account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /connected_accounts/{accountId}/rename","href":"/api-reference/connected-accounts/rename-connected-account"},{"title":"Get public key to encrypt connected account credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connected_accounts/credentials/public_key","href":"/api-reference/connected-accounts/get-public-key-to-encrypt-connected-account-credentials"}]},{"group":"Console User","pages":[{"title":"Get console users","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/users","href":"/api-reference/console-user/get-console-users"},{"title":"Create console user","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /management/users","href":"/api-reference/console-user/create-console-user"},{"title":"Request deletion of a console user","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /management/users/{id}","href":"/api-reference/console-user/request-deletion-of-a-console-user"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contacts","href":"/api-reference/contacts/list-contacts"}]},{"group":"Contract Interactions","pages":[{"title":"Decode a function call data, error, or event log","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decode","href":"/api-reference/contract-interactions/decode-a-function-call-data-error-or-event-log"},{"title":"Return deployed contract's ABI","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions","href":"/api-reference/contract-interactions/return-deployed-contracts-abi"},{"title":"Call a read function on a deployed contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read","href":"/api-reference/contract-interactions/call-a-read-function-on-a-deployed-contract"},{"title":"Call a write function on a deployed contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/write","href":"/api-reference/contract-interactions/call-a-write-function-on-a-deployed-contract"},{"title":"Get contract address by transaction hash","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}","href":"/api-reference/contract-interactions/get-contract-address-by-transaction-hash"},{"title":"Get transaction receipt","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt","href":"/api-reference/contract-interactions/get-transaction-receipt"}]},{"group":"Contract Templates","pages":[{"title":"List all contract templates","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/templates","href":"/api-reference/contract-templates/list-all-contract-templates"},{"title":"Upload contract template","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/templates","href":"/api-reference/contract-templates/upload-contract-template"},{"title":"Return contract template by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/templates/{contractTemplateId}","href":"/api-reference/contract-templates/return-contract-template-by-id"},{"title":"Delete a contract template by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /tokenization/templates/{contractTemplateId}","href":"/api-reference/contract-templates/delete-a-contract-template-by-id"},{"title":"Return contract template's constructor","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/templates/{contractTemplateId}/constructor","href":"/api-reference/contract-templates/return-contract-templates-constructor"},{"title":"Deploy contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/templates/{contractTemplateId}/deploy","href":"/api-reference/contract-templates/deploy-contract"},{"title":"Return contract template's function","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/templates/{contractTemplateId}/function","href":"/api-reference/contract-templates/return-contract-templates-function"},{"title":"Get supported blockchains for the template","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/templates/{contractTemplateId}/supported_blockchains","href":"/api-reference/contract-templates/get-supported-blockchains-for-the-template"}]},{"group":"Contracts","pages":[{"title":"List Whitelisted Contracts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contracts","href":"/api-reference/contracts/list-whitelisted-contracts"},{"title":"Add a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /contracts","href":"/api-reference/contracts/add-a-contract"},{"title":"Find a Specific Whitelisted Contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contracts/{contractId}","href":"/api-reference/contracts/find-a-specific-whitelisted-contract"},{"title":"Delete a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /contracts/{contractId}","href":"/api-reference/contracts/delete-a-contract"},{"title":"Find a whitelisted contract's asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /contracts/{contractId}/{assetId}","href":"/api-reference/contracts/find-a-whitelisted-contracts-asset"},{"title":"Add an asset to a whitelisted contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /contracts/{contractId}/{assetId}","href":"/api-reference/contracts/add-an-asset-to-a-whitelisted-contract"},{"title":"Delete an asset from a whitelisted contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /contracts/{contractId}/{assetId}","href":"/api-reference/contracts/delete-an-asset-from-a-whitelisted-contract"}]},{"group":"Cosigners (Beta)","pages":[{"title":"Get all cosigners","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /cosigners","href":"/api-reference/cosigners-beta/get-all-cosigners"},{"title":"Add cosigner","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /cosigners","href":"/api-reference/cosigners-beta/add-cosigner"},{"title":"Get cosigner","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /cosigners/{cosignerId}","href":"/api-reference/cosigners-beta/get-cosigner"},{"title":"Rename cosigner","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /cosigners/{cosignerId}","href":"/api-reference/cosigners-beta/rename-cosigner"},{"title":"Get all API keys","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /cosigners/{cosignerId}/api_keys","href":"/api-reference/cosigners-beta/get-all-api-keys"},{"title":"Get API key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /cosigners/{cosignerId}/api_keys/{apiKeyId}","href":"/api-reference/cosigners-beta/get-api-key"},{"title":"Pair API key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /cosigners/{cosignerId}/api_keys/{apiKeyId}","href":"/api-reference/cosigners-beta/pair-api-key"},{"title":"Unpair API key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /cosigners/{cosignerId}/api_keys/{apiKeyId}","href":"/api-reference/cosigners-beta/unpair-api-key"},{"title":"Update API key callback handler","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /cosigners/{cosignerId}/api_keys/{apiKeyId}","href":"/api-reference/cosigners-beta/update-api-key-callback-handler"},{"title":"Get request status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId}","href":"/api-reference/cosigners-beta/get-request-status"}]},{"group":"Deployed Contracts","pages":[{"title":"List deployed contracts data","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/contracts","href":"/api-reference/deployed-contracts/list-deployed-contracts-data"},{"title":"Return deployed contract data","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/contracts/{assetId}/{contractAddress}","href":"/api-reference/deployed-contracts/return-deployed-contract-data"},{"title":"Return deployed contract data by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/contracts/{id}","href":"/api-reference/deployed-contracts/return-deployed-contract-data-by-id"},{"title":"Save contract ABI","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/contracts/abi","href":"/api-reference/deployed-contracts/save-contract-abi"},{"title":"Fetch the contract ABI","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/contracts/fetch_abi","href":"/api-reference/deployed-contracts/fetch-the-contract-abi"}]},{"group":"Earn","pages":[{"title":"List earn lending actions","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /earn/actions","href":"/api-reference/earn/list-earn-lending-actions"},{"title":"Create and execute a lending action (deposit or withdraw)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /earn/actions","href":"/api-reference/earn/create-and-execute-a-lending-action-deposit-or-withdraw"},{"title":"Get a single earn lending action","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /earn/actions/{id}","href":"/api-reference/earn/get-a-single-earn-lending-action"},{"title":"Get list of earn opportunities","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /earn/opportunities","href":"/api-reference/earn/get-list-of-earn-opportunities"},{"title":"Get list of earn positions","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /earn/positions","href":"/api-reference/earn/get-list-of-earn-positions"},{"title":"Get list of earn providers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /earn/providers","href":"/api-reference/earn/get-list-of-earn-providers"},{"title":"Approve earn provider terms of service","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /earn/providers/approve_terms_of_service","href":"/api-reference/earn/approve-earn-provider-terms-of-service"}]},{"group":"Embedded Wallets","pages":[{"title":"Get the public key of an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/{walletId}/accounts/{accountId}/{assetId}/{change}/{addressIndex}/public_key_info","href":"/api-reference/embedded-wallets/get-the-public-key-of-an-asset"},{"title":"List wallets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets","href":"/api-reference/embedded-wallets/list-wallets"},{"title":"Create a new wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /ncw/wallets","href":"/api-reference/embedded-wallets/create-a-new-wallet"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}","href":"/api-reference/embedded-wallets/get-a-wallet"},{"title":"Create a new account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /ncw/wallets/{walletId}/accounts","href":"/api-reference/embedded-wallets/create-a-new-account"},{"title":"Get a account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/accounts/{accountId}","href":"/api-reference/embedded-wallets/get-a-account"},{"title":"Retrieve assets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/accounts/{accountId}/assets","href":"/api-reference/embedded-wallets/retrieve-assets"},{"title":"Retrieve asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}","href":"/api-reference/embedded-wallets/retrieve-asset"},{"title":"Add asset to account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}","href":"/api-reference/embedded-wallets/add-asset-to-account"},{"title":"Get the public key of an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_info","href":"/api-reference/embedded-wallets/get-the-public-key-of-an-asset-1"},{"title":"Retrieve asset addresses","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses","href":"/api-reference/embedded-wallets/retrieve-asset-addresses"},{"title":"Retrieve asset balance","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance","href":"/api-reference/embedded-wallets/retrieve-asset-balance"},{"title":"Refresh asset balance","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance","href":"/api-reference/embedded-wallets/refresh-asset-balance"},{"title":"Assign a wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /ncw/wallets/{walletId}/assign","href":"/api-reference/embedded-wallets/assign-a-wallet"},{"title":"Get wallet Latest Backup details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/backup/latest","href":"/api-reference/embedded-wallets/get-wallet-latest-backup-details"},{"title":"Get registered devices - paginated","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/devices_paginated","href":"/api-reference/embedded-wallets/get-registered-devices--paginated"},{"title":"Get Embedded Wallet Device","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/devices/{deviceId}","href":"/api-reference/embedded-wallets/get-embedded-wallet-device"},{"title":"Get device key setup state","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/devices/{deviceId}/setup_status","href":"/api-reference/embedded-wallets/get-device-key-setup-state"},{"title":"Update device status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /ncw/wallets/{walletId}/devices/{deviceId}/status","href":"/api-reference/embedded-wallets/update-device-status"},{"title":"Get the public key for a derivation path","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/public_key_info","href":"/api-reference/embedded-wallets/get-the-public-key-for-a-derivation-path"},{"title":"Get wallet key setup state","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/{walletId}/setup_status","href":"/api-reference/embedded-wallets/get-wallet-key-setup-state"},{"title":"Update wallet status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /ncw/wallets/{walletId}/status","href":"/api-reference/embedded-wallets/update-wallet-status"},{"title":"Retrieve supported assets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /ncw/wallets/supported_assets","href":"/api-reference/embedded-wallets/retrieve-supported-assets"}]},{"group":"Exchange accounts","pages":[{"title":"List exchange accounts","deprecated":true,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /exchange_accounts","href":"/api-reference/exchange-accounts/list-exchange-accounts"},{"title":"Add an exchange account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /exchange_accounts","href":"/api-reference/exchange-accounts/add-an-exchange-account"},{"title":"Get a specific exchange account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /exchange_accounts/{exchangeAccountId}","href":"/api-reference/exchange-accounts/get-a-specific-exchange-account"},{"title":"Get an asset for an exchange account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /exchange_accounts/{exchangeAccountId}/{assetId}","href":"/api-reference/exchange-accounts/get-an-asset-for-an-exchange-account"},{"title":"Convert exchange account funds","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /exchange_accounts/{exchangeAccountId}/convert","href":"/api-reference/exchange-accounts/convert-exchange-account-funds"},{"title":"Internal transfer for exchange accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /exchange_accounts/{exchangeAccountId}/internal_transfer","href":"/api-reference/exchange-accounts/internal-transfer-for-exchange-accounts"},{"title":"Get public key to encrypt exchange credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /exchange_accounts/credentials_public_key","href":"/api-reference/exchange-accounts/get-public-key-to-encrypt-exchange-credentials"},{"title":"List connected exchange accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /exchange_accounts/paged","href":"/api-reference/exchange-accounts/list-connected-exchange-accounts"}]},{"group":"External wallets","pages":[{"title":"List external wallets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /external_wallets","href":"/api-reference/external-wallets/list-external-wallets"},{"title":"Create an external wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /external_wallets","href":"/api-reference/external-wallets/create-an-external-wallet"},{"title":"Find an external wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /external_wallets/{walletId}","href":"/api-reference/external-wallets/find-an-external-wallet"},{"title":"Delete an external wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /external_wallets/{walletId}","href":"/api-reference/external-wallets/delete-an-external-wallet"},{"title":"Get an asset from an external wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /external_wallets/{walletId}/{assetId}","href":"/api-reference/external-wallets/get-an-asset-from-an-external-wallet"},{"title":"Add an asset to an external wallet.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /external_wallets/{walletId}/{assetId}","href":"/api-reference/external-wallets/add-an-asset-to-an-external-wallet"},{"title":"Delete an asset from an external wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /external_wallets/{walletId}/{assetId}","href":"/api-reference/external-wallets/delete-an-asset-from-an-external-wallet"},{"title":"Set an AML customer reference ID for an external wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /external_wallets/{walletId}/set_customer_ref_id","href":"/api-reference/external-wallets/set-an-aml-customer-reference-id-for-an-external-wallet"}]},{"group":"Fiat accounts","pages":[{"title":"List fiat accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /fiat_accounts","href":"/api-reference/fiat-accounts/list-fiat-accounts"},{"title":"Find a specific fiat account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /fiat_accounts/{accountId}","href":"/api-reference/fiat-accounts/find-a-specific-fiat-account"},{"title":"Deposit funds from DDA","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /fiat_accounts/{accountId}/deposit_from_linked_dda","href":"/api-reference/fiat-accounts/deposit-funds-from-dda"},{"title":"Redeem funds to DDA","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /fiat_accounts/{accountId}/redeem_to_linked_dda","href":"/api-reference/fiat-accounts/redeem-funds-to-dda"}]},{"group":"Gas stations","pages":[{"title":"Get gas station settings","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /gas_station","href":"/api-reference/gas-stations/get-gas-station-settings"},{"title":"Get gas station settings by asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /gas_station/{assetId}","href":"/api-reference/gas-stations/get-gas-station-settings-by-asset"},{"title":"Edit gas station settings","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /gas_station/configuration","href":"/api-reference/gas-stations/edit-gas-station-settings"},{"title":"Edit gas station settings for an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /gas_station/configuration/{assetId}","href":"/api-reference/gas-stations/edit-gas-station-settings-for-an-asset"}]},{"group":"Genie (Beta)","pages":[{"title":"Create a Genie session","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /genie/sessions","href":"/api-reference/genie-beta/create-a-genie-session"},{"title":"Send a message to a Genie session","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /genie/sessions/{sessionId}/messages","href":"/api-reference/genie-beta/send-a-message-to-a-genie-session"}]},{"group":"Internal wallets","pages":[{"title":"List internal wallets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /internal_wallets","href":"/api-reference/internal-wallets/list-internal-wallets"},{"title":"Create an internal wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /internal_wallets","href":"/api-reference/internal-wallets/create-an-internal-wallet"},{"title":"Get assets for internal wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /internal_wallets/{walletId}","href":"/api-reference/internal-wallets/get-assets-for-internal-wallet"},{"title":"Delete an internal wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /internal_wallets/{walletId}","href":"/api-reference/internal-wallets/delete-an-internal-wallet"},{"title":"Get an asset from an internal wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /internal_wallets/{walletId}/{assetId}","href":"/api-reference/internal-wallets/get-an-asset-from-an-internal-wallet"},{"title":"Add an asset to an internal wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /internal_wallets/{walletId}/{assetId}","href":"/api-reference/internal-wallets/add-an-asset-to-an-internal-wallet"},{"title":"Delete a whitelisted address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /internal_wallets/{walletId}/{assetId}","href":"/api-reference/internal-wallets/delete-a-whitelisted-address"},{"title":"List assets in an internal wallet (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /internal_wallets/{walletId}/assets","href":"/api-reference/internal-wallets/list-assets-in-an-internal-wallet-paginated"},{"title":"Set an AML/KYT customer reference ID for internal wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /internal_wallets/{walletId}/set_customer_ref_id","href":"/api-reference/internal-wallets/set-an-amlkyt-customer-reference-id-for-internal-wallet"}]},{"group":"Key Link (Beta)","pages":[{"title":"Get list of signing keys","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /key_link/signing_keys","href":"/api-reference/key-link-beta/get-list-of-signing-keys"},{"title":"Add a new signing key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /key_link/signing_keys","href":"/api-reference/key-link-beta/add-a-new-signing-key"},{"title":"Get a signing key by `keyId`","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /key_link/signing_keys/{keyId}","href":"/api-reference/key-link-beta/get-a-signing-key-by-`keyid`"},{"title":"Modify the signing keyId","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /key_link/signing_keys/{keyId}","href":"/api-reference/key-link-beta/modify-the-signing-keyid"},{"title":"Set agent user id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /key_link/signing_keys/{keyId}/agent_user_id","href":"/api-reference/key-link-beta/set-agent-user-id"},{"title":"Register signing keys in bulk","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /key_link/signing_keys/bulk","href":"/api-reference/key-link-beta/register-signing-keys-in-bulk"},{"title":"Get bulk registration jobs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /key_link/signing_keys/bulk/jobs","href":"/api-reference/key-link-beta/get-bulk-registration-jobs"},{"title":"Get a bulk registration job","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /key_link/signing_keys/bulk/jobs/{jobId}","href":"/api-reference/key-link-beta/get-a-bulk-registration-job"},{"title":"Get list of registered validation keys","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /key_link/validation_keys","href":"/api-reference/key-link-beta/get-list-of-registered-validation-keys"},{"title":"Add a new validation key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /key_link/validation_keys","href":"/api-reference/key-link-beta/add-a-new-validation-key"},{"title":"Get a validation key by `keyId`","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /key_link/validation_keys/{keyId}","href":"/api-reference/key-link-beta/get-a-validation-key-by-`keyid`"},{"title":"Disables a validation key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /key_link/validation_keys/{keyId}","href":"/api-reference/key-link-beta/disables-a-validation-key"}]},{"group":"Keys (Beta)","pages":[{"title":"Get list of mpc keys","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /keys/mpc/list","href":"/api-reference/keys-beta/get-list-of-mpc-keys"},{"title":"Get list of mpc keys by `userId`","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /keys/mpc/list/{userId}","href":"/api-reference/keys-beta/get-list-of-mpc-keys-by-`userid`"}]},{"group":"Network connections","pages":[{"title":"List network connections","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_connections","href":"/api-reference/network-connections/list-network-connections"},{"title":"Create a new network connection","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /network_connections","href":"/api-reference/network-connections/create-a-new-network-connection"},{"title":"Get a network connection","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_connections/{connectionId}","href":"/api-reference/network-connections/get-a-network-connection"},{"title":"Delete a network connection by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /network_connections/{connectionId}","href":"/api-reference/network-connections/delete-a-network-connection-by-id"},{"title":"Retrieve third-party network routing validation","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_connections/{connectionId}/is_third_party_routing/{assetType}","href":"/api-reference/network-connections/retrieve-third-party-network-routing-validation"},{"title":"Update network connection routing policy.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /network_connections/{connectionId}/set_routing_policy","href":"/api-reference/network-connections/update-network-connection-routing-policy"},{"title":"Get all network IDs","deprecated":true,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_ids","href":"/api-reference/network-connections/get-all-network-ids"},{"title":"Creates a new Network ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /network_ids","href":"/api-reference/network-connections/creates-a-new-network-id"},{"title":"Return specific network ID.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_ids/{networkId}","href":"/api-reference/network-connections/return-specific-network-id"},{"title":"Delete specific network ID.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /network_ids/{networkId}","href":"/api-reference/network-connections/delete-specific-network-id"},{"title":"Update network ID's discoverability.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /network_ids/{networkId}/set_discoverability","href":"/api-reference/network-connections/update-network-ids-discoverability"},{"title":"Update network ID's name.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /network_ids/{networkId}/set_name","href":"/api-reference/network-connections/update-network-ids-name"},{"title":"Update network id routing policy.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /network_ids/{networkId}/set_routing_policy","href":"/api-reference/network-connections/update-network-id-routing-policy"},{"title":"Return all enabled routing policy asset groups","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_ids/routing_policy_asset_groups","href":"/api-reference/network-connections/return-all-enabled-routing-policy-asset-groups"},{"title":"Get both local IDs and discoverable remote IDs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /network_ids/search","href":"/api-reference/network-connections/get-both-local-ids-and-discoverable-remote-ids"}]},{"group":"NFTs","pages":[{"title":"List all distinct owned tokens (paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /nfts/ownership/assets","href":"/api-reference/nfts/list-all-distinct-owned-tokens-paginated"},{"title":"List owned collections (paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /nfts/ownership/collections","href":"/api-reference/nfts/list-owned-collections-paginated"},{"title":"List all owned tokens (paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /nfts/ownership/tokens","href":"/api-reference/nfts/list-all-owned-tokens-paginated"},{"title":"Refresh vault account tokens","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /nfts/ownership/tokens","href":"/api-reference/nfts/refresh-vault-account-tokens"},{"title":"Update token ownership status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /nfts/ownership/tokens/{id}/status","href":"/api-reference/nfts/update-token-ownership-status"},{"title":"Update tokens ownership spam property","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /nfts/ownership/tokens/spam","href":"/api-reference/nfts/update-tokens-ownership-spam-property"},{"title":"Update tokens ownership status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /nfts/ownership/tokens/status","href":"/api-reference/nfts/update-tokens-ownership-status"},{"title":"List tokens by IDs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /nfts/tokens","href":"/api-reference/nfts/list-tokens-by-ids"},{"title":"List token data by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /nfts/tokens/{id}","href":"/api-reference/nfts/list-token-data-by-id"},{"title":"Refresh token metadata","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /nfts/tokens/{id}","href":"/api-reference/nfts/refresh-token-metadata"}]},{"group":"Off exchanges","pages":[{"title":"Add Collateral","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /off_exchange/add","href":"/api-reference/off-exchanges/add-collateral"},{"title":"Find a specific collateral exchange account","description":"Returns a collateral account by mainExchangeAccountId.\nLearn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).\nEndpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /off_exchange/collateral_accounts/{mainExchangeAccountId}","href":"/api-reference/off-exchanges/find-a-specific-collateral-exchange-account"},{"title":"Remove Collateral","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /off_exchange/remove","href":"/api-reference/off-exchanges/remove-collateral"},{"title":"Create Settlement for a Trader","description":"Create settlement for a trader.\nLearn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).\nEndpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /off_exchange/settlements/trader","href":"/api-reference/off-exchanges/create-settlement-for-a-trader"},{"title":"Get Settlements Transactions","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /off_exchange/settlements/transactions","href":"/api-reference/off-exchanges/get-settlements-transactions"}]},{"group":"Onchain Data","pages":[{"title":"Get the current state of addresses in an access registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/list","href":"/api-reference/onchain-data/get-the-current-state-of-addresses-in-an-access-registry"},{"title":"Summary of access registry state","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/summary","href":"/api-reference/onchain-data/summary-of-access-registry-state"},{"title":"Get historical balance data for a specific account in a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/account_address/{accountAddress}/balance_history","href":"/api-reference/onchain-data/get-historical-balance-data-for-a-specific-account-in-a-contract"},{"title":"Get latest balances for all addresses holding tokens from a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/balances","href":"/api-reference/onchain-data/get-latest-balances-for-all-addresses-holding-tokens-from-a-contract"},{"title":"List of active roles for a given contract address and base asset ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/roles","href":"/api-reference/onchain-data/list-of-active-roles-for-a-given-contract-address-and-base-asset-id"},{"title":"Get summary for the token contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/summary","href":"/api-reference/onchain-data/get-summary-for-the-token-contract"},{"title":"Get historical total supply data for a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/total_supply","href":"/api-reference/onchain-data/get-historical-total-supply-data-for-a-contract"},{"title":"Fetch onchain transactions for a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/transactions","href":"/api-reference/onchain-data/fetch-onchain-transactions-for-a-contract"}]},{"group":"OTA (Beta)","pages":[{"title":"Returns current OTA status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/ota","href":"/api-reference/ota-beta/returns-current-ota-status"},{"title":"Enable or disable transactions to OTA","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /management/ota","href":"/api-reference/ota-beta/enable-or-disable-transactions-to-ota"}]},{"group":"Payments - Flows","pages":[{"title":"Create payment flow configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /payments/workflow_config","href":"/api-reference/payments--flows/create-payment-flow-configuration"},{"title":"Retrieve workflow configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /payments/workflow_config/{configId}","href":"/api-reference/payments--flows/retrieve-workflow-configuration"},{"title":"Delete workflow configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /payments/workflow_config/{configId}","href":"/api-reference/payments--flows/delete-workflow-configuration"},{"title":"Create workflow execution","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /payments/workflow_execution","href":"/api-reference/payments--flows/create-workflow-execution"},{"title":"Get workflow execution details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /payments/workflow_execution/{workflowExecutionId}","href":"/api-reference/payments--flows/get-workflow-execution-details"},{"title":"Execute the payments workflow","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /payments/workflow_execution/{workflowExecutionId}/actions/execute","href":"/api-reference/payments--flows/execute-the-payments-workflow"}]},{"group":"Payments - Payout","pages":[{"title":"Create a payout instruction set","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /payments/payout","href":"/api-reference/payments--payout/create-a-payout-instruction-set"},{"title":"Get the status of a payout instruction set","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /payments/payout/{payoutId}","href":"/api-reference/payments--payout/get-the-status-of-a-payout-instruction-set"},{"title":"Execute a payout instruction set","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /payments/payout/{payoutId}/actions/execute","href":"/api-reference/payments--payout/execute-a-payout-instruction-set"}]},{"group":"Policy Editor (Beta)","pages":[{"title":"Get the active policy and its validation","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tap/active_policy","href":"/api-reference/policy-editor-beta/get-the-active-policy-and-its-validation"},{"title":"Get the active draft","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tap/draft","href":"/api-reference/policy-editor-beta/get-the-active-draft"},{"title":"Update the draft with a new set of rules","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /tap/draft","href":"/api-reference/policy-editor-beta/update-the-draft-with-a-new-set-of-rules"},{"title":"Send publish request for a certain draft id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tap/draft","href":"/api-reference/policy-editor-beta/send-publish-request-for-a-certain-draft-id"},{"title":"Send publish request for a set of policy rules","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tap/publish","href":"/api-reference/policy-editor-beta/send-publish-request-for-a-set-of-policy-rules"}]},{"group":"Policy Editor V2","pages":[{"title":"Get the active policy and its validation by policy type","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /policy/active_policy","href":"/api-reference/policy-editor-v2/get-the-active-policy-and-its-validation-by-policy-type"},{"title":"Get the active draft by policy type","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /policy/draft","href":"/api-reference/policy-editor-v2/get-the-active-draft-by-policy-type"},{"title":"Update the draft with a new set of rules by policy types","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /policy/draft","href":"/api-reference/policy-editor-v2/update-the-draft-with-a-new-set-of-rules-by-policy-types"},{"title":"Send publish request for a certain draft id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /policy/draft","href":"/api-reference/policy-editor-v2/send-publish-request-for-a-certain-draft-id"}]},{"group":"Policy Editor V2 (Beta)","pages":[{"title":"Calculate the AOT quota for a policy rule","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /policy/rules/quota","href":"/api-reference/policy-editor-v2-beta/calculate-the-aot-quota-for-a-policy-rule"}]},{"group":"Reports (Beta)","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /reports","href":"/api-reference/reports-beta/list-reports"},{"title":"Create a report","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /reports","href":"/api-reference/reports-beta/create-a-report"},{"title":"Get report status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /reports/{reportId}","href":"/api-reference/reports-beta/get-report-status"}]},{"group":"Reset device","pages":[{"title":"Resets device","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /management/users/{id}/reset_device","href":"/api-reference/reset-device/resets-device"}]},{"group":"Security Posture Management","pages":[{"title":"Get FSPM security findings","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /security/fspm/findings","href":"/api-reference/security-posture-management/get-fspm-security-findings"},{"title":"Get a FSPM security finding by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /security/fspm/findings/{id}","href":"/api-reference/security-posture-management/get-a-fspm-security-finding-by-id"},{"title":"Update a FSPM security finding by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /security/fspm/findings/{id}","href":"/api-reference/security-posture-management/update-a-fspm-security-finding-by-id"}]},{"group":"Smart Transfer","pages":[{"title":"Fund dvp ticket","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart_transfers/{ticketId}/dvp/fund","href":"/api-reference/smart-transfer/fund-dvp-ticket"},{"title":"Set funding source and approval","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart_transfers/{ticketId}/terms/{termId}/dvp/approve","href":"/api-reference/smart-transfer/set-funding-source-and-approval"},{"title":"Get smart transfers statistic","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /smart_transfers/statistic","href":"/api-reference/smart-transfer/get-smart-transfers-statistic"},{"title":"Find Ticket","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /smart-transfers","href":"/api-reference/smart-transfer/find-ticket"},{"title":"Create Ticket","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /smart-transfers","href":"/api-reference/smart-transfer/create-ticket"},{"title":"Search Ticket by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /smart-transfers/{ticketId}","href":"/api-reference/smart-transfer/search-ticket-by-id"},{"title":"Cancel Ticket","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/cancel","href":"/api-reference/smart-transfer/cancel-ticket"},{"title":"Set expiration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/expires-in","href":"/api-reference/smart-transfer/set-expiration"},{"title":"Add external ref. ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/external-id","href":"/api-reference/smart-transfer/add-external-ref-id"},{"title":"Fund ticket manually","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/fulfill","href":"/api-reference/smart-transfer/fund-ticket-manually"},{"title":"Submit ticket","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/submit","href":"/api-reference/smart-transfer/submit-ticket"},{"title":"Create leg (term)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /smart-transfers/{ticketId}/terms","href":"/api-reference/smart-transfer/create-leg-term"},{"title":"Get Smart Transfer ticket term","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /smart-transfers/{ticketId}/terms/{termId}","href":"/api-reference/smart-transfer/get-smart-transfer-ticket-term"},{"title":"Update ticket leg (term)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/terms/{termId}","href":"/api-reference/smart-transfer/update-ticket-leg-term"},{"title":"Delete ticket leg (term)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /smart-transfers/{ticketId}/terms/{termId}","href":"/api-reference/smart-transfer/delete-ticket-leg-term"},{"title":"Define funding source","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/terms/{termId}/fund","href":"/api-reference/smart-transfer/define-funding-source"},{"title":"Manually add term transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /smart-transfers/{ticketId}/terms/{termId}/manually-fund","href":"/api-reference/smart-transfer/manually-add-term-transaction"},{"title":"Get user group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /smart-transfers/settings/user-groups","href":"/api-reference/smart-transfer/get-user-group"},{"title":"Set user group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /smart-transfers/settings/user-groups","href":"/api-reference/smart-transfer/set-user-group"}]},{"group":"Staking","pages":[{"title":"List supported staking chains","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/chains","href":"/api-reference/staking/list-supported-staking-chains"},{"title":"Get chain-level staking parameters","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/chains/{chainDescriptor}/chainInfo","href":"/api-reference/staking/get-chain-level-staking-parameters"},{"title":"Claim accrued rewards","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/claim_rewards","href":"/api-reference/staking/claim-accrued-rewards"},{"title":"Consolidate staking positions (ETH validator consolidation)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/consolidate","href":"/api-reference/staking/consolidate-staking-positions-eth-validator-consolidation"},{"title":"Merge staking positions","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/merge","href":"/api-reference/staking/merge-staking-positions"},{"title":"Split a staking position","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/split","href":"/api-reference/staking/split-a-staking-position"},{"title":"Initiate or add to existing stake","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/stake","href":"/api-reference/staking/initiate-or-add-to-existing-stake"},{"title":"Initiate unstake","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/unstake","href":"/api-reference/staking/initiate-unstake"},{"title":"Withdraw staked funds","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/chains/{chainDescriptor}/withdraw","href":"/api-reference/staking/withdraw-staked-funds"},{"title":"List staking positions","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/positions","href":"/api-reference/staking/list-staking-positions"},{"title":"List staking positions (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/positions_paginated","href":"/api-reference/staking/list-staking-positions-paginated"},{"title":"Get position details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/positions/{id}","href":"/api-reference/staking/get-position-details"},{"title":"List related transactions for a position","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/positions/{id}/related_transactions","href":"/api-reference/staking/list-related-transactions-for-a-position"},{"title":"Get positions summary","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/positions/summary","href":"/api-reference/staking/get-positions-summary"},{"title":"Get positions summary by vault","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/positions/summary/vaults","href":"/api-reference/staking/get-positions-summary-by-vault"},{"title":"List staking providers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /staking/providers","href":"/api-reference/staking/list-staking-providers"},{"title":"Approve provider terms of service","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /staking/providers/{providerId}/approveTermsOfService","href":"/api-reference/staking/approve-provider-terms-of-service"}]},{"group":"Tags","pages":[{"title":"Get list of tags","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tags","href":"/api-reference/tags/get-list-of-tags"},{"title":"Create a new tag","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tags","href":"/api-reference/tags/create-a-new-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tags/{tagId}","href":"/api-reference/tags/get-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /tags/{tagId}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /tags/{tagId}","href":"/api-reference/tags/update-a-tag"},{"title":"Get an approval request by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tags/approval_requests/{id}","href":"/api-reference/tags/get-an-approval-request-by-id"}]},{"group":"Tempo (Beta)","pages":[{"title":"Create a Tempo transfer transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /operations/tempo/transfer","href":"/api-reference/tempo-beta/create-a-tempo-transfer-transaction"}]},{"group":"Tokenization","pages":[{"title":"Get current state of addresses in an access registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/access_registries/{id}/addresses","href":"/api-reference/tokenization/get-current-state-of-addresses-in-an-access-registry"},{"title":"Get summary of an access registry","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/access_registries/{id}/summary","href":"/api-reference/tokenization/get-summary-of-an-access-registry"},{"title":"Get collections","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/collections","href":"/api-reference/tokenization/get-collections"},{"title":"Create a new collection","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/collections","href":"/api-reference/tokenization/create-a-new-collection"},{"title":"Get a collection by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/collections/{id}","href":"/api-reference/tokenization/get-a-collection-by-id"},{"title":"Delete a collection link","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /tokenization/collections/{id}","href":"/api-reference/tokenization/delete-a-collection-link"},{"title":"Get collection token details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/collections/{id}/tokens/{tokenId}","href":"/api-reference/tokenization/get-collection-token-details"},{"title":"Burn tokens","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/collections/{id}/tokens/burn","href":"/api-reference/tokenization/burn-tokens"},{"title":"Mint tokens","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/collections/{id}/tokens/mint","href":"/api-reference/tokenization/mint-tokens"},{"title":"Deploy LayerZero adapters","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/multichain/bridge/layerzero","href":"/api-reference/tokenization/deploy-layerzero-adapters"},{"title":"Remove LayerZero adapters","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /tokenization/multichain/bridge/layerzero","href":"/api-reference/tokenization/remove-layerzero-adapters"},{"title":"Get LayerZero DVN configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/dvns","href":"/api-reference/tokenization/get-layerzero-dvn-configuration"},{"title":"Get LayerZero peers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/peers","href":"/api-reference/tokenization/get-layerzero-peers"},{"title":"Set LayerZero DVN configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/multichain/bridge/layerzero/config/dvns","href":"/api-reference/tokenization/set-layerzero-dvn-configuration"},{"title":"Set LayerZero peers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/multichain/bridge/layerzero/config/peers","href":"/api-reference/tokenization/set-layerzero-peers"},{"title":"Remove LayerZero peers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /tokenization/multichain/bridge/layerzero/config/peers","href":"/api-reference/tokenization/remove-layerzero-peers"},{"title":"Validate LayerZero channel configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/multichain/bridge/layerzero/validate","href":"/api-reference/tokenization/validate-layerzero-channel-configuration"},{"title":"Get deterministic address for contract deployment","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/multichain/deterministic_address","href":"/api-reference/tokenization/get-deterministic-address-for-contract-deployment"},{"title":"Reissue a multichain token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/multichain/reissue/token/{tokenLinkId}","href":"/api-reference/tokenization/reissue-a-multichain-token"},{"title":"Issue a token on one or more blockchains","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/multichain/tokens","href":"/api-reference/tokenization/issue-a-token-on-one-or-more-blockchains"},{"title":"List all linked tokens","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens","href":"/api-reference/tokenization/list-all-linked-tokens"},{"title":"Issue a new token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/tokens","href":"/api-reference/tokenization/issue-a-new-token"},{"title":"Return a linked token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}","href":"/api-reference/tokenization/return-a-linked-token"},{"title":"Unlink a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /tokenization/tokens/{id}","href":"/api-reference/tokenization/unlink-a-token"},{"title":"Get latest balances for all holders of a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/balances","href":"/api-reference/tokenization/get-latest-balances-for-all-holders-of-a-token"},{"title":"Get the latest balance for a specific account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/balances/{accountAddress}","href":"/api-reference/tokenization/get-the-latest-balance-for-a-specific-account"},{"title":"Get balance history for a specific account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/balances/{accountAddress}/history","href":"/api-reference/tokenization/get-balance-history-for-a-specific-account"},{"title":"Get active RBAC roles for a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/rbac","href":"/api-reference/tokenization/get-active-rbac-roles-for-a-token"},{"title":"Get onchain summary for a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/summary","href":"/api-reference/tokenization/get-onchain-summary-for-a-token"},{"title":"Get historical total supply for a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/total_supply","href":"/api-reference/tokenization/get-historical-total-supply-for-a-token"},{"title":"Get onchain transactions for a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/transactions","href":"/api-reference/tokenization/get-onchain-transactions-for-a-token"},{"title":"Get onchain transfers for a token","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/{id}/transfers","href":"/api-reference/tokenization/get-onchain-transfers-for-a-token"},{"title":"Get the total count of linked tokens","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /tokenization/tokens/count","href":"/api-reference/tokenization/get-the-total-count-of-linked-tokens"},{"title":"Link a contract","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /tokenization/tokens/link","href":"/api-reference/tokenization/link-a-contract"}]},{"group":"Trading","pages":[{"title":"Get all offers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /trading/offers","href":"/api-reference/trading/get-all-offers"},{"title":"Get orders","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /trading/orders","href":"/api-reference/trading/get-orders"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /trading/orders","href":"/api-reference/trading/create-an-order"},{"title":"Get order details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /trading/orders/{orderId}","href":"/api-reference/trading/get-order-details"},{"title":"Get order requirement details for an order","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /trading/orders/{orderId}/requirement","href":"/api-reference/trading/get-order-requirement-details-for-an-order"},{"title":"Submit a response to an order requirement","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /trading/orders/{orderId}/requirement/data","href":"/api-reference/trading/submit-a-response-to-an-order-requirement"},{"title":"Upload a file for an order requirement","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /trading/orders/{orderId}/requirement/file","href":"/api-reference/trading/upload-a-file-for-an-order-requirement"},{"title":"Get providers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /trading/providers","href":"/api-reference/trading/get-providers"},{"title":"Get trading provider by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /trading/providers/{providerId}","href":"/api-reference/trading/get-trading-provider-by-id"},{"title":"Create a quote","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /trading/quotes","href":"/api-reference/trading/create-a-quote"},{"title":"Get rates","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /trading/rates","href":"/api-reference/trading/get-rates"}]},{"group":"Transactions","pages":[{"title":"Estimate the required fee for an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /estimate_network_fee","href":"/api-reference/transactions/estimate-the-required-fee-for-an-asset"},{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /transactions","href":"/api-reference/transactions/get-transaction-history"},{"title":"Create a new transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions","href":"/api-reference/transactions/create-a-new-transaction"},{"title":"Get a specific transaction by Fireblocks transaction ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /transactions/{txId}","href":"/api-reference/transactions/get-a-specific-transaction-by-fireblocks-transaction-id"},{"title":"Cancel a transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions/{txId}/cancel","href":"/api-reference/transactions/cancel-a-transaction"},{"title":"Drop ETH (EVM) transaction by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions/{txId}/drop","href":"/api-reference/transactions/drop-eth-evm-transaction-by-id"},{"title":"Freeze a transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions/{txId}/freeze","href":"/api-reference/transactions/freeze-a-transaction"},{"title":"Set confirmation threshold by Fireblocks Transaction ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions/{txId}/set_confirmation_threshold","href":"/api-reference/transactions/set-confirmation-threshold-by-fireblocks-transaction-id"},{"title":"Unfreeze a transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions/{txId}/unfreeze","href":"/api-reference/transactions/unfreeze-a-transaction"},{"title":"Estimate transaction fee","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /transactions/estimate_fee","href":"/api-reference/transactions/estimate-transaction-fee"},{"title":"Get a specific transaction by external transaction ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /transactions/external_tx_id/{externalTxId}","href":"/api-reference/transactions/get-a-specific-transaction-by-external-transaction-id"},{"title":"Validate destination address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /transactions/validate_address/{assetId}/{address}","href":"/api-reference/transactions/validate-destination-address"},{"title":"Set confirmation threshold by transaction hash","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /txHash/{txHash}/set_confirmation_threshold","href":"/api-reference/transactions/set-confirmation-threshold-by-transaction-hash"}]},{"group":"Travel Rule","pages":[{"title":"Create Trust Network Proof of Address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/travel_rule/providers/trust/proof_of_address","href":"/api-reference/travel-rule/create-trust-network-proof-of-address"},{"title":"Retrieve Trust Network Proof of Address Signature","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/providers/trust/proof_of_address/{transactionId}","href":"/api-reference/travel-rule/retrieve-trust-network-proof-of-address-signature"},{"title":"Validate Travel Rule Transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/travel_rule/transaction/validate","href":"/api-reference/travel-rule/validate-travel-rule-transaction"},{"title":"Validate Full Travel Rule Transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/travel_rule/transaction/validate/full","href":"/api-reference/travel-rule/validate-full-travel-rule-transaction"},{"title":"Get All VASPs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/vasp","href":"/api-reference/travel-rule/get-all-vasps"},{"title":"Get VASP details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/vasp/{did}","href":"/api-reference/travel-rule/get-vasp-details"},{"title":"Add jsonDidKey to VASP details","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/travel_rule/vasp/update","href":"/api-reference/travel-rule/add-jsondidkey-to-vasp-details"},{"title":"Get assigned VASP to vault","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/travel_rule/vault/{vaultAccountId}/vasp","href":"/api-reference/travel-rule/get-assigned-vasp-to-vault"},{"title":"Assign VASP to vault","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/travel_rule/vault/{vaultAccountId}/vasp","href":"/api-reference/travel-rule/assign-vasp-to-vault"}]},{"group":"TRLink","pages":[{"title":"Get all customers","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers","href":"/api-reference/trlink/get-all-customers"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers","href":"/api-reference/trlink/create-customer"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/{customerId}","href":"/api-reference/trlink/get-customer-by-id"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/trlink/customers/{customerId}","href":"/api-reference/trlink/update-customer"},{"title":"Delete customer","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /screening/trlink/customers/{customerId}","href":"/api-reference/trlink/delete-customer"},{"title":"Get customer integrations","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/{customerId}/integrations","href":"/api-reference/trlink/get-customer-integrations"},{"title":"Get customer integration by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/{customerId}/integrations/{customerIntegrationId}","href":"/api-reference/trlink/get-customer-integration-by-id"},{"title":"Create customer integration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration","href":"/api-reference/trlink/create-customer-integration"},{"title":"Connect customer integration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /screening/trlink/customers/integration/{customerIntegrationId}","href":"/api-reference/trlink/connect-customer-integration"},{"title":"Disconnect customer integration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /screening/trlink/customers/integration/{customerIntegrationId}","href":"/api-reference/trlink/disconnect-customer-integration"},{"title":"List supported assets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/assets","href":"/api-reference/trlink/list-supported-assets"},{"title":"Get supported asset by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId}","href":"/api-reference/trlink/get-supported-asset-by-id"},{"title":"Get public key for PII encryption","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/public_key","href":"/api-reference/trlink/get-public-key-for-pii-encryption"},{"title":"Test connection","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/test_connection","href":"/api-reference/trlink/test-connection"},{"title":"Manual decision for missing TRM","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decision","href":"/api-reference/trlink/manual-decision-for-missing-trm"},{"title":"Create Travel Rule Message","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/trm","href":"/api-reference/trlink/create-travel-rule-message"},{"title":"Get TRM by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}","href":"/api-reference/trlink/get-trm-by-id"},{"title":"Cancel Travel Rule Message","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancel","href":"/api-reference/trlink/cancel-travel-rule-message"},{"title":"Redirect Travel Rule Message","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect","href":"/api-reference/trlink/redirect-travel-rule-message"},{"title":"Get required actions for a TRM","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions","href":"/api-reference/trlink/get-required-actions-for-a-trm"},{"title":"Resolve action for a TRM","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/resolve_action","href":"/api-reference/trlink/resolve-action-for-a-trm"},{"title":"Assess Travel Rule requirement","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/customers/integration/{customerIntegrationId}/trm/assess","href":"/api-reference/trlink/assess-travel-rule-requirement"},{"title":"List VASPs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/vasps","href":"/api-reference/trlink/list-vasps"},{"title":"Get VASP by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId}","href":"/api-reference/trlink/get-vasp-by-id"},{"title":"List available TRSupport partners","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/partners","href":"/api-reference/trlink/list-available-trsupport-partners"},{"title":"Get TRLink policy","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /screening/trlink/policy","href":"/api-reference/trlink/get-trlink-policy"},{"title":"Set destination travel rule message ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/transaction/{txId}/destination/travel_rule_message_id","href":"/api-reference/trlink/set-destination-travel-rule-message-id"},{"title":"Set transaction travel rule message ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /screening/trlink/transaction/{txId}/travel_rule_message_id","href":"/api-reference/trlink/set-transaction-travel-rule-message-id"}]},{"group":"User groups (Beta)","pages":[{"title":"List user groups","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/user_groups","href":"/api-reference/user-groups-beta/list-user-groups"},{"title":"Create user group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /management/user_groups","href":"/api-reference/user-groups-beta/create-user-group"},{"title":"Get user group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/user_groups/{groupId}","href":"/api-reference/user-groups-beta/get-user-group"},{"title":"Update user group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /management/user_groups/{groupId}","href":"/api-reference/user-groups-beta/update-user-group"},{"title":"Delete user group","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /management/user_groups/{groupId}","href":"/api-reference/user-groups-beta/delete-user-group"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /users","href":"/api-reference/users/list-users"}]},{"group":"UTXO Management (Beta)","pages":[{"title":"Attach or detach labels to/from UTXOs","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /utxo_management/{vaultAccountId}/{assetId}/labels","href":"/api-reference/utxo-management-beta/attach-or-detach-labels-tofrom-utxos"},{"title":"Get vault and asset UTXO selection config","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /utxo_management/{vaultAccountId}/{assetId}/selection_config","href":"/api-reference/utxo-management-beta/get-vault-and-asset-utxo-selection-config"},{"title":"Upsert vault and asset UTXO selection config","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /utxo_management/{vaultAccountId}/{assetId}/selection_config","href":"/api-reference/utxo-management-beta/upsert-vault-and-asset-utxo-selection-config"},{"title":"List unspent outputs (UTXOs)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /utxo_management/{vaultAccountId}/{assetId}/unspent_outputs","href":"/api-reference/utxo-management-beta/list-unspent-outputs-utxos"},{"title":"Get UTXO selection config","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /utxo_management/selection_config","href":"/api-reference/utxo-management-beta/get-utxo-selection-config"},{"title":"Upsert UTXO selection config","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /utxo_management/selection_config","href":"/api-reference/utxo-management-beta/upsert-utxo-selection-config"}]},{"group":"Vaults","pages":[{"title":"Get vault accounts","deprecated":true,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts","href":"/api-reference/vaults/get-vault-accounts"},{"title":"Create a new vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts","href":"/api-reference/vaults/create-a-new-vault-account"},{"title":"Get vault accounts (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts_paged","href":"/api-reference/vaults/get-vault-accounts-paginated"},{"title":"Get a vault account by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}","href":"/api-reference/vaults/get-a-vault-account-by-id"},{"title":"Rename a vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /vault/accounts/{vaultAccountId}","href":"/api-reference/vaults/rename-a-vault-account"},{"title":"Get the asset balance for a vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}","href":"/api-reference/vaults/get-the-asset-balance-for-a-vault-account"},{"title":"Create a new vault wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/{assetId}","href":"/api-reference/vaults/create-a-new-vault-wallet"},{"title":"Get an asset's public key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info","href":"/api-reference/vaults/get-an-assets-public-key"},{"title":"Activate a wallet in a vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/{assetId}/activate","href":"/api-reference/vaults/activate-a-wallet-in-a-vault-account"},{"title":"Get asset addresses","deprecated":true,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}/addresses","href":"/api-reference/vaults/get-asset-addresses"},{"title":"Create new asset deposit address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/{assetId}/addresses","href":"/api-reference/vaults/create-new-asset-deposit-address"},{"title":"Get addresses (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated","href":"/api-reference/vaults/get-addresses-paginated"},{"title":"Update address description","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}","href":"/api-reference/vaults/update-address-description"},{"title":"Convert a segwit address to legacy format","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy","href":"/api-reference/vaults/convert-a-segwit-address-to-legacy-format"},{"title":"Assign AML customer reference ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id","href":"/api-reference/vaults/assign-aml-customer-reference-id"},{"title":"Refresh asset balance data","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/{assetId}/balance","href":"/api-reference/vaults/refresh-asset-balance-data"},{"title":"Get maximum BIP44 index used","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_used","href":"/api-reference/vaults/get-maximum-bip44-index-used"},{"title":"Get max spendable amount in a transaction","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount","href":"/api-reference/vaults/get-max-spendable-amount-in-a-transaction"},{"title":"Get UTXO unspent inputs information","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs","href":"/api-reference/vaults/get-utxo-unspent-inputs-information"},{"title":"Hide a vault account in the console","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/hide","href":"/api-reference/vaults/hide-a-vault-account-in-the-console"},{"title":"Set auto fueling to on or off","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/set_auto_fuel","href":"/api-reference/vaults/set-auto-fueling-to-on-or-off"},{"title":"Set an AML/KYT ID for a vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/set_customer_ref_id","href":"/api-reference/vaults/set-an-amlkyt-id-for-a-vault-account"},{"title":"Unhide a vault account in the console","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/unhide","href":"/api-reference/vaults/unhide-a-vault-account-in-the-console"},{"title":"Get USDC Gateway wallet info","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/usdc_gateway","href":"/api-reference/vaults/get-usdc-gateway-wallet-info"},{"title":"Activate a USDC Gateway wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/usdc_gateway/activate","href":"/api-reference/vaults/activate-a-usdc-gateway-wallet"},{"title":"Deactivate a USDC Gateway wallet","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/usdc_gateway/deactivate","href":"/api-reference/vaults/deactivate-a-usdc-gateway-wallet"},{"title":"Read the USDC Gateway deposit automations for a vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation","href":"/api-reference/vaults/read-the-usdc-gateway-deposit-automations-for-a-vault-account"},{"title":"Set up a USDC Gateway deposit automation for a vault account","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation","href":"/api-reference/vaults/set-up-a-usdc-gateway-deposit-automation-for-a-vault-account"},{"title":"Stop a USDC Gateway deposit automation's schedule","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation/{automationId}","href":"/api-reference/vaults/stop-a-usdc-gateway-deposit-automations-schedule"},{"title":"Change a USDC Gateway deposit automation","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation/{automationId}","href":"/api-reference/vaults/change-a-usdc-gateway-deposit-automation"},{"title":"Bulk creation of new deposit addresses","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/addresses/bulk","href":"/api-reference/vaults/bulk-creation-of-new-deposit-addresses"},{"title":"Get the job status of the bulk deposit address creation","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/addresses/bulk/{jobId}","href":"/api-reference/vaults/get-the-job-status-of-the-bulk-deposit-address-creation"},{"title":"Attach or detach tags from vault accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/attached_tags","href":"/api-reference/vaults/attach-or-detach-tags-from-vault-accounts"},{"title":"Bulk creation of new vault accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /vault/accounts/bulk","href":"/api-reference/vaults/bulk-creation-of-new-vault-accounts"},{"title":"Get job status of bulk creation of new vault accounts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/accounts/bulk/{jobId}","href":"/api-reference/vaults/get-job-status-of-bulk-creation-of-new-vault-accounts"},{"title":"Get vault wallets (Paginated)","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/asset_wallets","href":"/api-reference/vaults/get-vault-wallets-paginated"},{"title":"Get asset balance for chosen assets","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/assets","href":"/api-reference/vaults/get-asset-balance-for-chosen-assets"},{"title":"Get vault balance by an asset","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/assets/{assetId}","href":"/api-reference/vaults/get-vault-balance-by-an-asset"},{"title":"Look up a vault account by blockchain address","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/lookup_by_address","href":"/api-reference/vaults/look-up-a-vault-account-by-blockchain-address"},{"title":"Get the public key for a derivation path","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /vault/public_key_info","href":"/api-reference/vaults/get-the-public-key-for-a-derivation-path"}]},{"group":"Web3 connections","pages":[{"title":"List all open Web3 connections.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /connections","href":"/api-reference/web3-connections/list-all-open-web3-connections"},{"title":"Create a new Web3 connection.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /connections/wc","href":"/api-reference/web3-connections/create-a-new-web3-connection"},{"title":"Respond to a pending Web3 connection request.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml put /connections/wc/{id}","href":"/api-reference/web3-connections/respond-to-a-pending-web3-connection-request"},{"title":"Remove an existing Web3 connection.","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /connections/wc/{id}","href":"/api-reference/web3-connections/remove-an-existing-web3-connection"}]},{"group":"Webhooks","pages":[{"title":"Resend failed webhooks","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks/resend","href":"/api-reference/webhooks/resend-failed-webhooks"},{"title":"Resend webhooks for a transaction by ID","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks/resend/{txId}","href":"/api-reference/webhooks/resend-webhooks-for-a-transaction-by-id"}]},{"group":"Webhooks V2","pages":[{"title":"Get all webhooks","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks","href":"/api-reference/webhooks-v2/get-all-webhooks"},{"title":"Create a new webhook","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks","href":"/api-reference/webhooks-v2/create-a-new-webhook"},{"title":"List the uploaded mTLS configurations","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks_settings/mtls","href":"/api-reference/webhooks-v2/list-the-uploaded-mtls-configurations"},{"title":"Create an mTLS configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks_settings/mtls","href":"/api-reference/webhooks-v2/create-an-mtls-configuration"},{"title":"Get mTLS CSR","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks_settings/mtls_csr","href":"/api-reference/webhooks-v2/get-mtls-csr"},{"title":"Get an mTLS configuration by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks_settings/mtls/{webhookMtlsId}","href":"/api-reference/webhooks-v2/get-an-mtls-configuration-by-id"},{"title":"Delete an mTLS configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /webhooks_settings/mtls/{webhookMtlsId}","href":"/api-reference/webhooks-v2/delete-an-mtls-configuration"},{"title":"Update an mTLS configuration","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /webhooks_settings/mtls/{webhookMtlsId}","href":"/api-reference/webhooks-v2/update-an-mtls-configuration"},{"title":"Get all OAuth credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks_settings/oauth","href":"/api-reference/webhooks-v2/get-all-oauth-credentials"},{"title":"Create OAuth credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks_settings/oauth","href":"/api-reference/webhooks-v2/create-oauth-credentials"},{"title":"Get OAuth credentials by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks_settings/oauth/{webhookOauthId}","href":"/api-reference/webhooks-v2/get-oauth-credentials-by-id"},{"title":"Delete OAuth credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /webhooks_settings/oauth/{webhookOauthId}","href":"/api-reference/webhooks-v2/delete-oauth-credentials"},{"title":"Update OAuth credentials","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /webhooks_settings/oauth/{webhookOauthId}","href":"/api-reference/webhooks-v2/update-oauth-credentials"},{"title":"Get webhook by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks-v2/get-webhook-by-id"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks-v2/delete-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml patch /webhooks/{webhookId}","href":"/api-reference/webhooks-v2/update-webhook"},{"title":"Get webhook metrics","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}/metrics/{metricName}","href":"/api-reference/webhooks-v2/get-webhook-metrics"},{"title":"Get all notifications by webhook id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}/notifications","href":"/api-reference/webhooks-v2/get-all-notifications-by-webhook-id"},{"title":"Get notification by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}/notifications/{notificationId}","href":"/api-reference/webhooks-v2/get-notification-by-id"},{"title":"Get notification attempts","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}/notifications/{notificationId}/attempts","href":"/api-reference/webhooks-v2/get-notification-attempts"},{"title":"Resend notification by id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks/{webhookId}/notifications/{notificationId}/resend","href":"/api-reference/webhooks-v2/resend-notification-by-id"},{"title":"Resend notifications by query","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks/{webhookId}/notifications/resend_by_query","href":"/api-reference/webhooks-v2/resend-notifications-by-query"},{"title":"Get resend by query job status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}/notifications/resend_by_query/jobs/{jobId}","href":"/api-reference/webhooks-v2/get-resend-by-query-job-status"},{"title":"Resend notifications by resource Id","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks/{webhookId}/notifications/resend_by_resource","href":"/api-reference/webhooks-v2/resend-notifications-by-resource-id"},{"title":"Resend failed notifications","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /webhooks/{webhookId}/notifications/resend_failed","href":"/api-reference/webhooks-v2/resend-failed-notifications"},{"title":"Get resend job status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /webhooks/{webhookId}/notifications/resend_failed/jobs/{jobId}","href":"/api-reference/webhooks-v2/get-resend-job-status"}]},{"group":"whitelist ip addresses","pages":[{"title":"Get whitelisted ip addresses for an API Key","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/api_users/{userId}/whitelist_ip_addresses","href":"/api-reference/whitelist-ip-addresses/get-whitelisted-ip-addresses-for-an-api-key"}]},{"group":"Workspace","pages":[{"title":"Get workspace","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /workspace","href":"/api-reference/workspace/get-workspace"},{"title":"Freeze","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml post /workspace/freeze","href":"/api-reference/workspace/freeze"}]},{"group":"Workspace Status (Beta)","pages":[{"title":"Returns current workspace status","deprecated":null,"version":null,"openapi":"https://swagger.fireblocks.com/openapi.yaml get /management/workspace_status","href":"/api-reference/workspace-status-beta/returns-current-workspace-status"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Remove Collateral - Fireblocks Developer Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-m07pfKpT.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}