{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Bitnob","description":"Bitnob is a financial infrastructure API for bitcoin, stablecoins, and local currency rails across Africa. Guides, API reference, and courses.","colors":{"primary":"#00A57F","light":"#00E4AF","dark":"#00795D"},"logo":{"light":"https://mintcdn.com/bitnob/1gUqO4UxgycXihsV/logo/light.svg?fit=max\u0026auto=format\u0026n=1gUqO4UxgycXihsV\u0026q=85\u0026s=d85bd0bfb85b47fa764bc1ff421b8ce8","dark":"https://mintcdn.com/bitnob/1gUqO4UxgycXihsV/logo/dark.svg?fit=max\u0026auto=format\u0026n=1gUqO4UxgycXihsV\u0026q=85\u0026s=e86a2938d369b4849b355e94a9aa39d4"},"favicon":"https://mintcdn.com/bitnob/_7Z9zBKHf2nvKkWh/favicon.svg?fit=max\u0026auto=format\u0026n=_7Z9zBKHf2nvKkWh\u0026q=85\u0026s=f807ad45c796566ee843893b0bc3345d","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php","go","java"],"prefill":true}},"navbar":{"links":[{"href":"https://status.bitnob.com","label":"Status"},{"href":"https://app.bitnob.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get Started","href":"https://bitnob.com"}},"footer":{"socials":{"x":"https://x.com/bitnob","github":"https://github.com/bitnob","website":"https://bitnob.com"}},"search":{"prompt":"Ask a question or search the Bitnob docs"},"seo":{"metatags":{"og:site_name":"Bitnob Docs","twitter:card":"summary_large_image","twitter:site":"@bitnob","twitter:creator":"@bitnob"},"organization":{"id":"https://bitnob.com/#organization","name":"Bitnob","url":"https://bitnob.com/","logo":"https://bitnob.com/bitnob-logo.png","sameAs":["https://x.com/bitnob","https://twitter.com/Bitnob_Official","https://linkedin.com/company/bitnob","https://github.com/bitnob","https://instagram.com/Bitnob","https://youtube.com/@bitnob","https://facebook.com/bitnob","https://tiktok.com/@bitnob"]},"indexing":"navigable"},"contextual":{"options":["copy","view","assistant","download-pdf","download-spec","chatgpt","claude","perplexity","grok","devin","windsurf","cursor","vscode","mcp","add-mcp","devin-mcp"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/bitnob/6uym4cOVBRGACTcE/images/og-background.png?fit=max\u0026auto=format\u0026n=6uym4cOVBRGACTcE\u0026q=85\u0026s=05d6033949a75937f6e325be7eb98d83"},"markdown":{"schema":true,"instructions":["Bitnob API requests authenticate with an `X-Auth-Client` API key header against https://api.bitnob.com.","Always use the sandbox environment for testing. Never put live API keys in sample code.","Money amounts are integers in the smallest unit of the currency (satoshis for BTC, cents for fiat). Never use floats.","Every state-changing request takes a client-supplied `reference` and must be treated as idempotent on retry.","Quotes expire. Re-quote rather than reusing a stale quote id."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bitnob","hasAudioNarration":false,"actualSubdomain":"bitnob","customDomains":["www.bitnob.dev"],"gitSource":{"type":"github","owner":"bitnob","repo":"stealthdocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aecadec07fe6b5b8129a2aa","collectionId":"a203871d-299d-4c5c-a71a-ab8b1036668b","liveDeploymentHistoryId":"6aecadec07fe6b5b8129a2aa","schemaVersion":"v3"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aeda9e8f8ed849a5c7d8668","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Docs","count":117},{"language":"default","tag":"Business API","count":110},{"language":"default","tag":"Learn","count":106},{"language":"default","tag":"Enterprise API","count":89},{"language":"default","tag":"Bitnob Business","count":82},{"language":"default","tag":"Courses","count":82},{"language":"default","tag":"Card issuing","count":44},{"language":"default","tag":"Guides","count":43},{"language":"default","tag":"Get started","count":35},{"language":"default","tag":"Bitnob Enterprise","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"playground.css","content":".pg-shell{--pg-bg:rgb(var(--background-light));--pg-fg:rgb(var(--gray-900));--pg-muted:rgb(var(--gray-500));--pg-border:rgb(var(--gray-200));--pg-field-bg:rgb(var(--background-light));--pg-field-border:rgb(var(--gray-300));--pg-placeholder:rgb(var(--gray-400));--pg-hover:rgb(var(--gray-50));--pg-primary:rgb(var(--primary));color-scheme:light;margin:1.5rem 0;border:1px solid var(--pg-border);border-radius:0.875rem;background:var(--pg-bg);overflow:hidden}.dark .pg-shell{--pg-bg:rgb(var(--gray-900));--pg-fg:rgb(var(--gray-100));--pg-muted:rgb(var(--gray-400));--pg-border:rgb(var(--gray-800));--pg-field-bg:rgb(var(--background-dark));--pg-field-border:rgb(var(--gray-800));--pg-placeholder:rgb(var(--gray-500));--pg-hover:rgb(var(--gray-800));--pg-primary:rgb(var(--primary-light));color-scheme:dark}.pg-header{padding:1rem 1.25rem;border-bottom:1px solid var(--pg-border)}.pg-title{font-size:1rem;font-weight:600;color:var(--pg-fg)}.pg-subtitle{margin-top:0.125rem;font-size:0.875rem;color:var(--pg-muted)}.pg-body{padding:1.25rem;display:flex;flex-direction:column;gap:1rem}.pg-label{display:block;font-size:0.875rem;font-weight:500;color:var(--pg-fg);margin-bottom:0.375rem}.pg-input,.pg-select,.pg-textarea{width:100%;border-radius:0.5rem;border:1px solid var(--pg-field-border);background:var(--pg-field-bg);color:var(--pg-fg);padding:0.5rem 0.75rem;font-size:0.875rem;line-height:1.5}.pg-input,.pg-textarea{font-family:ui-monospace,SFMono-Regular,Menlo,monospace}.pg-textarea{resize:vertical}.pg-input::placeholder,.pg-textarea::placeholder{color:var(--pg-placeholder)}.pg-input:focus,.pg-select:focus,.pg-textarea:focus{outline:none;border-color:var(--pg-primary);box-shadow:0 0 0 2px rgb(var(--primary)/0.35)}.pg-row{display:flex;flex-wrap:wrap;align-items:center;gap:0.5rem}.pg-grid{display:grid;grid-template-columns:1fr;gap:1rem}@media (min-width:640px){.pg-grid{grid-template-columns:2fr 1fr}}.pg-btn-primary,.pg-btn-secondary{display:inline-flex;align-items:center;justify-content:center;gap:0.375rem;height:2.25rem;border-radius:0.75rem;padding:0 0.75rem;font-size:0.875rem;font-weight:500;cursor:pointer;transition:opacity .15s,background-color .15s}.pg-btn-primary{background:rgb(var(--primary));color:#fff;border:1px solid transparent}.pg-btn-primary:hover{opacity:.8}.pg-btn-secondary{background:var(--pg-bg);color:var(--pg-fg);border:1px solid var(--pg-border)}.pg-btn-secondary:hover{background:var(--pg-hover)}.pg-btn-primary:disabled,.pg-btn-secondary:disabled{opacity:.5;cursor:not-allowed}.pg-meta{font-size:0.75rem;color:var(--pg-muted)}.pg-check{display:inline-flex;align-items:center;gap:0.5rem;font-size:0.875rem;color:var(--pg-fg)}.pg-note{border-radius:0.5rem;padding:0.5rem 0.75rem;font-size:0.875rem;border:1px solid}.pg-error{border-color:rgb(254 202 202);background:rgb(254 242 242);color:rgb(185 28 28)}.dark .pg-error{border-color:rgb(127 29 29);background:rgb(69 10 10);color:rgb(252 165 165)}.pg-ok{border-color:rgb(167 243 208);background:rgb(236 253 245);color:rgb(4 120 87)}.dark .pg-ok{border-color:rgb(6 78 59);background:rgb(2 44 34);color:rgb(110 231 183)}.pg-warn{border-color:rgb(253 230 138);background:rgb(255 251 235);color:rgb(180 83 9)}.dark .pg-warn{border-color:rgb(120 53 15);background:rgb(69 26 3);color:rgb(253 230 138)}.pg-grid2{display:grid;grid-template-columns:1fr;gap:1rem}@media (min-width:640px){.pg-grid2{grid-template-columns:1fr 1fr}}.pg-grid3{display:grid;grid-template-columns:1fr;gap:0.75rem}@media (min-width:640px){.pg-grid3{grid-template-columns:repeat(3,1fr)}}.pg-between{margin-top:0.5rem;display:flex;align-items:center;justify-content:space-between}.pg-end{margin-top:0.5rem;display:flex;align-items:center;justify-content:flex-end}.pg-wrap{display:flex;flex-wrap:wrap;gap:0.5rem 1rem;padding-top:0.375rem}.pg-strong{font-weight:500;margin-bottom:0.25rem}.pg-file{display:block;width:100%;font-size:0.875rem;color:var(--pg-fg)}.pg-file::file-selector-button{margin-right:0.75rem;height:2.25rem;border-radius:0.75rem;border:0;padding:0 0.75rem;font-size:0.875rem;font-weight:500;color:#fff;background:rgb(var(--primary));cursor:pointer}.pg-checklabel{display:flex;align-items:center;gap:0.5rem;font-size:0.875rem;color:var(--pg-fg);cursor:pointer}.pg-checklabel-tight{display:flex;align-items:center;gap:0.375rem;font-size:0.875rem;color:var(--pg-fg);cursor:pointer}.pg-inline-label{font-size:0.875rem;font-weight:500;color:var(--pg-fg)}.pg-endpad{display:flex;align-items:flex-end;padding-bottom:0.5rem}.pg-tablewrap{overflow-x:auto;border-radius:0.5rem;border:1px solid var(--pg-border)}.pg-table{width:100%;font-size:0.875rem;border-collapse:collapse}.pg-table th{border-bottom:1px solid var(--pg-border);text-align:left;color:var(--pg-muted);font-weight:500;padding:0.5rem 0.75rem}.pg-table td{padding:0.5rem 0.75rem;color:var(--pg-fg)}.pg-table tr+tr td{border-top:1px solid var(--pg-border)}.pg-result-row{display:flex;justify-content:space-between;gap:1rem;font-size:0.875rem;padding:0.25rem 0}.pg-result-key{color:var(--pg-muted)}.pg-result-val{font-family:ui-monospace,SFMono-Regular,Menlo,monospace;color:var(--pg-fg);word-break:break-all}"}],"page":{"pagePath":"api-reference/platform/kytrisk-profiles/get-risk-profile","slug":"/api-reference/platform/kytrisk-profiles/get-risk-profile","pageMetadata":{"title":"Get risk profile","description":"Returns a single KYT risk profile by ID, scoped to the authenticated organization.","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /kyt/risk-profiles/{id}","href":"/api-reference/platform/kytrisk-profiles/get-risk-profile","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a single KYT risk profile by ID, scoped to the authenticated organization.\"\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":{"config":{},"pageMetadata":{"title":"Get risk profile","description":"Returns a single KYT risk profile by ID, scoped to the authenticated organization.","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /kyt/risk-profiles/{id}","href":"/api-reference/platform/kytrisk-profiles/get-risk-profile","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/bitnob/a5987023060b539e/test-playground.js"],"openApiReferenceData":{"operation":{"description":"Returns a single KYT risk profile by ID, scoped to the authenticated organization.","operationId":"getKytRisk-profilesById","parameters":["25ed9839-4954-4bc4-9bd5-fe5fd1417aad","5bc1707d-816a-480f-beb9-0d5a26f809f8"],"responses":{"200":"8e8e134b-9f10-4a98-bf06-4feefad2dc50","400":"fd3ff0c6-2634-4b92-92a3-6a64223ae153","401":"bc34eca8-75eb-4526-9004-80650b7fa98c","403":"a5d6f914-143a-401a-a121-db35dc648ca1","404":"16c5ce27-b3d7-4462-8a47-3e3420fffb68","429":"f384c85b-f4b4-4a9b-91d2-6aa2be40a1f1","500":"fbfa6ee7-c8da-4c76-8292-692fc4214521"},"security":["88b4dfd5-7138-4460-b918-682996f3d314"],"summary":"Get risk profile","tags":["Kyt/risk-profiles"],"method":"get","type":"path","servers":["86022967-0a92-4be6-88af-26a950f3ce7c"],"path":"/kyt/risk-profiles/{id}","baseUrlOptions":["https://api.platform.bitnob.com"],"title":"Get risk profile","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php","go","java"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"25ed9839-4954-4bc4-9bd5-fe5fd1417aad":{"description":"Risk-profile ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"Risk-profile ID","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"5bc1707d-816a-480f-beb9-0d5a26f809f8":{"description":"API version (defaults to the latest supported version if omitted).","in":"header","name":"API-Version","required":false,"schema":{"default":"v1","enum":["v1"],"type":"string","isRequired":false,"description":"API version (defaults to the latest supported version if omitted).","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"8e8e134b-9f10-4a98-bf06-4feefad2dc50":{"content":{"application/json":{"example":{"catchall":{"high":"block","low":"allow","medium":"hold","none":"allow","severe":"block"},"created_at":"2026-05-16T10:30:00Z","id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","is_default":true,"name":"default","object":"risk_profile","rules":[{"categories":"[\"sanctions\"]","direction":"outgoing","exposure_type":"direct","level_actions":{"high":"block","none":"allow","severe":"block"},"max_exposure_usd":"5000","min_exposure_usd":"1000"}],"updated_at":"2026-05-16T10:30:00Z"},"schema":{"properties":{"catchall":{"properties":{"high":{"description":"Action for high-level alerts.","enum":["allow","hold","block","flag"],"example":"block","type":"string","isRequired":true,"uniqueKey":"catchall.high","typeLabel":"enum\u003cstring>"},"low":{"description":"Action for low-level alerts.","enum":["allow","hold","block","flag"],"example":"allow","type":"string","isRequired":true,"uniqueKey":"catchall.low","typeLabel":"enum\u003cstring>"},"medium":{"description":"Action for medium-level alerts.","enum":["allow","hold","block","flag"],"example":"hold","type":"string","isRequired":true,"uniqueKey":"catchall.medium","typeLabel":"enum\u003cstring>"},"none":{"description":"Action for none-level alerts: allow, hold, block, or flag.","enum":["allow","hold","block","flag"],"example":"allow","type":"string","isRequired":true,"uniqueKey":"catchall.none","typeLabel":"enum\u003cstring>"},"severe":{"description":"Action for severe-level alerts.","enum":["allow","hold","block","flag"],"example":"block","type":"string","isRequired":true,"uniqueKey":"catchall.severe","typeLabel":"enum\u003cstring>"}},"required":["none","low","medium","high","severe"],"type":"object","description":"Baseline decision for every alert level, applied to any alert not matched by a rule.","uniqueKey":"catchall","typeLabel":"object"},"created_at":{"description":"When the risk profile was created.","example":"2026-05-16T10:30:00Z","format":"date-time","type":"string","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Unique identifier of the risk profile.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","type":"string","uniqueKey":"id","typeLabel":"string"},"is_default":{"description":"Whether this profile is the organization's active default, applied to screening decisions.","example":true,"type":"boolean","uniqueKey":"is_default","typeLabel":"boolean"},"name":{"description":"Human-readable name of the risk profile.","example":"default","type":"string","uniqueKey":"name","typeLabel":"string"},"object":{"description":"Object type discriminator; always \"risk_profile\".","example":"risk_profile","type":"string","uniqueKey":"object","typeLabel":"string"},"rules":{"description":"Category rules evaluated before the catch-all.","items":{"properties":{"categories":{"description":"Risk categories this rule matches, from the KYT category catalogue (see GET /kyt/categories).","example":"[\"sanctions\"]","items":{"enum":["sanctions","sanctioned_jurisdiction","eu_sanctions","terrorist_financing","child_abuse_material","darknet_market","stolen_funds","ransomware","mixing","illicit_actor"],"type":"string","uniqueKey":"rules.items.[INDEX].categories.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"type":"array","isRequired":true,"uniqueKey":"rules.items.[INDEX].categories","typeLabel":"enum\u003cstring>[]"},"direction":{"description":"Restricts the rule to incoming or outgoing transfers. Omit, or use \"any\", for no direction constraint.","enum":["any","incoming","outgoing"],"example":"outgoing","type":"string","uniqueKey":"rules.items.[INDEX].direction","typeLabel":"enum\u003cstring>"},"exposure_type":{"description":"Restricts the rule to direct or indirect exposure. Omit, or use \"any\", for no exposure constraint.","enum":["direct","indirect","any"],"example":"direct","type":"string","uniqueKey":"rules.items.[INDEX].exposure_type","typeLabel":"enum\u003cstring>"},"level_actions":{"properties":{"high":{"description":"Action for high-level alerts matched by this rule.","enum":["allow","hold","block","flag"],"example":"block","type":"string","uniqueKey":"rules.items.[INDEX].level_actions.high","typeLabel":"enum\u003cstring>"},"low":{"description":"Action for low-level alerts matched by this rule.","enum":["allow","hold","block","flag"],"type":"string","uniqueKey":"rules.items.[INDEX].level_actions.low","typeLabel":"enum\u003cstring>"},"medium":{"description":"Action for medium-level alerts matched by this rule.","enum":["allow","hold","block","flag"],"type":"string","uniqueKey":"rules.items.[INDEX].level_actions.medium","typeLabel":"enum\u003cstring>"},"none":{"description":"Action for none-level alerts matched by this rule.","enum":["allow","hold","block","flag"],"example":"allow","type":"string","uniqueKey":"rules.items.[INDEX].level_actions.none","typeLabel":"enum\u003cstring>"},"severe":{"description":"Action for severe-level alerts matched by this rule.","enum":["allow","hold","block","flag"],"example":"block","type":"string","uniqueKey":"rules.items.[INDEX].level_actions.severe","typeLabel":"enum\u003cstring>"}},"type":"object","description":"Per-level action override for alerts this rule matches. At least one level must be set; any level left unset falls through to the profile catch-all.","uniqueKey":"rules.items.[INDEX].level_actions","typeLabel":"object"},"max_exposure_usd":{"description":"Inclusive upper bound (USD) on alert exposure for the rule to match, as a decimal string; an alert at exactly this amount matches. Omit for no maximum.","example":"5000","type":"string","uniqueKey":"rules.items.[INDEX].max_exposure_usd","typeLabel":"string"},"min_exposure_usd":{"description":"Inclusive lower bound (USD) on alert exposure for the rule to match, as a decimal string; an alert at exactly this amount matches. Omit for no minimum.","example":"1000","type":"string","uniqueKey":"rules.items.[INDEX].min_exposure_usd","typeLabel":"string"}},"required":["categories"],"type":"object","uniqueKey":"rules.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"rules","typeLabel":"object[]"},"updated_at":{"description":"When the risk profile was last updated.","example":"2026-05-16T10:30:00Z","format":"date-time","type":"string","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"catchall":{"high":"block","low":"allow","medium":"hold","none":"allow","severe":"block"},"created_at":"2026-05-16T10:30:00Z","id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","is_default":true,"name":"default","object":"risk_profile","rules":[{"categories":"[\"sanctions\"]","direction":"outgoing","exposure_type":"direct","level_actions":{"high":"block","none":"allow","severe":"block"},"max_exposure_usd":"5000","min_exposure_usd":"1000"}],"updated_at":"2026-05-16T10:30:00Z"}}},"exampleType":"examples"}},"description":"Success","headers":{"X-RateLimit-Limit":{"description":"Requests permitted in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix time (seconds) at which the rate-limit window resets.","schema":{"type":"integer"}},"X-RateLimit-Scope":{"description":"Scope the rate limit was applied at: key for authenticated API traffic, or ip for unauthenticated/failed-auth traffic. RPC proxy traffic is limited separately (per second, per organization) and is not bucketed here.","schema":{"type":"string"}},"X-Request-Id":{"description":"Unique id for this request; quote it in support requests.","schema":{"type":"string"}}},"exampleType":"examples"},"fd3ff0c6-2634-4b92-92a3-6a64223ae153":{"content":{"application/json":{"schema":{"description":"Standard error envelope.","properties":{"error":{"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"additionalProperties":true,"type":"object","uniqueKey":"error.details","typeLabel":"object"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":{},"message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Invalid request","exampleType":"generated"},"bc34eca8-75eb-4526-9004-80650b7fa98c":{"content":{"application/json":{"schema":{"description":"Standard error envelope.","properties":{"error":{"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"additionalProperties":true,"type":"object","uniqueKey":"error.details","typeLabel":"object"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":{},"message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Authentication required","exampleType":"generated"},"a5d6f914-143a-401a-a121-db35dc648ca1":{"content":{"application/json":{"schema":{"description":"Standard error envelope.","properties":{"error":{"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"additionalProperties":true,"type":"object","uniqueKey":"error.details","typeLabel":"object"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":{},"message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Insufficient permissions","exampleType":"generated"},"16c5ce27-b3d7-4462-8a47-3e3420fffb68":{"content":{"application/json":{"schema":{"description":"Standard error envelope.","properties":{"error":{"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"additionalProperties":true,"type":"object","uniqueKey":"error.details","typeLabel":"object"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":{},"message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Not found","exampleType":"generated"},"f384c85b-f4b4-4a9b-91d2-6aa2be40a1f1":{"content":{"application/json":{"schema":{"description":"Standard error envelope.","properties":{"error":{"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"additionalProperties":true,"type":"object","uniqueKey":"error.details","typeLabel":"object"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":{},"message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Rate limit exceeded","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"exampleType":"generated"},"fbfa6ee7-c8da-4c76-8292-692fc4214521":{"content":{"application/json":{"schema":{"description":"Standard error envelope.","properties":{"error":{"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"additionalProperties":true,"type":"object","uniqueKey":"error.details","typeLabel":"object"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","details":{},"message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Internal server error","exampleType":"generated"}},"security":{"88b4dfd5-7138-4460-b918-682996f3d314":{"ApiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"86022967-0a92-4be6-88af-26a950f3ce7c":{"description":"Production","url":"https://api.platform.bitnob.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-collections/swagger/bitnob-platform.openapi.json"},"subdomain":"bitnob","siteName":"Bitnob","title":"Get risk profile - Bitnob","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T15:31:36.801Z","originalFileLocation":"api-reference/platform/kytrisk-profiles/get-risk-profile.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=\"Returns a single KYT risk profile by ID, scoped to the authenticated organization.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bitnob\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_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/bitnob/eBFTVQiF9mXbjiUl/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get risk profile - Bitnob\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single KYT risk profile by ID, scoped to the authenticated organization.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bitnob Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bitnob.mintlify.site/_mintlify/api/og/v2?division=KYT\u0026amp;title=Get+risk+profile\u0026amp;description=Returns+a+single+KYT+risk+profile+by+ID%2C+scoped+to+the+authenticated+organization.\u0026amp;theme=1bbb91a73b5fc150fde1eea2\u0026amp;signature=d24bfdea8f37bca4006667ceb5327ce6ccfce09ad0a6d1187f24a8ddc26450aa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get risk profile - Bitnob\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single KYT risk profile by ID, scoped to the authenticated organization.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bitnob.mintlify.site/_mintlify/api/og/v2?division=KYT\u0026amp;title=Get+risk+profile\u0026amp;description=Returns+a+single+KYT+risk+profile+by+ID%2C+scoped+to+the+authenticated+organization.\u0026amp;theme=1bbb91a73b5fc150fde1eea2\u0026amp;signature=d24bfdea8f37bca4006667ceb5327ce6ccfce09ad0a6d1187f24a8ddc26450aa\">\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/bitnob/eBFTVQiF9mXbjiUl/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bitnob\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00A57F\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@bitnob\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/platform/kytrisk-profiles/get-risk-profile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://bitnob.com/#organization\",\"name\":\"Bitnob\",\"url\":\"https://bitnob.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://bitnob.com/bitnob-logo.png\"},\"sameAs\":[\"https://x.com/bitnob\",\"https://twitter.com/Bitnob_Official\",\"https://linkedin.com/company/bitnob\",\"https://github.com/bitnob\",\"https://instagram.com/Bitnob\",\"https://youtube.com/@bitnob\",\"https://facebook.com/bitnob\",\"https://tiktok.com/@bitnob\"]},{\"@type\":\"WebSite\",\"@id\":\"https://www.bitnob.dev#website\",\"name\":\"Bitnob\",\"url\":\"https://www.bitnob.dev\",\"publisher\":{\"@id\":\"https://bitnob.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile#webpage\",\"url\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile\",\"name\":\"Get risk profile\",\"description\":\"Returns a single KYT risk profile by ID, scoped to the authenticated organization.\",\"dateModified\":\"2026-11-05T15:31:36.801Z\",\"isPartOf\":{\"@id\":\"https://www.bitnob.dev#website\"},\"breadcrumb\":{\"@id\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"KYT\",\"item\":\"https://www.bitnob.dev/api-reference/platform/kytcategories/list-kyt-categories\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get risk profile\",\"item\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile#apireference\",\"headline\":\"Get risk profile\",\"name\":\"Get risk profile\",\"description\":\"Returns a single KYT risk profile by ID, scoped to the authenticated organization.\",\"url\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile\",\"mainEntityOfPage\":{\"@id\":\"https://www.bitnob.dev/api-reference/platform/kytrisk-profiles/get-risk-profile#webpage\"},\"dateModified\":\"2026-11-05T15:31:36.801Z\",\"publisher\":{\"@id\":\"https://bitnob.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.bitnob.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bitnob\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bitnob","nav":{"global":null,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Docs","icon":"book-open","dropdowns":[{"dropdown":"Bitnob Business","icon":"bolt","description":"Payouts, cards, trading, and virtual accounts.","groups":[{"group":"Get started","icon":"rocket","expanded":true,"pages":[{"title":"Introduction to the Bitnob APIs","sidebarTitle":"Introduction","href":"/docs/getting-started/overview"},{"title":"Set up your account","href":"/docs/getting-started/account-setup"},{"title":"Bitnob Business API quickstart","sidebarTitle":"Quickstart","href":"/docs/getting-started/quickstart"},{"group":"Concepts","pages":[{"title":"Core concepts and architecture","href":"/docs/getting-started/core-concepts-and-architecture"},{"title":"Currencies and amounts","href":"/docs/getting-started/core-concepts-and-architecture/currencies-and-amounts"},{"title":"Fees and limits by product","sidebarTitle":"Fees and limits","href":"/docs/getting-started/fees-and-limits"},{"title":"Which KYC endpoint to use","sidebarTitle":"Which KYC endpoint","href":"/docs/getting-started/which-kyc-endpoint"}]},{"group":"Build reliably","pages":[{"title":"API keys and credential security","href":"/docs/getting-started/api-best-practices/api-keys-and-credentials"},{"title":"Idempotency and references","href":"/docs/getting-started/api-best-practices/idempotency-and-reference-integrity"},{"title":"Webhooks and event handling","href":"/docs/getting-started/api-best-practices/webhook-best-practices"},{"title":"Errors and retries","href":"/docs/getting-started/api-best-practices/errors-and-retries"},{"title":"Quote lifecycle and expiry","href":"/docs/getting-started/api-best-practices/quote-expiry-and-transaction-windows"},{"title":"Test in sandbox","href":"/docs/getting-started/api-best-practices/simulating-flows-and-testing-in-sandbox"},{"title":"Observability, logging, and traceability","href":"/docs/getting-started/api-best-practices/observability-logging-and-traceability"}]}]},{"group":"Bitcoin","icon":"bitcoin","pages":[{"title":"Bitcoin and Lightning on Bitnob","sidebarTitle":"Overview","href":"/docs/bitcoin/overview"},{"group":"Concepts","pages":[{"title":"LNURL and Lightning addresses","href":"/docs/bitcoin/lnurl-and-lightning-addresses"}]},{"group":"Get started","pages":[{"title":"Send bitcoin on-chain or over Lightning","href":"/docs/bitcoin/send-bitcoin"}]},{"group":"Guides","pages":[{"title":"Issue addresses and Lightning invoices","href":"/docs/bitcoin/issuing-bitcoin-addresses-and-lightning-invoices"},{"title":"Test Lightning payments in sandbox","sidebarTitle":"Test Lightning in sandbox","href":"/docs/bitcoin/test-lightning-in-sandbox"}]},{"group":"Reference","pages":[{"title":"Confirmations and webhook events","href":"/docs/bitcoin/confirmations-and-webhook-events"}]}]},{"group":"Stablecoins","icon":"coins","pages":[{"title":"Stablecoins on Bitnob","sidebarTitle":"Overview","href":"/docs/stablecoins/overview"},{"group":"Concepts","pages":[{"title":"How stablecoins work on Bitnob","href":"/docs/stablecoins/key-concepts"},{"title":"Why multiple chains","href":"/docs/stablecoins/why-support-stablecoins-on-multiple-chains"}]},{"group":"Get started","pages":[{"title":"Accept USDT and settle in naira","href":"/docs/stablecoins/accept-usdt-and-settle-in-naira"}]},{"group":"Guides","pages":[{"title":"Set up for stablecoins","href":"/docs/stablecoins/getting-started-with-stablecoins"},{"title":"Issue deposit addresses","href":"/docs/stablecoins/issuing-stablecoin-addresses"},{"title":"Receive deposits","href":"/docs/stablecoins/receiving-stablecoin-deposits"},{"title":"Send stablecoins","href":"/docs/stablecoins/sending-stablecoins"},{"title":"Transfer between wallets","href":"/docs/stablecoins/internal-wallet-to-wallet-transfers"},{"title":"Receive stablecoin webhooks","href":"/docs/stablecoins/webhooks"},{"title":"Handle transfer failures","href":"/docs/stablecoins/error-handling-and-failure-scenarios"},{"title":"Reconcile balances","href":"/docs/stablecoins/stablecoin-reconciliation-and-ledger-integrity-guide"}]},{"group":"Reference","pages":[{"title":"Stablecoin address webhook events","sidebarTitle":"Address webhook events","href":"/docs/stablecoins/address-webhook-events"},{"title":"Withdrawal webhook events","sidebarTitle":"Withdrawal webhook events","href":"/docs/stablecoins/withdrawal-webhook-events"},{"title":"Supported stablecoin chains and tokens","sidebarTitle":"Supported chains","href":"/docs/stablecoins/supported-chains"}]}]},{"group":"Trading","icon":"arrow-right-arrow-left","pages":[{"title":"Trading and currency conversion","sidebarTitle":"Overview","href":"/docs/trading/overview"},{"group":"Concepts","pages":[{"title":"How trading works","href":"/docs/trading/how-trading-works"}]},{"group":"Get started","pages":[{"title":"Swap bitcoin to USDT","href":"/docs/trading/swap-bitcoin-to-usdt"}]},{"group":"Guides","pages":[{"title":"Create a quote","href":"/docs/trading/create-quote"},{"title":"Execute a trade","href":"/docs/trading/execute-trade"},{"title":"Track orders and history","href":"/docs/trading/trade-status-and-history"},{"title":"Receive trade webhooks","href":"/docs/trading/trade-webhooks"},{"title":"Handle trading failures","href":"/docs/trading/error-handling-patterns"}]},{"group":"Reference","pages":[{"title":"Trade statuses and webhook events","sidebarTitle":"Statuses and webhook events","href":"/docs/trading/statuses-and-webhook-events"}]}]},{"group":"Payouts","icon":"money-bill-transfer","pages":[{"title":"Payouts to bank accounts and mobile money","sidebarTitle":"Overview","href":"/docs/payouts/overview"},{"group":"Concepts","pages":[{"title":"How payouts settle","href":"/docs/payouts/settlement-models"},{"title":"The payout lifecycle","href":"/docs/payouts/payouts-lifecycle"}]},{"group":"Get started","pages":[{"title":"Send your first payout","href":"/docs/payouts/send-your-first-payout"}]},{"group":"Guides","pages":[{"title":"Validate a beneficiary","href":"/docs/payouts/validate-a-beneficiary"},{"title":"Send a SWIFT payout","href":"/docs/payouts/swift-payout"},{"title":"Receive payout webhooks","href":"/docs/payouts/webhook-payout"},{"title":"Handle payout failures","href":"/docs/payouts/error-handling"},{"title":"Payouts API integration guide","href":"/api-reference/payouts/usage-example"},{"title":"The Trip timeline","href":"/docs/payouts/understanding-trip-timeline"},{"title":"Payout incident postmortem template","href":"/docs/payouts/payout-incident-postmortem"},{"title":"Troubleshooting: payout stuck in pending","href":"/docs/payouts/troubleshoot-payout-stuck"},{"title":"Troubleshooting: webhooks not received","href":"/docs/payouts/troubleshoot-webhooks-not-received"}]},{"group":"Reference","pages":[{"title":"Payout statuses and webhook events","sidebarTitle":"Statuses and webhook events","href":"/docs/payouts/statuses-and-webhook-events"},{"title":"Payout webhook events","sidebarTitle":"Webhook events","href":"/docs/payouts/webhook-events"},{"title":"Supported currencies and rails","href":"/docs/payouts/supported-currencies"},{"group":"Corridors","pages":[{"title":"Corridor behavior","href":"/docs/payouts/corridor-specific-behavior"},{"title":"Nigeria","href":"/docs/payouts/corridor-specific-behavior/nigeria-payout"},{"title":"Ghana","href":"/docs/payouts/corridor-specific-behavior/ghana-payout"},{"title":"Kenya","href":"/docs/payouts/corridor-specific-behavior/kenya-payout"}]},{"title":"Payout glossary","sidebarTitle":"Glossary","href":"/docs/payouts/glossary-terms"}]}]},{"group":"Card issuing","icon":"credit-card","pages":[{"title":"Virtual card issuing on Bitnob","sidebarTitle":"Overview","href":"/docs/card-issuing/overview"},{"group":"Concepts","pages":[{"title":"How card issuance works","href":"/docs/card-issuing/card-issuance"}]},{"group":"Get started","pages":[{"title":"Issue your first card","href":"/docs/card-issuing/issue-your-first-card"}]},{"group":"Guides","pages":[{"title":"Verify cardholders with Card KYC","sidebarTitle":"Card KYC","href":"/docs/card-issuing/card-kyc"},{"title":"Fund a card","href":"/docs/card-issuing/card-funding"},{"title":"Freeze, unfreeze, or terminate a card","href":"/docs/card-issuing/card-status-management"},{"title":"Set card spending limits","sidebarTitle":"Set spending limits","href":"/docs/card-issuing/spending-limits"},{"title":"Monitor card transactions","href":"/docs/card-issuing/transaction-monitoring"},{"title":"Receive card webhooks","href":"/docs/card-issuing/receive-card-webhooks"},{"title":"Decrypt card secured details","sidebarTitle":"Decrypt card details","href":"/docs/card-issuing/decrypt-card-details"}]},{"group":"Reference","pages":[{"title":"Webhook events","href":"/docs/card-issuing/webhooks"},{"title":"Virtual card webhook events","sidebarTitle":"Webhook payloads","href":"/docs/card-issuing/webhook-payloads"},{"title":"Fees and decline rules","href":"/docs/card-issuing/card-fees"},{"title":"Virtual card glossary","sidebarTitle":"Glossary","href":"/docs/card-issuing/virtual-card-glossary"}]}]},{"group":"Virtual accounts","icon":"building-columns","pages":[{"title":"NGN virtual accounts on Bitnob","sidebarTitle":"Overview","href":"/docs/virtual-accounts/overview"},{"group":"Get started","pages":[{"title":"Set up NGN virtual accounts","sidebarTitle":"Set up virtual accounts","href":"/docs/virtual-accounts/set-up-virtual-accounts"},{"title":"Virtual account deposit webhook","sidebarTitle":"Deposit webhook","href":"/docs/virtual-accounts/deposit-webhook"}]}]}]},{"dropdown":"Bitnob Enterprise","icon":"wallet","description":"Policy-governed wallets.","groups":[{"group":"Get started","icon":"rocket","expanded":true,"pages":[{"title":"Bitnob Enterprise API overview","sidebarTitle":"Introduction","href":"/docs/platform/overview"},{"title":"Set up your Bitnob Enterprise account","sidebarTitle":"Set up your account","href":"/docs/platform/account-setup"},{"title":"Bitnob Enterprise API quickstart","sidebarTitle":"Quickstart","href":"/docs/platform/quickstart"},{"group":"Concepts","pages":[{"title":"Bitnob Enterprise core concepts","sidebarTitle":"Core concepts","href":"/docs/platform/core-concepts"}]},{"group":"Build reliably","pages":[{"title":"Bitnob Enterprise API best practices","sidebarTitle":"Best practices","href":"/docs/platform/best-practices"}]}]},{"group":"Policies","icon":"shield-check","pages":[{"title":"Transaction policies on Bitnob Enterprise","sidebarTitle":"Overview","href":"/docs/platform/policies/overview"},{"group":"Concepts","pages":[{"title":"How Bitnob Enterprise evaluates policy rules","sidebarTitle":"How evaluation works","href":"/docs/platform/policies/how-policy-evaluation-works"},{"title":"Policy lifecycle and quorum approval","sidebarTitle":"Lifecycle and quorum","href":"/docs/platform/policies/policy-lifecycle-and-quorum"}]},{"group":"Get started","pages":[{"title":"Write and activate your first Enterprise policy","sidebarTitle":"Write your first policy","href":"/docs/platform/policies/write-and-activate-your-first-policy"}]},{"group":"Guides","pages":[{"title":"Require approval for high-value transfers","sidebarTitle":"Require approval","href":"/docs/platform/policies/require-approval-for-high-value-transfers"},{"title":"Delay large transfers with a policy time lock","sidebarTitle":"Add a time lock","href":"/docs/platform/policies/delay-large-transfers-with-a-time-lock"},{"title":"Test policy rules with dry-run evaluation","sidebarTitle":"Test with dry runs","href":"/docs/platform/policies/test-rules-with-dry-run-evaluation"},{"title":"Change an enforced Bitnob Enterprise policy","sidebarTitle":"Change a live policy","href":"/docs/platform/policies/change-an-enforced-policy"},{"title":"Handle transactions held or rejected by policy","sidebarTitle":"Handle held transactions","href":"/docs/platform/policies/handle-held-and-rejected-transactions"}]},{"group":"Reference","pages":[{"title":"Bitnob Enterprise policy rule reference","sidebarTitle":"Rule reference","href":"/docs/platform/policies/rule-reference"},{"title":"Policy statuses, errors, and webhook events","sidebarTitle":"Statuses and events","href":"/docs/platform/policies/statuses-and-webhook-events"}]}]},{"group":"Gas sponsorship","icon":"gas-pump","pages":[{"title":"Gas sponsorship on Bitnob Enterprise","sidebarTitle":"Overview","href":"/docs/platform/gas-sponsorship/overview"},{"group":"Concepts","pages":[{"title":"How Bitnob Enterprise gas stations work","sidebarTitle":"How gas stations work","href":"/docs/platform/gas-sponsorship/how-gas-stations-work"},{"title":"How Bitnob sponsored transfers work","sidebarTitle":"How sponsored transfers work","href":"/docs/platform/gas-sponsorship/how-sponsored-transfers-work"},{"title":"What users sign for a sponsored transfer, by chain","sidebarTitle":"Signing by chain","href":"/docs/platform/gas-sponsorship/signing-by-chain"}]},{"group":"Get started","pages":[{"title":"Set up a gas station for your Enterprise wallets","sidebarTitle":"Set up a gas station","href":"/docs/platform/gas-sponsorship/set-up-a-gas-station"},{"title":"Send your first sponsored transfer on Solana","sidebarTitle":"Send your first transfer","href":"/docs/platform/gas-sponsorship/send-your-first-sponsored-transfer"}]},{"group":"Guides","pages":[{"title":"Sign sponsored transfers on EVM chains","sidebarTitle":"Sign on EVM chains","href":"/docs/platform/gas-sponsorship/sign-on-evm-chains"},{"title":"Sign sponsored USDT transfers on Tron","sidebarTitle":"Sign on Tron","href":"/docs/platform/gas-sponsorship/sign-on-tron"},{"title":"Charge your own fee on sponsored transfers","sidebarTitle":"Charge a partner fee","href":"/docs/platform/gas-sponsorship/charge-a-partner-fee"},{"title":"Sweep a full stablecoin balance with gross mode","sidebarTitle":"Sweep a full balance","href":"/docs/platform/gas-sponsorship/sweep-a-full-balance"},{"title":"Handle sponsored transfer failures and expiry","sidebarTitle":"Handle failures","href":"/docs/platform/gas-sponsorship/handle-failures-and-expiry"}]},{"group":"Reference","pages":[{"title":"Gas station fields, health, and webhook events","sidebarTitle":"Gas station reference","href":"/docs/platform/gas-sponsorship/gas-station-reference"},{"title":"Sponsored transfer statuses, errors, and tracking","sidebarTitle":"Sponsored transfer statuses","href":"/docs/platform/gas-sponsorship/statuses-errors-and-events"}]}]},{"group":"Bitcoin","icon":"bitcoin","pages":[{"group":"Concepts","pages":[{"title":"Custody models","href":"/docs/bitcoin/custody-models"},{"title":"UTXO management","href":"/docs/bitcoin/utxo-management-introduction"},{"title":"Fees and confirmation strategy","href":"/docs/bitcoin/fee-market-and-transaction-strategies"}]},{"group":"Guides","pages":[{"title":"Run business-managed custody","href":"/docs/bitcoin/business-managed-non-custodial-bitcoin-wallets"},{"title":"Build self-custodial wallets","href":"/docs/bitcoin/user-managed-self-custodial-wallets"}]}]},{"group":"Use cases","icon":"briefcase","pages":[{"title":"Exchange integration guide","href":"/docs/platform/exchange-integration-guide"}]}]}]},{"tab":"Business API","icon":"code","pages":[{"title":"Business API","href":"/api-reference/authentication/authentication"}]},{"tab":"Enterprise API","icon":"wallet","groups":[{"group":"Get started","icon":"rocket","expanded":true,"pages":[{"title":"Bitnob Enterprise API authentication","sidebarTitle":"Authentication","href":"/docs/platform/authentication"},{"title":"Making Bitnob Enterprise API requests","sidebarTitle":"Making requests","href":"/docs/platform/making-requests"},{"title":"Bitnob Enterprise API webhooks","sidebarTitle":"Webhooks","href":"/docs/platform/webhooks"}]},{"group":"Meta","icon":"circle-info","expanded":true,"pages":[{"title":"Get API key info","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /me","href":"/api-reference/platform/meta/get-api-key-info"}]},{"group":"Assets","icon":"cubes","expanded":true,"pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /assets","href":"/api-reference/platform/assets/list-assets"},{"title":"List chains","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /assets/chains","href":"/api-reference/platform/assets/list-chains"},{"title":"Get asset","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /assets/{id}","href":"/api-reference/platform/assets/get-asset"}]},{"group":"Vaults","icon":"vault","expanded":true,"pages":[{"title":"List vaults","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /vaults","href":"/api-reference/platform/vaults/list-vaults"},{"title":"Get vault","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /vaults/{id}","href":"/api-reference/platform/vaults/get-vault"}]},{"group":"Wallets","icon":"layer-group","expanded":true,"pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets","href":"/api-reference/platform/wallets/list-wallets"},{"title":"Create wallet","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /wallets","href":"/api-reference/platform/wallets/create-wallet"},{"title":"Get wallet","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/{id}","href":"/api-reference/platform/wallets/get-wallet"},{"title":"Update wallet","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json patch /wallets/{id}","href":"/api-reference/platform/wallets/update-wallet"},{"title":"List wallet addresses","deprecated":null,"version":null,"sidebarTitle":"List addresses","openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/{id}/addresses","href":"/api-reference/platform/wallets/list-addresses"},{"title":"Create address","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /wallets/{id}/addresses","href":"/api-reference/platform/wallets/create-address"},{"title":"Get address","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/{id}/addresses/{address_id}","href":"/api-reference/platform/wallets/get-address"},{"title":"List wallet balances","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/{id}/balances","href":"/api-reference/platform/wallets/list-wallet-balances"},{"title":"List signing audit logs","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/sign-logs","href":"/api-reference/platform/wallets/list-signing-audit-logs"},{"title":"Get wallet asset balance","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/{id}/balances/{asset_id}","href":"/api-reference/platform/wallets/get-wallet-asset-balance"},{"title":"Sign payload","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /wallets/{id}/sign","href":"/api-reference/platform/wallets/sign-payload"},{"title":"List wallet UTXOs","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /wallets/{id}/utxos","href":"/api-reference/platform/wallets/list-wallet-utxos"}]},{"group":"Transactions","icon":"receipt","expanded":true,"pages":[{"title":"List transactions across wallets","deprecated":null,"version":null,"sidebarTitle":"List transactions","openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /transactions","href":"/api-reference/platform/transactions/list-transactions"},{"title":"Create transaction","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /transactions","href":"/api-reference/platform/transactions/create-transaction"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /transactions/{id}","href":"/api-reference/platform/transactions/get-transaction"},{"title":"Estimate transaction fee","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /transactions/estimate-fee","href":"/api-reference/platform/transactions/estimate-transaction-fee"}]},{"group":"Gas stations","icon":"gas-pump","expanded":true,"pages":[{"title":"List gas stations","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /gasstations","href":"/api-reference/platform/gasstations/list-gas-stations"},{"title":"Create gas station","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /gasstations","href":"/api-reference/platform/gasstations/create-gas-station"},{"title":"Get gas station","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /gasstations/{id}","href":"/api-reference/platform/gasstations/get-gas-station"},{"title":"Update gas station","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json patch /gasstations/{id}","href":"/api-reference/platform/gasstations/update-gas-station"},{"title":"Refill gas station","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /gasstations/{id}/refill","href":"/api-reference/platform/gasstations/refill-gas-station"},{"title":"Sponsor and broadcast external Tron transaction","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /gasstations/{id}/sponsor-broadcast","href":"/api-reference/platform/gasstations/sponsor-and-broadcast-external-tron-transaction"}]},{"group":"Sponsored transfers","pages":[{"title":"List sponsored transfers","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /sponsored-transfers","href":"/api-reference/platform/sponsored-transfers/list-sponsored-transfers"},{"title":"Create sponsored transfer (quote)","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /sponsored-transfers","href":"/api-reference/platform/sponsored-transfers/create-sponsored-transfer-quote"},{"title":"Get sponsored transfer","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /sponsored-transfers/{id}","href":"/api-reference/platform/sponsored-transfers/get-sponsored-transfer"},{"title":"Submit signature(s)","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /sponsored-transfers/{id}/submit","href":"/api-reference/platform/sponsored-transfers/submit-signatures"}]},{"group":"Consolidation","pages":[{"title":"Delete consolidation rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json delete /consolidation/rules/{id}","href":"/api-reference/platform/meta/delete-consolidation-rule"},{"title":"Get consolidation rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /consolidation/rules/{id}","href":"/api-reference/platform/meta/get-consolidation-rule"},{"title":"Update consolidation rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json patch /consolidation/rules/{id}","href":"/api-reference/platform/meta/update-consolidation-rule"},{"title":"Disable consolidation rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /consolidation/rules/{id}/disable","href":"/api-reference/platform/meta/disable-consolidation-rule"},{"title":"Enable consolidation rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /consolidation/rules/{id}/enable","href":"/api-reference/platform/meta/enable-consolidation-rule"},{"title":"Run consolidation rule now","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /consolidation/rules/{id}/run","href":"/api-reference/platform/meta/run-consolidation-rule-now"},{"title":"List consolidation runs for a rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /consolidation/rules/{id}/runs","href":"/api-reference/platform/meta/list-consolidation-runs-for-a-rule"},{"title":"Get consolidation run","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /consolidation/runs/{id}","href":"/api-reference/platform/meta/get-consolidation-run"},{"title":"List sweeps for a consolidation run","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /consolidation/runs/{id}/sweeps","href":"/api-reference/platform/meta/list-sweeps-for-a-consolidation-run"},{"title":"List consolidation rules for a vault","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /vaults/{vault_id}/consolidation/rules","href":"/api-reference/platform/meta/list-consolidation-rules-for-a-vault"},{"title":"Create consolidation rule","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /vaults/{vault_id}/consolidation/rules","href":"/api-reference/platform/meta/create-consolidation-rule"}]},{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /policies","href":"/api-reference/platform/policies/list-policies"},{"title":"Create draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /policies","href":"/api-reference/platform/policies/create-draft-policy"},{"title":"Dry-run policy evaluation","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /policies/evaluate","href":"/api-reference/platform/policies/dry-run-policy-evaluation"},{"title":"Get quorum policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /policies/quorum","href":"/api-reference/platform/policies/get-quorum-policy"},{"title":"Get policy schema","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /policies/schema","href":"/api-reference/platform/policies/get-policy-schema"},{"title":"Validate in-flight rule array","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /policies/validate","href":"/api-reference/platform/policies/validate-in-flight-rule-array"},{"title":"Delete draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json delete /policies/{id}","href":"/api-reference/platform/policies/delete-draft-policy"},{"title":"Get policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /policies/{id}","href":"/api-reference/platform/policies/get-policy"},{"title":"Update draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json put /policies/{id}","href":"/api-reference/platform/policies/update-draft-policy"},{"title":"Activate policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /policies/{id}/activate","href":"/api-reference/platform/policies/activate-policy"},{"title":"Get policy audit log","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /policies/{id}/audit","href":"/api-reference/platform/policies/get-policy-audit-log"},{"title":"Add rule to draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /policies/{id}/rules","href":"/api-reference/platform/policies/add-rule-to-draft-policy"},{"title":"Remove rule from draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json delete /policies/{id}/rules/{rule_id}","href":"/api-reference/platform/policies/remove-rule-from-draft-policy"},{"title":"Update rule on draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json put /policies/{id}/rules/{rule_id}","href":"/api-reference/platform/policies/update-rule-on-draft-policy"},{"title":"Validate stored draft policy","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /policies/{id}/validate","href":"/api-reference/platform/policies/validate-stored-draft-policy"}]},{"group":"KYT","pages":[{"title":"List KYT categories","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /kyt/categories","href":"/api-reference/platform/kytcategories/list-kyt-categories"},{"title":"List risk profiles","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /kyt/risk-profiles","href":"/api-reference/platform/kytrisk-profiles/list-risk-profiles"},{"title":"Create risk profile","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /kyt/risk-profiles","href":"/api-reference/platform/kytrisk-profiles/create-risk-profile"},{"title":"Get the default risk profile","description":"Returns the organization's active default risk profile, the profile applied to every KYT screening decision. If the organization has not created a profile yet, one is created automatically with a safe baseline and returned: the catch-all allows none and low, holds medium for review, and blocks high and severe, plus built-in rules that block sanctioned and other prohibited categories at every alert level. Custom profiles can also assign allow, hold, block, or flag (credit but flag for review) to any alert level; the seeded default above does not use flag.","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /kyt/risk-profiles/default","href":"/api-reference/platform/kytrisk-profiles/get-the-default-risk-profile"},{"title":"Get risk profile","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /kyt/risk-profiles/{id}","href":"/api-reference/platform/kytrisk-profiles/get-risk-profile"},{"title":"Update risk profile","description":"Updates an existing KYT risk profile. Only the fields you supply are changed. A supplied `catchall` must be complete (all five alert levels); a supplied `rules` array replaces the existing rule set entirely and is re-checked for conflicts.","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json put /kyt/risk-profiles/{id}","href":"/api-reference/platform/kytrisk-profiles/update-risk-profile"}]},{"group":"Insights","pages":[{"title":"Estimate network fees","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /insights/estimate-network-fees","href":"/api-reference/platform/insightsestimate-network-fees/estimate-network-fees"}]},{"group":"Users","pages":[{"title":"List approver candidates","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /users/approver-candidates","href":"/api-reference/platform/users/list-approver-candidates"}]},{"group":"Subscriptions","icon":"bell","expanded":true,"pages":[{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /subscriptions","href":"/api-reference/platform/subscriptions/list-subscriptions"},{"title":"Create subscription","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /subscriptions","href":"/api-reference/platform/subscriptions/create-subscription"},{"title":"List subscription delivery events","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /subscriptions/events","href":"/api-reference/platform/subscriptions/list-subscription-delivery-events"},{"title":"Get subscription delivery event","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /subscriptions/events/{id}","href":"/api-reference/platform/subscriptions/get-subscription-delivery-event"},{"title":"Retry subscription delivery","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /subscriptions/events/{id}/retry","href":"/api-reference/platform/subscriptions/retry-subscription-delivery"},{"title":"Delete subscription","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json delete /subscriptions/{id}","href":"/api-reference/platform/subscriptions/delete-subscription"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /subscriptions/{id}","href":"/api-reference/platform/subscriptions/get-subscription"},{"title":"Update subscription","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json patch /subscriptions/{id}","href":"/api-reference/platform/subscriptions/update-subscription"},{"title":"Rotate subscription signing secret","deprecated":null,"version":null,"sidebarTitle":"Rotate signing secret","openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /subscriptions/{id}/rotate-secret","href":"/api-reference/platform/subscriptions/rotate-signing-secret"}]},{"group":"Webhooks","icon":"satellite-dish","expanded":true,"pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /webhooks","href":"/api-reference/platform/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /webhooks","href":"/api-reference/platform/webhooks/create-webhook"},{"title":"List webhook delivery events","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /webhooks/events","href":"/api-reference/platform/webhooks/list-webhook-delivery-events"},{"title":"Get webhook delivery event","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /webhooks/events/{id}","href":"/api-reference/platform/webhooks/get-webhook-delivery-event"},{"title":"Retry webhook delivery","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /webhooks/events/{id}/retry","href":"/api-reference/platform/webhooks/retry-webhook-delivery"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json delete /webhooks/{id}","href":"/api-reference/platform/webhooks/delete-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /webhooks/{id}","href":"/api-reference/platform/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json patch /webhooks/{id}","href":"/api-reference/platform/webhooks/update-webhook"},{"title":"Rotate webhook signing secret","deprecated":null,"version":null,"sidebarTitle":"Rotate signing secret","openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /webhooks/{id}/rotate-secret","href":"/api-reference/platform/webhooks/rotate-signing-secret"},{"title":"List supported event types","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json get /webhooks/event-types","href":"/api-reference/platform/webhooks/list-supported-event-types"}]},{"group":"RPC","icon":"network-wired","expanded":true,"pages":[{"title":"Execute RPC call","deprecated":null,"version":null,"openapi":"/api-collections/swagger/bitnob-platform.openapi.json post /rpc/{chain_network}","href":"/api-reference/platform/rpc/execute-rpc-call"}]}]},{"tab":"Playground","icon":"flask","pages":[{"title":"Playground","href":"/docs/playground/overview"}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Learn","href":"/learn/overview"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get risk profile - Bitnob","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}