{ "success": true, "data": { "policy": { "mode": "REQUIRED", "validityDays": 30, "autoIssue": false, "autoIssueMaxAmount": null, "frameworkValidityDays": null, "requestAccess": "ANY", "source": "MANUAL", "standingPolicyId": null, "setByWallet": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab", "setByThisInstance": true, "updatedAt": "2026-11-21T15:40:02.114Z", "enforcement": "BACKEND_CHECK", "notice": "REQUIRED is checked by the Trusset backend before it builds an open or borrow-more transaction. A borrower who calls the market contract directly can still open a loan without an agreement.", "viewer": { "isBank": true, "canConfigure": true, "planAllows": true } }, "marketId": "cmwfk2h7x0003jw9w4q8b2n1c" }, "error": null}
Returns the market’s effective loan agreement policy and where it comes from. A market without a policy reads OFF with source: DEFAULT. When the bank’s standing policy carries agreement settings and the market was adopted after they were saved, the first read creates the market’s policy from it (source: STANDING_POLICY). See Loan Agreements.
Who can read
An API key of any instance that holds the market. viewer says whether your instance is the market’s bank and, for the bank, whether its plan includes loan agreements.
Path Parameters
string
required
The market’s record ID on your instance.
Response Fields
object
Show child attributes
string
OFF, OPTIONAL or REQUIRED.
number
How long an issued LOAN agreement’s offer stays open, in days.
boolean
Whether a request inside the market rules is issued at once.
string | null
With autoIssue, the largest borrow amount issued at once, in the borrow asset. null means no ceiling.
number | null
How long a FRAMEWORK agreement runs when the bank creates one without validUntil. null means no default.
string
ANY when every instance with access may request agreements, BANK_ONLY when only the bank creates them.
string
DEFAULT, MANUAL (set on this market) or STANDING_POLICY.
string | null
The standing policy the settings came from.
string | null
The bank’s admin wallet that set the policy, or the adopting wallet.
boolean
Whether your instance set it.
string
Always BACKEND_CHECK: REQUIRED is checked by Trusset before it builds a transaction, not by the contract.
string | null
The enforcement note, in REQUIRED mode.
object
{ isBank, canConfigure, planAllows }. planAllows is answered for the bank only.
object
For the bank: a matching standing policy carries agreement settings but did not apply, with reason (ADOPTED_BEFORE_POLICY, PLAN, POLICY_OFF).
{ "success": true, "data": { "policy": { "mode": "REQUIRED", "validityDays": 30, "autoIssue": false, "autoIssueMaxAmount": null, "frameworkValidityDays": null, "requestAccess": "ANY", "source": "MANUAL", "standingPolicyId": null, "setByWallet": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab", "setByThisInstance": true, "updatedAt": "2026-11-21T15:40:02.114Z", "enforcement": "BACKEND_CHECK", "notice": "REQUIRED is checked by the Trusset backend before it builds an open or borrow-more transaction. A borrower who calls the market contract directly can still open a loan without an agreement.", "viewer": { "isBank": true, "canConfigure": true, "planAllows": true } }, "marketId": "cmwfk2h7x0003jw9w4q8b2n1c" }, "error": null}
Error Codes
Code
HTTP
Cause
MARKET_NOT_FOUND
404
No market with this ID on your instance
AGREEMENT_POLICY_UNREADABLE
503
The policy could not be read just now. Nothing was decided. Retry shortly
⌘I
Get Agreement Policy
curl --request GET \ --url https://api.trusset.org/lending-external-securities-v2/api/markets/{marketId}/agreement-policy \ --header 'x-api-key: <api-key>'
{ "success": true, "data": { "policy": { "mode": "REQUIRED", "validityDays": 30, "autoIssue": false, "autoIssueMaxAmount": null, "frameworkValidityDays": null, "requestAccess": "ANY", "source": "MANUAL", "standingPolicyId": null, "setByWallet": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab", "setByThisInstance": true, "updatedAt": "2026-11-21T15:40:02.114Z", "enforcement": "BACKEND_CHECK", "notice": "REQUIRED is checked by the Trusset backend before it builds an open or borrow-more transaction. A borrower who calls the market contract directly can still open a loan without an agreement.", "viewer": { "isBank": true, "canConfigure": true, "planAllows": true } }, "marketId": "cmwfk2h7x0003jw9w4q8b2n1c" }, "error": null}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Trusset Protocol","description":"Secured lending infrastructure for real-world assets, built for banks and fintechs","colors":{"primary":"#B1F163","light":"#B1F163","dark":"#B1F163"},"logo":{"light":"https://mintcdn.com/testtttt-3cb7d5bb/38jNDl9NUnuI6yfl/logo/patchGreen.png?fit=max\u0026auto=format\u0026n=38jNDl9NUnuI6yfl\u0026q=85\u0026s=d62bfe76228e7c7e125f25f84f935c73","dark":"https://mintcdn.com/testtttt-3cb7d5bb/38jNDl9NUnuI6yfl/logo/patchGreen.png?fit=max\u0026auto=format\u0026n=38jNDl9NUnuI6yfl\u0026q=85\u0026s=d62bfe76228e7c7e125f25f84f935c73"},"favicon":"https://mintcdn.com/testtttt-3cb7d5bb/38jNDl9NUnuI6yfl/favicon.png?fit=max\u0026auto=format\u0026n=38jNDl9NUnuI6yfl\u0026q=85\u0026s=3ece2c317cdd2ffd62b7199d0b990623","api":{"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.trusset.org"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://issuers.trusset.org"}},"footer":{"socials":{"website":"https://trusset.org","linkedin":"https://www.linkedin.com/company/trusset","github":"https://github.com/Trusset"}},"seo":{"metatags":{"description":"Trusset is secured lending infrastructure for real-world assets. Banks act as lender of record on lending markets, and fintechs add earn and borrow to their apps through one API.","keywords":"secured lending, credit infrastructure, Lombard loans, lending against securities, real-world assets, RWA lending, lender of record, collateral, ERC-3643, MiCA, eWpG, lending API","author":"Trusset Protocol","robots":"index, follow","googlebot":"index, follow","language":"en","category":"Financial Technology","distribution":"global","coverage":"Worldwide","target":"banks, licensed lenders, fintechs, tokenization platforms, developers","theme-color":"#B1F163","og:title":"Trusset Docs - Secured lending infrastructure for real-world assets","og:type":"website","og:url":"https://docs.trusset.org","og:image":"https://docs.trusset.org/assets/logo.png","og:description":"Credit infrastructure for banks and fintechs. Lend against the assets clients already hold, with a licensed lender of record on every loan.","og:site_name":"Trusset Protocol Documentation","og:locale":"en_US","article:section":"Financial Technology","article:tag":"secured lending, credit infrastructure, lender of record, collateral, real-world assets, vaults, API","application-name":"Trusset Protocol Docs","HandheldFriendly":"True","MobileOptimized":"320","viewport":"width=device-width, initial-scale=1.0","charset":"UTF-8"},"indexing":"all"},"fonts":{"body":{"family":"Questrial","weight":400}},"errors":{"404":{"redirect":true,"title":"I can't be found","description":"What ever **happened** to this _page_?"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"testtttt-3cb7d5bb","hasAudioNarration":false,"actualSubdomain":"testtttt-3cb7d5bb","customDomains":["docs.trusset.org"],"gitSource":{"type":"github","owner":"trusset","repo":"trusset-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false},"entitlements":{},"buildId":"6b021fbe853d6bb0bdd812fc","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":483},{"language":"default","tag":"Lending","count":290},{"language":"default","tag":"Lending markets","count":195},{"language":"default","tag":"Assets","count":128},{"language":"default","tag":"Trading","count":103},{"language":"default","tag":"Customers","count":92},{"language":"default","tag":"Identity","count":88},{"language":"default","tag":"Stock Trading","count":43},{"language":"default","tag":"Guides","count":40},{"language":"default","tag":"SDK","count":37}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Questrial';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/questrial/v19/QdVUSTchPBm7nuUeVf70sSFlq20.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Questrial';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/questrial/v19/QdVUSTchPBm7nuUeVf70sCFlq20.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Questrial';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/questrial/v19/QdVUSTchPBm7nuUeVf70viFl.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nh1,h2,h3,h4,h5,h6{font-family:'Questrial', sans-serif!important}.mdx-content h1,.mdx-content h2,.mdx-content h3,.mdx-content h4,.mdx-content h5,.mdx-content h6{font-family:'Questrial', sans-serif!important}#page-title{font-family:'Questrial', sans-serif!important}.trusset-fire{position:fixed;right:0;z-index:-1;overflow:hidden;pointer-events:none;-webkit-mask-image:linear-gradient(to right, transparent 0, #000 6%, #000 94%, transparent 100%);mask-image:linear-gradient(to right, transparent 0, #000 6%, #000 94%, transparent 100%)}.trusset-fire canvas{position:absolute;inset:0;width:100%;height:100%}@media print{.trusset-fire{display:none}}@media (max-width: 1024px){.trusset-fire{-webkit-mask-image:none;mask-image:none}}:root{--trusset-brand: var(--primary);--trusset-brand-light: var(--primary-light)}div.card,a.card{transition:background-color 160ms ease, border-color 160ms ease}@layer properties{div.card:hover,a.card:hover,div.card:focus-visible,a.card:focus-visible{border-color:transparent!important}}div.card:hover,a.card:hover,div.card:focus-visible,a.card:focus-visible{--primary: 0 0 0 / 0;--primary-light: 0 0 0 / 0;border-color:transparent;background-color:rgb(245 245 246)!important}html.dark div.card:hover,html.dark a.card:hover,html.dark div.card:focus-visible,html.dark a.card:focus-visible{background-color:rgb(22 24 23)!important}div.card:hover *,a.card:hover *,div.card:focus-visible *,a.card:focus-visible *{--primary: var(--trusset-brand);--primary-light: var(--trusset-brand-light)}@media (prefers-reduced-motion: reduce){div.card,a.card{transition:none}}.trusset-status-dot{position:relative;display:inline-block;width:12px;height:12px;margin:6px;border-radius:9999px;background-color:rgb(156 163 175)}.trusset-status-dot::after{content:'';position:absolute;inset:-5px;border-radius:9999px;background-color:currentColor;opacity:0.18}.trusset-status-up{background-color:rgb(52 211 153);color:rgb(52 211 153)}.trusset-status-warn{background-color:rgb(251 191 36);color:rgb(251 191 36)}.trusset-status-down{background-color:rgb(248 113 113);color:rgb(248 113 113)}.trusset-status-info{background-color:rgb(96 165 250);color:rgb(96 165 250)}.trusset-status-neutral{color:rgb(156 163 175)}.tl-flow,.tl-panel{--tl-line: rgb(3 7 18 / 0.1);--tl-soft: rgb(245 245 246);--tl-text: rgb(17 24 39);--tl-muted: rgb(107 114 128);margin:20px 0}html.dark .tl-flow,html.dark .tl-panel{--tl-line: rgb(255 255 255 / 0.1);--tl-soft: rgb(22 24 23);--tl-text: rgb(243 244 246);--tl-muted: rgb(156 163 175)}.tl-flow{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));gap:10px}.tl-flow-step{position:relative;padding:14px 16px;border:1px solid var(--tl-line);border-radius:14px}.tl-flow-step:not(:last-child)::after{content:'';position:absolute;top:50%;right:-9px;width:8px;height:1px;background:var(--tl-line)}.tl-flow-head{display:flex;align-items:center;gap:8px;margin-bottom:6px}.tl-flow-index{display:inline-flex;align-items:center;justify-content:center;width:20px;height:20px;border-radius:9999px;background:#b1f163;color:#111;font-size:11px;font-weight:600}.tl-flow-label{color:var(--tl-text);font-weight:600;font-size:14px}.tl-flow-text{margin:0!important;color:var(--tl-muted);font-size:13px;line-height:1.5}.tl-panel{padding:18px;border:1px solid var(--tl-line);border-radius:16px}.tl-inputs{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:12px;margin-bottom:16px}.tl-inputs-4{grid-template-columns:repeat(4, minmax(0, 1fr))}.tl-field{display:flex;flex-direction:column;gap:6px;color:var(--tl-muted);font-size:12px}.tl-field input{width:100%;padding:8px 10px;border:1px solid var(--tl-line);border-radius:10px;background:transparent;color:var(--tl-text);font:inherit;font-size:14px}.tl-field input:focus{outline:none;border-color:#b1f163}.tl-bar{display:flex;height:12px;overflow:hidden;border-radius:9999px;background:var(--tl-soft)}.tl-seg{height:100%;transition:width 200ms ease}.tl-seg-trusset{background:#b1f163}.tl-seg-operator{background:#5eead4}.tl-seg-distributor{background:#93c5fd}.tl-seg-fund{background:#fcd34d}.tl-seg-providers{background:rgb(115 115 115)}html.dark .tl-seg-providers{background:rgb(163 163 163)}.tl-legend{margin-top:14px}.tl-legend-row{display:grid;grid-template-columns:12px 1fr auto;align-items:center;gap:10px;padding:8px 0;border-top:1px solid var(--tl-line);color:var(--tl-text);font-size:14px}.tl-swatch{width:10px;height:10px;border-radius:3px}.tl-legend-label,.tl-legend-value{display:flex;flex-direction:column}.tl-legend-value{align-items:flex-end;font-variant-numeric:tabular-nums}.tl-legend-rule{color:var(--tl-muted);font-size:12px}.tl-stats{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));gap:10px}.tl-stat{display:flex;flex-direction:column;gap:4px;padding:12px;border-radius:12px;background:var(--tl-soft)}.tl-stat-label{color:var(--tl-muted);font-size:12px}.tl-stat-value{color:var(--tl-text);font-size:18px;font-variant-numeric:tabular-nums}.tl-verdict{margin:14px 0 0!important;padding-left:10px;border-left:2px solid var(--tl-line);color:var(--tl-text);font-size:14px}.tl-verdict-ok{border-left-color:rgb(52 211 153)}.tl-verdict-warn{border-left-color:rgb(251 191 36)}.tl-verdict-bad{border-left-color:rgb(248 113 113)}@media (max-width: 768px){.tl-flow,.tl-inputs-4,.tl-stats{grid-template-columns:repeat(2, minmax(0, 1fr))}.tl-flow-step::after{display:none}}"}]}
{"page":{"pagePath":"endpoints/lending/get-agreement-policy","slug":"/endpoints/lending/get-agreement-policy","pageMetadata":{"title":"Get Agreement Policy","api":"GET /lending-external-securities-v2/api/markets/{marketId}/agreement-policy","description":"Read whether loan agreements are off, optional or required on a market","href":"/endpoints/lending/get-agreement-policy"},"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: \"Read whether loan agreements are off, optional or required on a market\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns the market’s effective loan agreement policy and where it comes from. A market without a policy reads `,_jsx(_components.code,{children:`OFF`}),` with `,_jsx(_components.code,{children:`source: DEFAULT`}),`. When the bank’s standing policy carries agreement settings and the market was adopted after they were saved, the first read creates the market’s policy from it (`,_jsx(_components.code,{children:`source: STANDING_POLICY`}),`). See `,_jsx(_components.a,{href:`/endpoints/lending/loan-agreements#standing-policies`,children:`Loan Agreements`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`who-can-read`,children:`Who can read`}),`\n`,_jsxs(_components.p,{children:[`An API key of any instance that holds the market. `,_jsx(_components.code,{children:`viewer`}),` says whether your instance is the market’s bank and, for the bank, whether its plan includes loan agreements.`]}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`marketId`,type:`string`,required:true,id:`param-market-id`,children:_jsx(_components.p,{children:`The market’s record ID on your instance.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{children:[_jsxs(ResponseField,{name:`policy.mode`,type:`string`,id:`param-policy-mode`,children:[_jsx(_components.code,{children:`OFF`}),`, `,_jsx(_components.code,{children:`OPTIONAL`}),` or `,_jsx(_components.code,{children:`REQUIRED`}),`.`]}),_jsxs(ResponseField,{name:`policy.validityDays`,type:`number`,id:`param-policy-validity-days`,children:[`How long an issued `,_jsx(_components.code,{children:`LOAN`}),` agreement’s offer stays open, in days.`]}),_jsx(ResponseField,{name:`policy.autoIssue`,type:`boolean`,id:`param-policy-auto-issue`,children:`Whether a request inside the market rules is issued at once.`}),_jsxs(ResponseField,{name:`policy.autoIssueMaxAmount`,type:`string | null`,id:`param-policy-auto-issue-max-amount`,children:[`With `,_jsx(_components.code,{children:`autoIssue`}),`, the largest borrow amount issued at once, in the borrow asset. `,_jsx(_components.code,{children:`null`}),` means no ceiling.`]}),_jsxs(ResponseField,{name:`policy.frameworkValidityDays`,type:`number | null`,id:`param-policy-framework-validity-days`,children:[`How long a `,_jsx(_components.code,{children:`FRAMEWORK`}),` agreement runs when the bank creates one without `,_jsx(_components.code,{children:`validUntil`}),`. `,_jsx(_components.code,{children:`null`}),` means no default.`]}),_jsxs(ResponseField,{name:`policy.requestAccess`,type:`string`,id:`param-policy-request-access`,children:[_jsx(_components.code,{children:`ANY`}),` when every instance with access may request agreements, `,_jsx(_components.code,{children:`BANK_ONLY`}),` when only the bank creates them.`]}),_jsxs(ResponseField,{name:`policy.source`,type:`string`,id:`param-policy-source`,children:[_jsx(_components.code,{children:`DEFAULT`}),`, `,_jsx(_components.code,{children:`MANUAL`}),` (set on this market) or `,_jsx(_components.code,{children:`STANDING_POLICY`}),`.`]}),_jsx(ResponseField,{name:`policy.standingPolicyId`,type:`string | null`,id:`param-policy-standing-policy-id`,children:`The standing policy the settings came from.`}),_jsx(ResponseField,{name:`policy.setByWallet`,type:`string | null`,id:`param-policy-set-by-wallet`,children:`The bank’s admin wallet that set the policy, or the adopting wallet.`}),_jsx(ResponseField,{name:`policy.setByThisInstance`,type:`boolean`,id:`param-policy-set-by-this-instance`,children:`Whether your instance set it.`}),_jsxs(ResponseField,{name:`policy.enforcement`,type:`string`,id:`param-policy-enforcement`,children:[`Always `,_jsx(_components.code,{children:`BACKEND_CHECK`}),`: `,_jsx(_components.code,{children:`REQUIRED`}),` is checked by Trusset before it builds a transaction, not by the contract.`]}),_jsxs(ResponseField,{name:`policy.notice`,type:`string | null`,id:`param-policy-notice`,children:[`The enforcement note, in `,_jsx(_components.code,{children:`REQUIRED`}),` mode.`]}),_jsxs(ResponseField,{name:`policy.viewer`,type:`object`,id:`param-policy-viewer`,children:[_jsx(_components.code,{children:`{ isBank, canConfigure, planAllows }`}),`. `,_jsx(_components.code,{children:`planAllows`}),` is answered for the bank only.`]}),_jsxs(ResponseField,{name:`policy.standingPolicyPending`,type:`object`,id:`param-policy-standing-policy-pending`,children:[`For the bank: a matching standing policy carries agreement settings but did not apply, with `,_jsx(_components.code,{children:`reason`}),` (`,_jsx(_components.code,{children:`ADOPTED_BEFORE_POLICY`}),`, `,_jsx(_components.code,{children:`PLAN`}),`, `,_jsx(_components.code,{children:`POLICY_OFF`}),`).`]})]})}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`HTTP`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`MARKET_NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`No market with this ID on your instance`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AGREEMENT_POLICY_UNREADABLE`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`The policy could not be read just now. Nothing was decided. Retry shortly`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Agreement Policy","api":"GET /lending-external-securities-v2/api/markets/{marketId}/agreement-policy","description":"Read whether loan agreements are off, optional or required on a market","href":"/endpoints/lending/get-agreement-policy"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseExample,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns the market’s effective loan agreement policy and where it comes from. A market without a policy reads `,_jsx(_components.code,{children:`OFF`}),` with `,_jsx(_components.code,{children:`source: DEFAULT`}),`. When the bank’s standing policy carries agreement settings and the market was adopted after they were saved, the first read creates the market’s policy from it (`,_jsx(_components.code,{children:`source: STANDING_POLICY`}),`). See `,_jsx(_components.a,{href:`/endpoints/lending/loan-agreements#standing-policies`,children:`Loan Agreements`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`who-can-read`,children:`Who can read`}),`\n`,_jsxs(_components.p,{children:[`An API key of any instance that holds the market. `,_jsx(_components.code,{children:`viewer`}),` says whether your instance is the market’s bank and, for the bank, whether its plan includes loan agreements.`]}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`marketId`,type:`string`,required:true,id:`param-market-id`,children:_jsx(_components.p,{children:`The market’s record ID on your instance.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{children:[_jsxs(ResponseField,{name:`policy.mode`,type:`string`,id:`param-policy-mode`,children:[_jsx(_components.code,{children:`OFF`}),`, `,_jsx(_components.code,{children:`OPTIONAL`}),` or `,_jsx(_components.code,{children:`REQUIRED`}),`.`]}),_jsxs(ResponseField,{name:`policy.validityDays`,type:`number`,id:`param-policy-validity-days`,children:[`How long an issued `,_jsx(_components.code,{children:`LOAN`}),` agreement’s offer stays open, in days.`]}),_jsx(ResponseField,{name:`policy.autoIssue`,type:`boolean`,id:`param-policy-auto-issue`,children:`Whether a request inside the market rules is issued at once.`}),_jsxs(ResponseField,{name:`policy.autoIssueMaxAmount`,type:`string | null`,id:`param-policy-auto-issue-max-amount`,children:[`With `,_jsx(_components.code,{children:`autoIssue`}),`, the largest borrow amount issued at once, in the borrow asset. `,_jsx(_components.code,{children:`null`}),` means no ceiling.`]}),_jsxs(ResponseField,{name:`policy.frameworkValidityDays`,type:`number | null`,id:`param-policy-framework-validity-days`,children:[`How long a `,_jsx(_components.code,{children:`FRAMEWORK`}),` agreement runs when the bank creates one without `,_jsx(_components.code,{children:`validUntil`}),`. `,_jsx(_components.code,{children:`null`}),` means no default.`]}),_jsxs(ResponseField,{name:`policy.requestAccess`,type:`string`,id:`param-policy-request-access`,children:[_jsx(_components.code,{children:`ANY`}),` when every instance with access may request agreements, `,_jsx(_components.code,{children:`BANK_ONLY`}),` when only the bank creates them.`]}),_jsxs(ResponseField,{name:`policy.source`,type:`string`,id:`param-policy-source`,children:[_jsx(_components.code,{children:`DEFAULT`}),`, `,_jsx(_components.code,{children:`MANUAL`}),` (set on this market) or `,_jsx(_components.code,{children:`STANDING_POLICY`}),`.`]}),_jsx(ResponseField,{name:`policy.standingPolicyId`,type:`string | null`,id:`param-policy-standing-policy-id`,children:`The standing policy the settings came from.`}),_jsx(ResponseField,{name:`policy.setByWallet`,type:`string | null`,id:`param-policy-set-by-wallet`,children:`The bank’s admin wallet that set the policy, or the adopting wallet.`}),_jsx(ResponseField,{name:`policy.setByThisInstance`,type:`boolean`,id:`param-policy-set-by-this-instance`,children:`Whether your instance set it.`}),_jsxs(ResponseField,{name:`policy.enforcement`,type:`string`,id:`param-policy-enforcement`,children:[`Always `,_jsx(_components.code,{children:`BACKEND_CHECK`}),`: `,_jsx(_components.code,{children:`REQUIRED`}),` is checked by Trusset before it builds a transaction, not by the contract.`]}),_jsxs(ResponseField,{name:`policy.notice`,type:`string | null`,id:`param-policy-notice`,children:[`The enforcement note, in `,_jsx(_components.code,{children:`REQUIRED`}),` mode.`]}),_jsxs(ResponseField,{name:`policy.viewer`,type:`object`,id:`param-policy-viewer`,children:[_jsx(_components.code,{children:`{ isBank, canConfigure, planAllows }`}),`. `,_jsx(_components.code,{children:`planAllows`}),` is answered for the bank only.`]}),_jsxs(ResponseField,{name:`policy.standingPolicyPending`,type:`object`,id:`param-policy-standing-policy-pending`,children:[`For the bank: a matching standing policy carries agreement settings but did not apply, with `,_jsx(_components.code,{children:`reason`}),` (`,_jsx(_components.code,{children:`ADOPTED_BEFORE_POLICY`}),`, `,_jsx(_components.code,{children:`PLAN`}),`, `,_jsx(_components.code,{children:`POLICY_OFF`}),`).`]})]})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`200 Required`,numberOfLines:`27`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`27`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"policy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"REQUIRED\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"validityDays\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"autoIssue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"autoIssueMaxAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"frameworkValidityDays\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestAccess\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ANY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MANUAL\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"standingPolicyId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"setByWallet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0x5ad87a0621175206b72d10e4b8577b192e7f40ab\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"setByThisInstance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-21T15:40:02.114Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"enforcement\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BACKEND_CHECK\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"notice\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"REQUIRED is checked by the Trusset backend before it builds an open or borrow-more transaction. A borrower who calls the market contract directly can still open a loan without an agreement.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"viewer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isBank\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"canConfigure\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"planAllows\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"marketId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cmwfk2h7x0003jw9w4q8b2n1c\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`HTTP`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`MARKET_NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`No market with this ID on your instance`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AGREEMENT_POLICY_UNREADABLE`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`The policy could not be read just now. Nothing was decided. Retry shortly`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Agreement Policy","api":"GET /lending-external-securities-v2/api/markets/{marketId}/agreement-policy","description":"Read whether loan agreements are off, optional or required on a market","href":"/endpoints/lending/get-agreement-policy"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Who can read","slug":"who-can-read","depth":2,"children":[]},{"title":"Path Parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":2,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"200 Required","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"27\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"policy\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"mode\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"REQUIRED\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"validityDays\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">30\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"autoIssue\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">false\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"autoIssueMaxAmount\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"frameworkValidityDays\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requestAccess\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ANY\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"source\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"MANUAL\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"standingPolicyId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"setByWallet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"0x5ad87a0621175206b72d10e4b8577b192e7f40ab\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"setByThisInstance\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"updatedAt\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-11-21T15:40:02.114Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"enforcement\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"BACKEND_CHECK\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"notice\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"REQUIRED is checked by the Trusset backend before it builds an open or borrow-more transaction. A borrower who calls the market contract directly can still open a loan without an agreement.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"viewer\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"isBank\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"canConfigure\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"planAllows\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"marketId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"cmwfk2h7x0003jw9w4q8b2n1c\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Get Agreement Policy","path":"/lending-external-securities-v2/api/markets/{marketId}/agreement-policy","servers":[{"url":"https://api.trusset.org"}],"method":"get","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"x-api-key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"marketId":{"schema":[{"type":"string","description":"The market’s record ID on your instance.","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"data":[{"type":"object","properties":{"policy.mode":[{"type":"string","description":"`OFF` , `OPTIONAL` or `REQUIRED` ."}],"policy.validityDays":[{"type":"number","description":"How long an issued `LOAN` agreement’s offer stays open, in days."}],"policy.autoIssue":[{"type":"boolean","description":"Whether a request inside the market rules is issued at once."}],"policy.autoIssueMaxAmount":[{"type":"object","properties":{},"description":"With `autoIssue` , the largest borrow amount issued at once, in the borrow asset. `null` means no ceiling."}],"policy.frameworkValidityDays":[{"type":"object","properties":{},"description":"How long a `FRAMEWORK` agreement runs when the bank creates one without `validUntil` . `null` means no default."}],"policy.requestAccess":[{"type":"string","description":"`ANY` when every instance with access may request agreements, `BANK_ONLY` when only the bank creates them."}],"policy.source":[{"type":"string","description":"`DEFAULT` , `MANUAL` (set on this market) or `STANDING_POLICY` ."}],"policy.standingPolicyId":[{"type":"object","properties":{},"description":"The standing policy the settings came from."}],"policy.setByWallet":[{"type":"object","properties":{},"description":"The bank’s admin wallet that set the policy, or the adopting wallet."}],"policy.setByThisInstance":[{"type":"boolean","description":"Whether your instance set it."}],"policy.enforcement":[{"type":"string","description":"Always `BACKEND_CHECK` : `REQUIRED` is checked by Trusset before it builds a transaction, not by the contract."}],"policy.notice":[{"type":"object","properties":{},"description":"The enforcement note, in `REQUIRED` mode."}],"policy.viewer":[{"type":"object","properties":{},"description":"`{ isBank, canConfigure, planAllows }` . `planAllows` is answered for the bank only."}],"policy.standingPolicyPending":[{"type":"object","properties":{},"description":"For the bank: a matching standing policy carries agreement settings but did not apply, with `reason` ( `ADOPTED_BEFORE_POLICY` , `PLAN` , `POLICY_OFF` )."}]}}]}}],"examples":{"example":{"value":{"data":{"policy.mode":"\u003cstring>","policy.validityDays":123,"policy.autoIssue":true,"policy.autoIssueMaxAmount":{},"policy.frameworkValidityDays":{},"policy.requestAccess":"\u003cstring>","policy.source":"\u003cstring>","policy.standingPolicyId":{},"policy.setByWallet":{},"policy.setByThisInstance":true,"policy.enforcement":"\u003cstring>","policy.notice":{},"policy.viewer":{},"policy.standingPolicyPending":{}}}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/testtttt-3cb7d5bb/45c07278c97d6ecb/fire.js"],"subdomain":"testtttt-3cb7d5bb","siteName":"Trusset Protocol","title":"Trusset Docs - Secured lending infrastructure for real-world assets","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T21:06:02.702Z","originalFileLocation":"endpoints/lending/get-agreement-policy.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=\"Read whether loan agreements are off, optional or required on a market\">\u003cmeta data-mint-head name=\"keywords\" content=\"secured lending, credit infrastructure, Lombard loans, lending against securities, real-world assets, RWA lending, lender of record, collateral, ERC-3643, MiCA, eWpG, lending API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trusset Protocol\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Trusset Docs - Secured lending infrastructure for real-world assets\">\u003cmeta data-mint-head property=\"og:description\" content=\"Credit infrastructure for banks and fintechs. Lend against the assets clients already hold, with a licensed lender of record on every loan.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Trusset Protocol Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trusset.org/endpoints/lending/get-agreement-policy\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.trusset.org/assets/logo.png\">\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=\"Trusset Docs - Secured lending infrastructure for real-world assets\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Credit infrastructure for banks and fintechs. Lend against the assets clients already hold, with a licensed lender of record on every loan.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.trusset.org/assets/logo.png\">\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/testtttt-3cb7d5bb/9u1BXJ52XE_SSqI7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Trusset Protocol\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#B1F163\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Trusset Protocol\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"category\" content=\"Financial Technology\">\u003cmeta data-mint-head name=\"distribution\" content=\"global\">\u003cmeta data-mint-head name=\"coverage\" content=\"Worldwide\">\u003cmeta data-mint-head name=\"target\" content=\"banks, licensed lenders, fintechs, tokenization platforms, developers\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#B1F163\">\u003cmeta data-mint-head name=\"article:section\" content=\"Financial Technology\">\u003cmeta data-mint-head name=\"article:tag\" content=\"secured lending, credit infrastructure, lender of record, collateral, real-world assets, vaults, API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trusset Protocol Docs\">\u003cmeta data-mint-head name=\"HandheldFriendly\" content=\"True\">\u003cmeta data-mint-head name=\"MobileOptimized\" content=\"320\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"charset\" content=\"UTF-8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trusset.org/endpoints/lending/get-agreement-policy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/endpoints/lending/get-agreement-policy.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trusset.org/#organization\",\"name\":\"Trusset Protocol\",\"url\":\"https://docs.trusset.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/testtttt-3cb7d5bb/38jNDl9NUnuI6yfl/logo/patchGreen.png?fit=max\u0026auto=format\u0026n=38jNDl9NUnuI6yfl\u0026q=85\u0026s=d62bfe76228e7c7e125f25f84f935c73\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trusset.org#website\",\"name\":\"Trusset Protocol\",\"url\":\"https://docs.trusset.org\",\"publisher\":{\"@id\":\"https://docs.trusset.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy#webpage\",\"url\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy\",\"name\":\"Get Agreement Policy\",\"description\":\"Read whether loan agreements are off, optional or required on a market\",\"dateModified\":\"2026-11-21T21:06:02.702Z\",\"isPartOf\":{\"@id\":\"https://docs.trusset.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Lending\",\"item\":\"https://docs.trusset.org/endpoints/lending/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Lending markets\",\"item\":\"https://docs.trusset.org/endpoints/lending/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"E-Signatures\",\"item\":\"https://docs.trusset.org/endpoints/lending/loan-agreements\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get Agreement Policy\",\"item\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy#apireference\",\"headline\":\"Get Agreement Policy\",\"name\":\"Get Agreement Policy\",\"description\":\"Read whether loan agreements are off, optional or required on a market\",\"url\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trusset.org/endpoints/lending/get-agreement-policy#webpage\"},\"image\":\"https://docs.trusset.org/assets/logo.png\",\"dateModified\":\"2026-11-21T21:06:02.702Z\",\"publisher\":{\"@id\":\"https://docs.trusset.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trusset.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Trusset Protocol\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Trusset Protocol\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/endpoints/lending/get-agreement-policy.md","siteName":"Trusset Protocol","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/protocol/intro"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"group":"Using the API","pages":[{"title":"API Introduction","href":"/endpoints/introduction"},{"title":"Authentication","href":"/endpoints/authentication"},{"title":"Rate Limits","href":"/endpoints/rate-limits"}]}]},{"group":"Lending","pages":[{"group":"Lending markets","pages":[{"title":"Lending","href":"/endpoints/lending/introduction"},{"group":"Markets","pages":[{"title":"List Markets","api":"GET /lending-external-securities-v2/api/markets","href":"/endpoints/lending/list-markets"},{"title":"Get Market","api":"GET /lending-external-securities-v2/api/markets/{marketId}","href":"/endpoints/lending/get-market"},{"title":"Get Market Metrics","api":"GET /lending-external-securities-v2/api/markets/{marketId}/metrics","href":"/endpoints/lending/get-metrics"},{"title":"Get Market Config","api":"GET /lending-external-securities-v2/api/markets/{marketId}/config","href":"/endpoints/lending/get-config"},{"title":"Get Supply Caps","api":"GET /lending-external-securities-v2/api/markets/{marketId}/supply-caps","href":"/endpoints/lending/get-supply-caps"},{"title":"Get Max Borrow","api":"GET /lending-external-securities-v2/api/markets/{marketId}/max-borrow","href":"/endpoints/lending/get-max-borrow"},{"title":"List Transactions","api":"GET /lending-external-securities-v2/api/markets/{marketId}/transactions","href":"/endpoints/lending/list-transactions"},{"title":"Get Market History","api":"GET /lending-external-securities-v2/api/markets/{marketId}/history","href":"/endpoints/lending/get-history"},{"title":"Get Index Status","api":"GET /lending-external-securities-v2/api/markets/{marketId}/index-status","href":"/endpoints/lending/get-index-status"},{"title":"Get Lifecycle Statement","api":"GET /lending-external-securities-v2/api/markets/{marketId}/lifecycle-statement","href":"/endpoints/lending/get-lifecycle-statement"},{"title":"List Borrow Assets","api":"GET /lending-external-securities-v2/api/markets/borrow-assets","href":"/endpoints/lending/list-borrow-assets"}]},{"group":"Deployment","pages":[{"title":"Get Deployment Options","api":"GET /lending-external-securities-v2/api/markets/deployment-options","href":"/endpoints/lending/get-deployment-options"},{"title":"Preview Asset Data","api":"GET /lending-external-securities-v2/api/markets/asset-data/preview","href":"/endpoints/lending/preview-asset-data"},{"title":"Deploy Market","api":"POST /lending-external-securities-v2/api/markets/deploy","href":"/endpoints/lending/deploy-market"},{"title":"Get Nominations","api":"GET /lending-external-securities-v2/api/markets/{marketId}/nominations","href":"/endpoints/lending/get-nominations"},{"title":"Nominate Candidate","api":"POST /lending-external-securities-v2/api/markets/{marketId}/nominations","href":"/endpoints/lending/nominate-candidate"},{"title":"Withdraw Nomination","api":"POST /lending-external-securities-v2/api/markets/{marketId}/nominations/withdraw","href":"/endpoints/lending/withdraw-nomination"}]},{"group":"Asset Data","pages":[{"title":"Get Asset Data","api":"GET /lending-external-securities-v2/api/markets/{market}/asset-data","href":"/endpoints/lending/get-asset-data"},{"title":"Get Asset Data Bundle","api":"GET /lending-external-securities-v2/api/markets/{market}/asset-data/bundle","href":"/endpoints/lending/get-asset-data-bundle"},{"title":"Attest Asset Data","api":"POST /lending-external-securities-v2/api/markets/{market}/asset-data/attest","href":"/endpoints/lending/attest-asset-data"},{"title":"Confirm Asset Data Attestation","api":"POST /lending-external-securities-v2/api/markets/{market}/asset-data/attest/confirm","href":"/endpoints/lending/confirm-asset-data-attestation"},{"title":"Acknowledge Asset Data","api":"POST /lending-external-securities-v2/api/markets/{market}/asset-data/acknowledge","href":"/endpoints/lending/acknowledge-asset-data"},{"title":"Confirm Asset Data Acknowledgement","api":"POST /lending-external-securities-v2/api/markets/{market}/asset-data/acknowledge/confirm","href":"/endpoints/lending/confirm-asset-data-acknowledgement"}]},{"group":"Documents","pages":[{"title":"Get Documents","api":"GET /lending-external-securities-v2/api/markets/{marketId}/legal-documents","href":"/endpoints/lending/get-legal-documents"},{"title":"Upload Public Document","api":"POST /lending-external-securities-v2/api/markets/legal-documents/upload","href":"/endpoints/lending/upload-legal-document"},{"title":"Record Document","api":"POST /lending-external-securities-v2/api/markets/{marketId}/legal-documents","href":"/endpoints/lending/record-legal-document"},{"title":"Confirm Document","api":"POST /lending-external-securities-v2/api/markets/{marketId}/legal-documents/confirm","href":"/endpoints/lending/confirm-legal-document"},{"title":"Stage Loan Document","api":"POST /lending-external-securities-v2/api/markets/{marketId}/legal-documents/stage","href":"/endpoints/lending/stage-loan-document"},{"title":"Record Staged Document","api":"POST /lending-external-securities-v2/api/markets/{marketId}/legal-documents/staged/{stageId}/record","href":"/endpoints/lending/record-staged-document"},{"title":"Dismiss Staged Document","api":"POST /lending-external-securities-v2/api/markets/{marketId}/legal-documents/staged/{stageId}/dismiss","href":"/endpoints/lending/dismiss-staged-document"}]},{"group":"E-Signatures","pages":[{"title":"E-Signatures","description":"An optional add-on that binds the contract a bank signs in its own e-signature tool to the loan it covers","href":"/endpoints/lending/loan-agreements"},{"title":"Get Agreement Policy","api":"GET /lending-external-securities-v2/api/markets/{marketId}/agreement-policy","href":"/endpoints/lending/get-agreement-policy"},{"title":"Set Agreement Policy","api":"PUT /lending-external-securities-v2/api/markets/{marketId}/agreement-policy","description":"Switch loan agreements off, to optional or to required on a market","href":"/endpoints/lending/set-agreement-policy"},{"title":"Create Loan Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements","href":"/endpoints/lending/create-loan-agreement"},{"title":"List Loan Agreements","api":"GET /lending-external-securities-v2/api/markets/{marketId}/loan-agreements","href":"/endpoints/lending/list-loan-agreements"},{"title":"Get Loan Agreement","api":"GET /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}","href":"/endpoints/lending/get-loan-agreement"},{"title":"Get Loan Schedule","api":"GET /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/schedule.pdf","href":"/endpoints/lending/get-loan-schedule"},{"title":"Issue Loan Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/issue","href":"/endpoints/lending/issue-loan-agreement"},{"title":"Decline Loan Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/decline","href":"/endpoints/lending/decline-loan-agreement"},{"title":"Withdraw Loan Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/withdraw","href":"/endpoints/lending/withdraw-loan-agreement"},{"title":"Report Signed Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/signed","href":"/endpoints/lending/report-signed-agreement"},{"title":"Report Copy Mismatch","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/copy-mismatch","href":"/endpoints/lending/report-copy-mismatch"},{"title":"Accept Loan Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/accept","href":"/endpoints/lending/accept-loan-agreement"},{"title":"Revoke Loan Agreement","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-agreements/{ref}/revoke","href":"/endpoints/lending/revoke-loan-agreement"}]},{"group":"Loan Approvals","pages":[{"title":"Loan Approvals","href":"/endpoints/lending/loan-approvals"},{"title":"Get Loan Approvals","api":"GET /lending-external-securities-v2/api/markets/{marketId}/loan-approvals","href":"/endpoints/lending/get-loan-approvals"},{"title":"Set Loan Approvals","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-approvals","href":"/endpoints/lending/set-loan-approvals"},{"title":"Create Loan Request","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-requests","href":"/endpoints/lending/create-loan-request"},{"title":"List Loan Requests","api":"GET /lending-external-securities-v2/api/markets/{marketId}/loan-requests","href":"/endpoints/lending/list-loan-requests"},{"title":"Get Loan Request","api":"GET /lending-external-securities-v2/api/markets/{marketId}/loan-requests/{ref}","href":"/endpoints/lending/get-loan-request"},{"title":"Approve Loan Request","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-requests/{ref}/approve","href":"/endpoints/lending/approve-loan-request"},{"title":"Revoke Loan Approval","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-requests/{ref}/revoke","href":"/endpoints/lending/revoke-loan-approval"},{"title":"Revoke All Loan Approvals","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-approvals/revoke-all","href":"/endpoints/lending/revoke-all-loan-approvals"},{"title":"Decline Loan Request","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-requests/{ref}/decline","href":"/endpoints/lending/decline-loan-request"},{"title":"Withdraw Loan Request","api":"POST /lending-external-securities-v2/api/markets/{marketId}/loan-requests/{ref}/withdraw","href":"/endpoints/lending/withdraw-loan-request"}]},{"group":"Setup","pages":[{"title":"Get Configuration Status","api":"GET /lending-external-securities-v2/api/markets/{marketId}/configuration-status","href":"/endpoints/lending/get-configuration-status"},{"title":"Get Setup Steps","api":"GET /lending-external-securities-v2/api/markets/{marketId}/setup-steps","href":"/endpoints/lending/get-setup-steps"},{"title":"Configure Market","api":"POST /lending-external-securities-v2/api/markets/{marketId}/configure","href":"/endpoints/lending/configure-market"},{"title":"Confirm Configuration","api":"POST /lending-external-securities-v2/api/markets/{marketId}/confirm-configuration","href":"/endpoints/lending/confirm-configuration"},{"title":"Get Upgrade Status","api":"GET /lending-external-securities-v2/api/markets/{marketId}/upgrade","href":"/endpoints/lending/get-upgrade-status"},{"title":"Upgrade Market","api":"POST /lending-external-securities-v2/api/markets/{marketId}/upgrade","href":"/endpoints/lending/upgrade-market"}]},{"group":"Risk and Access","pages":[{"title":"Update Market Config","api":"POST /lending-external-securities-v2/api/markets/{marketId}/config","href":"/endpoints/lending/update-config"},{"title":"Get Threshold Cooldown","api":"GET /lending-external-securities-v2/api/markets/{marketId}/threshold-cooldown","href":"/endpoints/lending/get-threshold-cooldown"},{"title":"Get Identity Gates","api":"GET /lending-external-securities-v2/api/markets/{marketId}/identity-gates","href":"/endpoints/lending/get-identity-gates"},{"title":"Set Identity Gates","api":"POST /lending-external-securities-v2/api/markets/{marketId}/identity-gates","href":"/endpoints/lending/set-identity-gates"},{"title":"Get Guardians","api":"GET /lending-external-securities-v2/api/markets/{marketId}/guardians","href":"/endpoints/lending/get-guardians"},{"title":"Pause Market","api":"POST /lending-external-securities-v2/api/markets/{marketId}/pause-state","href":"/endpoints/lending/pause-market"},{"title":"Admin Handover","api":"POST /lending-external-securities-v2/api/markets/{marketId}/admin-handover","href":"/endpoints/lending/admin-handover"}]},{"group":"Whitelists","pages":[{"title":"List Whitelists","api":"GET /lending-external-securities-v2/api/access-lists","href":"/endpoints/lending/list-access-lists"},{"title":"Get Whitelist","api":"GET /lending-external-securities-v2/api/access-lists/{listId}","href":"/endpoints/lending/get-access-list"},{"title":"Create Whitelist","api":"POST /lending-external-securities-v2/api/access-lists","href":"/endpoints/lending/create-access-list"},{"title":"Confirm Whitelist Creation","api":"POST /lending-external-securities-v2/api/access-lists/confirm-create","href":"/endpoints/lending/confirm-access-list-creation"},{"title":"Update Whitelist","api":"PATCH /lending-external-securities-v2/api/access-lists/{listId}","href":"/endpoints/lending/update-access-list"},{"title":"Set Whitelist Members","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/members","href":"/endpoints/lending/set-access-list-members"},{"title":"Confirm Whitelist Members","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/members/confirm","href":"/endpoints/lending/confirm-access-list-members"},{"title":"Set Whitelist Manager","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/managers","href":"/endpoints/lending/set-access-list-manager"},{"title":"Confirm Whitelist Manager","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/managers/confirm","href":"/endpoints/lending/confirm-access-list-manager"},{"title":"Transfer Whitelist Ownership","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/owner","href":"/endpoints/lending/transfer-access-list-ownership"},{"title":"Confirm Whitelist Ownership","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/owner/confirm","href":"/endpoints/lending/confirm-access-list-ownership"},{"title":"Rescan Whitelist","api":"POST /lending-external-securities-v2/api/access-lists/{listId}/rescan","href":"/endpoints/lending/rescan-access-list"}]},{"group":"Rates and Loan Terms","pages":[{"title":"Get Rate Mode","api":"GET /lending-external-securities-v2/api/markets/{marketId}/rate-mode","href":"/endpoints/lending/get-rate-mode"},{"title":"Set Rate Mode","api":"POST /lending-external-securities-v2/api/markets/{marketId}/rate-mode","href":"/endpoints/lending/set-rate-mode"},{"title":"Set Max Fixed Rate","api":"POST /lending-external-securities-v2/api/markets/{marketId}/max-fixed-rate","href":"/endpoints/lending/set-max-fixed-rate"},{"title":"Get Term Config","api":"GET /lending-external-securities-v2/api/markets/{marketId}/term-config","href":"/endpoints/lending/get-term-config"},{"title":"Set Term Config","api":"POST /lending-external-securities-v2/api/markets/{marketId}/term-config","href":"/endpoints/lending/set-term-config"},{"title":"Set Allow Extension","api":"POST /lending-external-securities-v2/api/markets/{marketId}/allow-extension","href":"/endpoints/lending/set-allow-extension"},{"title":"List Extensions","api":"GET /lending-external-securities-v2/api/markets/{marketId}/extensions","href":"/endpoints/lending/list-extensions"},{"title":"Propose Extension","api":"POST /lending-external-securities-v2/api/markets/{marketId}/extensions","href":"/endpoints/lending/propose-extension"},{"title":"Extension Action","api":"POST /lending-external-securities-v2/api/markets/{marketId}/extensions/{proposalId}/{action}","href":"/endpoints/lending/extension-action"},{"title":"Confirm Extension Transaction","api":"POST /lending-external-securities-v2/api/markets/{marketId}/extensions/confirm-tx","href":"/endpoints/lending/confirm-extension-transaction"},{"title":"Get Exit Liquidity","api":"GET /lending-external-securities-v2/api/markets/{marketId}/exit-liquidity","href":"/endpoints/lending/get-exit-liquidity"},{"title":"Set Reserve Ratio","api":"POST /lending-external-securities-v2/api/markets/{marketId}/reserve-ratio","href":"/endpoints/lending/set-reserve-ratio"}]},{"group":"Terms of Use","pages":[{"title":"Get Terms","api":"GET /lending-external-securities-v2/api/markets/{marketId}/terms","href":"/endpoints/lending/get-terms"},{"title":"List Terms Versions","api":"GET /lending-external-securities-v2/api/markets/{marketId}/terms/versions","href":"/endpoints/lending/list-terms-versions"},{"title":"Get Terms Version","api":"GET /lending-external-securities-v2/api/markets/{marketId}/terms/versions/{version}","href":"/endpoints/lending/get-terms-version"},{"title":"Save Terms","api":"PUT /lending-external-securities-v2/api/markets/{marketId}/terms","href":"/endpoints/lending/save-terms"},{"title":"Unpublish Terms","api":"DELETE /lending-external-securities-v2/api/markets/{marketId}/terms","href":"/endpoints/lending/unpublish-terms"},{"title":"Export Terms","api":"GET /lending-external-securities-v2/api/markets/{marketId}/terms/export","href":"/endpoints/lending/export-terms"},{"group":"Terms Library","pages":[{"title":"List Terms Templates","api":"GET /lending-external-securities-v2/api/markets/terms-library","href":"/endpoints/lending/list-terms-templates"},{"title":"Get Terms Template","api":"GET /lending-external-securities-v2/api/markets/terms-library/{templateId}","href":"/endpoints/lending/get-terms-template"},{"title":"Create Terms Template","api":"POST /lending-external-securities-v2/api/markets/terms-library","href":"/endpoints/lending/create-terms-template"},{"title":"Update Terms Template","api":"PUT /lending-external-securities-v2/api/markets/terms-library/{templateId}","href":"/endpoints/lending/update-terms-template"},{"title":"Archive Terms Template","api":"DELETE /lending-external-securities-v2/api/markets/terms-library/{templateId}","href":"/endpoints/lending/archive-terms-template"}]}]},{"group":"Oracle","pages":[{"title":"Get Oracle Status","api":"GET /lending-external-securities-v2/api/markets/{marketId}/oracle-status","href":"/endpoints/lending/get-oracle-status"},{"title":"Verify Signer","api":"GET /lending-external-securities-v2/api/markets/{marketId}/verify-signer","href":"/endpoints/lending/verify-signer"},{"title":"Sync Oracle Price","api":"POST /lending-external-securities-v2/api/markets/{marketId}/sync-oracle","href":"/endpoints/lending/sync-oracle"},{"title":"Sign Price","api":"POST /lending-external-securities-v2/api/markets/{marketId}/sign-price","href":"/endpoints/lending/sign-price"},{"title":"Verify Signed Price","api":"POST /lending-external-securities-v2/api/markets/{marketId}/verify-price","href":"/endpoints/lending/verify-price"},{"title":"Record Price Attestation","api":"POST /lending-external-securities-v2/api/markets/{marketId}/price-attestation","href":"/endpoints/lending/record-price-attestation"},{"title":"Get Oracle History","api":"GET /lending-external-securities-v2/api/markets/{marketId}/oracle-history","href":"/endpoints/lending/get-oracle-history"},{"title":"Get Oracle Halt","api":"GET /lending-external-securities-v2/api/markets/{marketId}/oracle-halt","href":"/endpoints/lending/get-oracle-halt"},{"title":"Halt Prices","api":"POST /lending-external-securities-v2/api/markets/{marketId}/oracle-halt","href":"/endpoints/lending/halt-prices"}]},{"group":"Liquidity","pages":[{"title":"List Liquidity Providers","api":"GET /lending-external-securities-v2/api/positions/{marketId}/providers","href":"/endpoints/lending/list-providers"},{"title":"Get Provider Balance","api":"GET /lending-external-securities-v2/api/positions/{marketId}/provider-balance/{provider}","href":"/endpoints/lending/get-provider-balance"},{"title":"Add Liquidity","api":"POST /lending-external-securities-v2/api/positions/{marketId}/add-liquidity","href":"/endpoints/lending/add-liquidity"},{"title":"Remove Liquidity","api":"POST /lending-external-securities-v2/api/positions/{marketId}/remove-liquidity","href":"/endpoints/lending/remove-liquidity"}]},{"group":"Vault Liquidity","pages":[{"title":"Get Vault Liquidity","api":"GET /lending-external-securities-v2/api/markets/{marketId}/vault-liquidity","href":"/endpoints/lending/get-vault-liquidity"},{"title":"Set Vault Liquidity","api":"POST /lending-external-securities-v2/api/markets/{marketId}/vault-liquidity","href":"/endpoints/lending/set-vault-liquidity"},{"title":"Register Vault","api":"POST /lending-external-securities-v2/api/markets/{marketId}/vault-liquidity/{action}","href":"/endpoints/lending/register-vault"},{"title":"List Connected Vaults","api":"GET /lending-external-securities-v2/api/markets/{marketId}/connected-vaults","href":"/endpoints/lending/list-connected-vaults"},{"title":"Deposit to Vault","api":"POST /lending-external-securities-v2/api/markets/{marketId}/vaults/{vaultAddress}/deposit","href":"/endpoints/lending/deposit-to-vault"},{"title":"Redeem from Vault","api":"POST /lending-external-securities-v2/api/markets/{marketId}/vaults/{vaultAddress}/redeem","href":"/endpoints/lending/redeem-from-vault"}]},{"group":"Borrowing","pages":[{"title":"Open Loan","api":"POST /lending-external-securities-v2/api/positions/{marketId}/open-loan","href":"/endpoints/lending/open-loan"},{"title":"Borrow More","api":"POST /lending-external-securities-v2/api/positions/{marketId}/borrow-more","href":"/endpoints/lending/borrow-more"},{"title":"Get Permit Quote","api":"POST /lending-external-securities-v2/api/positions/{marketId}/permit-quote","href":"/endpoints/lending/get-permit-quote"},{"title":"Repay Loan","api":"POST /lending-external-securities-v2/api/positions/{marketId}/repay","href":"/endpoints/lending/repay"},{"title":"Close Loan","api":"POST /lending-external-securities-v2/api/positions/{marketId}/close-loan","href":"/endpoints/lending/close-loan"},{"title":"Add Collateral","api":"POST /lending-external-securities-v2/api/positions/{marketId}/add-collateral","href":"/endpoints/lending/add-collateral"},{"title":"Withdraw Collateral","api":"POST /lending-external-securities-v2/api/positions/{marketId}/withdraw-collateral","href":"/endpoints/lending/withdraw-collateral"},{"title":"Get Escrowed Collateral","api":"GET /lending-external-securities-v2/api/positions/{marketId}/escrowed-collateral/{holderAddress}","href":"/endpoints/lending/get-escrowed-collateral"},{"title":"Claim Escrowed Collateral","api":"POST /lending-external-securities-v2/api/positions/{marketId}/claim-escrowed-collateral","href":"/endpoints/lending/claim-escrowed-collateral"},{"title":"Get Escrowed Surplus","api":"GET /lending-external-securities-v2/api/positions/{marketId}/escrowed-surplus/{holderAddress}","href":"/endpoints/lending/get-escrowed-surplus"},{"title":"Claim Surplus","api":"POST /lending-external-securities-v2/api/positions/{marketId}/claim-surplus","href":"/endpoints/lending/claim-surplus"}]},{"group":"Positions \u0026 Queries","pages":[{"title":"List Positions","api":"GET /lending-external-securities-v2/api/positions/{marketId}/positions","href":"/endpoints/lending/list-positions"},{"title":"Get Position","api":"GET /lending-external-securities-v2/api/positions/{marketId}/positions/{positionId}","href":"/endpoints/lending/get-position"},{"title":"Get Position Statement","api":"GET /lending-external-securities-v2/api/positions/{marketId}/positions/{positionId}/statement","href":"/endpoints/lending/get-position-statement"},{"title":"Get Loan","api":"GET /lending-external-securities-v2/api/positions/{marketId}/loan/{loanId}","href":"/endpoints/lending/get-loan"},{"title":"Get User Loans","api":"GET /lending-external-securities-v2/api/positions/{marketId}/user-loans/{userAddress}","href":"/endpoints/lending/get-user-loans"},{"title":"Get User Collateral","api":"GET /lending-external-securities-v2/api/positions/{marketId}/user-collateral/{userAddress}","href":"/endpoints/lending/get-user-collateral"}]},{"group":"Fees","pages":[{"title":"Get Fee Split","api":"GET /lending-external-securities-v2/api/markets/{marketId}/fee-split","href":"/endpoints/lending/get-fee-split"},{"title":"Get Cashflows","api":"GET /lending-external-securities-v2/api/markets/{marketId}/cashflows","href":"/endpoints/lending/get-cashflows"},{"title":"Sweep Operator Fees","api":"POST /lending-external-securities-v2/api/markets/{marketId}/operator-fees/sweep","href":"/endpoints/lending/sweep-operator-fees"},{"title":"Sweep Distributor Fees","api":"POST /lending-external-securities-v2/api/markets/{marketId}/distributor-fees/sweep","href":"/endpoints/lending/sweep-distributor-fees"},{"title":"Sweep Protocol Fees","api":"POST /lending-external-securities-v2/api/markets/{marketId}/protocol-fees/sweep","href":"/endpoints/lending/sweep-protocol-fees"},{"title":"Rotate Operator Wallet","api":"POST /lending-external-securities-v2/api/markets/{marketId}/operator-wallet","href":"/endpoints/lending/rotate-operator-wallet"}]},{"group":"Insurance Fund","pages":[{"title":"Get Insurance Status","api":"GET /lending-external-securities-v2/api/markets/{marketId}/insurance/status","href":"/endpoints/lending/get-insurance-status"},{"title":"Top Up Insurance Fund","api":"POST /lending-external-securities-v2/api/markets/{marketId}/insurance/top-up","href":"/endpoints/lending/top-up-insurance"},{"title":"Record Insurance Top-Up","api":"POST /lending-external-securities-v2/api/markets/{marketId}/insurance/record-topup","href":"/endpoints/lending/record-insurance-top-up"},{"title":"Withdraw from Insurance Fund","api":"POST /lending-external-securities-v2/api/markets/{marketId}/insurance/withdraw-calldata","href":"/endpoints/lending/withdraw-insurance"}]},{"group":"Liquidations","pages":[{"title":"Get Liquidation Config","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/config","href":"/endpoints/lending/get-liquidation-config"},{"title":"Get Liquidatable Loans","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/liquidatable-loans","href":"/endpoints/lending/get-liquidatable-loans"},{"title":"Liquidate Loan","api":"POST /lending-external-securities-v2/api/liquidations/{marketId}/liquidate/{loanId}","href":"/endpoints/lending/liquidate"},{"title":"Get Liquidation Desk","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/desk","href":"/endpoints/lending/get-liquidation-desk"},{"title":"Get Pending Liquidations","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/pending-liquidations","href":"/endpoints/lending/get-pending-liquidations"},{"title":"List Settled Liquidations","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/settled-liquidations","href":"/endpoints/lending/list-settled-liquidations"},{"title":"Get Liquidation Stats","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/liquidation-stats","href":"/endpoints/lending/get-liquidation-stats"},{"title":"Get Router Stats","api":"GET /lending-external-securities-v2/api/liquidations/router-stats","href":"/endpoints/lending/get-router-stats"}]},{"group":"Atomic Sale","pages":[{"title":"Get Atomic Sale","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/atomic-sale","href":"/endpoints/lending/get-atomic-sale"},{"title":"Set Atomic Mode","api":"POST /lending-external-securities-v2/api/liquidations/{marketId}/atomic-mode","href":"/endpoints/lending/set-atomic-mode"},{"title":"Set Sale Bid","api":"POST /lending-external-securities-v2/api/liquidations/{marketId}/sale-bid","href":"/endpoints/lending/set-sale-bid"},{"title":"Sell Pending Liquidation","api":"POST /lending-external-securities-v2/api/liquidations/liquidation/{liquidationId}/sell","href":"/endpoints/lending/sell-pending-liquidation"}]},{"group":"Liquidation Settlement","pages":[{"title":"Withdraw Collateral for Sale","api":"POST /lending-external-securities-v2/api/liquidations/withdraw-collateral/{liquidationId}","href":"/endpoints/lending/withdraw-collateral-for-sale"},{"title":"Report Partial Sale","api":"POST /lending-external-securities-v2/api/liquidations/report-partial-sale/{liquidationId}","href":"/endpoints/lending/report-partial-sale"},{"title":"Settle Liquidation","api":"POST /lending-external-securities-v2/api/liquidations/settle/{liquidationId}","href":"/endpoints/lending/settle-liquidation"},{"title":"Close Liquidation","api":"POST /lending-external-securities-v2/api/liquidations/close/{liquidationId}","href":"/endpoints/lending/close-liquidation"},{"title":"Handle Liquidation Timeout","api":"POST /lending-external-securities-v2/api/liquidations/handle-timeout/{liquidationId}","href":"/endpoints/lending/handle-timeout"},{"title":"Reopen Liquidation","api":"POST /lending-external-securities-v2/api/liquidations/reopen/{liquidationId}","href":"/endpoints/lending/reopen-liquidation"}]},{"group":"Dutch Auctions","pages":[{"title":"Get Auction Module","api":"GET /lending-external-securities-v2/api/markets/{marketId}/auction-module","href":"/endpoints/lending/get-auction-module"},{"title":"Wire Auction Module","api":"POST /lending-external-securities-v2/api/markets/{marketId}/auction-module","href":"/endpoints/lending/wire-auction-module"},{"title":"List Active Auctions","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/auctions","href":"/endpoints/lending/list-auctions"},{"title":"Get Auction","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/auctions/{auctionId}","href":"/endpoints/lending/get-auction"},{"title":"Get Loan Auction","api":"GET /lending-external-securities-v2/api/liquidations/{marketId}/loan-auction/{loanId}","href":"/endpoints/lending/get-loan-auction"},{"title":"Bid on Auction","api":"POST /lending-external-securities-v2/api/liquidations/{marketId}/bid-on-auction","href":"/endpoints/lending/bid-on-auction"},{"title":"Settle Expired Auction","api":"POST /lending-external-securities-v2/api/liquidations/{marketId}/settle-expired-auction","href":"/endpoints/lending/settle-expired-auction"}]},{"group":"Hooks","pages":[{"title":"List Hooks","api":"GET /lending-external-securities-v2/api/hooks/{marketId}","href":"/endpoints/lending/list-hooks"},{"title":"Get Hook","api":"GET /lending-external-securities-v2/api/hooks/{marketId}/{hookId}","href":"/endpoints/lending/get-hook"},{"title":"Create Hook","api":"POST /lending-external-securities-v2/api/hooks/{marketId}","href":"/endpoints/lending/create-hook"},{"title":"Update Hook","api":"PUT /lending-external-securities-v2/api/hooks/{marketId}/{hookId}","href":"/endpoints/lending/update-hook"},{"title":"Delete Hook","api":"DELETE /lending-external-securities-v2/api/hooks/{marketId}/{hookId}","href":"/endpoints/lending/delete-hook"},{"title":"Toggle Hook","api":"POST /lending-external-securities-v2/api/hooks/{marketId}/{hookId}/toggle","href":"/endpoints/lending/toggle-hook"},{"title":"Execute Hook","api":"POST /lending-external-securities-v2/api/hooks/{marketId}/{hookId}/execute","href":"/endpoints/lending/execute-hook"},{"title":"Get Hook Executions","api":"GET /lending-external-securities-v2/api/hooks/{marketId}/{hookId}/executions","href":"/endpoints/lending/get-hook-executions"},{"title":"List Hook Deliveries","api":"GET /lending-external-securities-v2/api/hooks/{marketId}/{hookId}/deliveries","href":"/endpoints/lending/list-hook-deliveries"},{"title":"Rotate Hook Secret","api":"POST /lending-external-securities-v2/api/hooks/{marketId}/{hookId}/rotate-secret","href":"/endpoints/lending/rotate-hook-secret"}]},{"group":"Liquidation Bots","pages":[{"title":"List Liquidation Bots","api":"GET /lending-external-securities-v2/api/liquidation-bots","href":"/endpoints/lending/list-bots"},{"title":"Deploy Liquidation Bot","api":"POST /lending-external-securities-v2/api/liquidation-bots","href":"/endpoints/lending/deploy-bot"},{"title":"Confirm Bot Deployment","api":"POST /lending-external-securities-v2/api/liquidation-bots/confirm-deploy","href":"/endpoints/lending/confirm-bot-deployment"},{"title":"Get Liquidation Bot","api":"GET /lending-external-securities-v2/api/liquidation-bots/{botId}","href":"/endpoints/lending/get-bot"},{"title":"List Bot Transactions","api":"GET /lending-external-securities-v2/api/liquidation-bots/{botId}/transactions","href":"/endpoints/lending/list-bot-transactions"},{"title":"Connect Bot to Market","api":"POST /lending-external-securities-v2/api/liquidation-bots/{botId}/connect","href":"/endpoints/lending/connect-bot"},{"title":"Bot Owner Action","api":"POST /lending-external-securities-v2/api/liquidation-bots/{botId}/action","href":"/endpoints/lending/bot-action"},{"title":"Fund Bot","api":"POST /lending-external-securities-v2/api/liquidation-bots/{botId}/fund","href":"/endpoints/lending/fund-bot"},{"title":"Confirm Bot Transaction","api":"POST /lending-external-securities-v2/api/liquidation-bots/{botId}/confirm-tx","href":"/endpoints/lending/confirm-bot-transaction"},{"title":"Update Bot","api":"PATCH /lending-external-securities-v2/api/liquidation-bots/{botId}","href":"/endpoints/lending/update-bot"}]}]},{"group":"Operators","pages":[{"title":"Operators","href":"/endpoints/operators/introduction"},{"group":"Queue","pages":[{"title":"List Pending Markets","api":"GET /lending-external-securities-v2/api/markets/queue/pending","href":"/endpoints/operators/list-pending-markets"},{"title":"List Queued Markets","api":"GET /lending-external-securities-v2/api/markets/queued","href":"/endpoints/operators/list-queued-markets"},{"title":"Get Queued Market","api":"GET /lending-external-securities-v2/api/markets/queued/{marketAddress}/details","href":"/endpoints/operators/get-queued-market"},{"title":"Accept Lender Role","api":"POST /lending-external-securities-v2/api/markets/queued/{marketAddress}/accept","href":"/endpoints/operators/accept-lender-role"},{"title":"Confirm Lender Role","api":"POST /lending-external-securities-v2/api/markets/queued/{marketAddress}/confirm-accept","href":"/endpoints/operators/confirm-lender-role"}]},{"group":"Standing Policies","pages":[{"title":"List Standing Policies","api":"GET /lending-external-securities-v2/api/markets/standing-policies","href":"/endpoints/operators/list-standing-policies"},{"title":"Create Standing Policy","api":"POST /lending-external-securities-v2/api/markets/standing-policies","href":"/endpoints/operators/create-standing-policy"},{"title":"Update Standing Policy","api":"PUT /lending-external-securities-v2/api/markets/standing-policies/{policyId}","href":"/endpoints/operators/update-standing-policy"},{"title":"Delete Standing Policy","api":"DELETE /lending-external-securities-v2/api/markets/standing-policies/{policyId}","href":"/endpoints/operators/delete-standing-policy"}]},{"group":"Lender of Record","pages":[{"title":"Get Operator","api":"GET /lending-external-securities-v2/api/markets/{marketId}/operator","href":"/endpoints/operators/get-operator"},{"title":"Get Handover","api":"GET /lending-external-securities-v2/api/markets/{marketId}/handover","href":"/endpoints/operators/get-handover"}]},{"group":"Roles","pages":[{"title":"Get Access Role","api":"GET /lending-external-securities-v2/api/markets/{marketId}/access-role/{address}","href":"/endpoints/operators/get-access-role"},{"title":"Set Access Role","api":"POST /lending-external-securities-v2/api/markets/{marketId}/access-role","href":"/endpoints/operators/set-access-role"},{"title":"Set Liquidator Role","api":"POST /lending-external-securities-v2/api/markets/{marketId}/liquidator-role","href":"/endpoints/operators/set-liquidator-role"}]}]},{"group":"Vaults","pages":[{"title":"Vaults","href":"/endpoints/vaults/introduction"},{"group":"Queries","pages":[{"title":"List Vaults","api":"GET /lending-external-securities-v2/api/vaults","href":"/endpoints/vaults/list-vaults"},{"title":"Get Vault","api":"GET /lending-external-securities-v2/api/vaults/{vaultId}","href":"/endpoints/vaults/get-vault"}]},{"group":"Vault Groups","pages":[{"title":"Get Vault Group","api":"GET /lending-external-securities-v2/api/vaults/groups/{groupId}","href":"/endpoints/vaults/get-vault-group"},{"title":"Deposit to Vault Group","api":"POST /lending-external-securities-v2/api/vaults/groups/{groupId}/deposit","href":"/endpoints/vaults/deposit-to-vault-group"}]},{"group":"Positions","pages":[{"title":"Get Position","api":"GET /lending-external-securities-v2/api/vaults/{vaultId}/position/{holderAddress}","href":"/endpoints/vaults/get-position"},{"title":"List Transactions","api":"GET /lending-external-securities-v2/api/vaults/{vaultId}/transactions","href":"/endpoints/vaults/list-vault-transactions"}]},{"group":"Deposits \u0026 Redemptions","pages":[{"title":"Deposit","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/deposit","href":"/endpoints/vaults/deposit"},{"title":"Redeem","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/redeem","href":"/endpoints/vaults/redeem"},{"title":"Confirm Transaction","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/confirm-tx","href":"/endpoints/vaults/confirm-transaction"}]},{"group":"Distributor Fees","pages":[{"title":"Get Earnings","api":"GET /lending-external-securities-v2/api/vaults/{vaultId}/earnings","href":"/endpoints/vaults/get-earnings"},{"title":"Collect Distributor Fees","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/distributor-fees/collect","href":"/endpoints/vaults/collect-distributor-fees"},{"title":"Pay Distributor","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/distributor-fees/pay","href":"/endpoints/vaults/pay-distributor"},{"title":"Pay Operator Fees","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/operator-fees/pay","href":"/endpoints/vaults/pay-operator-fees"},{"title":"Set Distributor Wallet","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/distributor-wallet","href":"/endpoints/vaults/set-distributor-wallet"},{"title":"Set Distributor Approval","api":"POST /lending-external-securities-v2/api/vaults/{vaultId}/distributor-approval","href":"/endpoints/vaults/set-distributor-approval"}]},{"group":"Administration","pages":[{"title":"Vault Roles","href":"/endpoints/vaults/vault-roles"}]}]},{"group":"Asset Register","pages":[{"title":"Asset Register","href":"/endpoints/asset-register/introduction"},{"group":"Register","pages":[{"title":"List Asset Registers","api":"GET /asset-registers/api/directory","href":"/endpoints/asset-register/list-registers"},{"title":"Get Market Register","api":"GET /asset-registers/api/markets/{marketAddress}/register","href":"/endpoints/asset-register/get-market-register"},{"title":"Set Market Register","api":"PUT /asset-registers/api/markets/{marketAddress}/register","href":"/endpoints/asset-register/set-market-register"},{"title":"Clear Market Register","api":"DELETE /asset-registers/api/markets/{marketAddress}/register","href":"/endpoints/asset-register/clear-market-register"}]},{"group":"Markets","pages":[{"title":"List Register Queue","api":"GET /asset-registers/api/queue","href":"/endpoints/asset-register/list-register-queue"},{"title":"Import Market","api":"POST /asset-registers/api/markets/import","href":"/endpoints/asset-register/import-market"},{"title":"Decline Market","api":"POST /asset-registers/api/markets/{marketAddress}/decline","href":"/endpoints/asset-register/decline-market"},{"title":"List Register Markets","api":"GET /asset-registers/api/markets","href":"/endpoints/asset-register/list-register-markets"}]},{"group":"Pledges","pages":[{"title":"List Pledges","api":"GET /lending-external-securities-v2/api/pledges/{marketAddress}","href":"/endpoints/asset-register/list-pledges"}]},{"group":"Webhooks","pages":[{"title":"Pledge Webhooks","href":"/endpoints/asset-register/pledge-webhooks"}]}]},{"group":"Financing","pages":[{"title":"Financing","href":"/endpoints/seller-financing/introduction"},{"group":"Markets","pages":[{"title":"List Markets","api":"GET /seller-financing/api/markets","href":"/endpoints/seller-financing/list-markets"},{"title":"Get Market","api":"GET /seller-financing/api/markets/{marketId}","href":"/endpoints/seller-financing/get-market"}]},{"group":"Deployment","pages":[{"title":"Get Deployment Options","api":"GET /seller-financing/api/markets/options","href":"/endpoints/seller-financing/get-deployment-options"},{"title":"Build Deployment","api":"POST /seller-financing/api/markets","href":"/endpoints/seller-financing/deploy-market"},{"title":"Record Deployment","api":"POST /seller-financing/api/markets/confirm","href":"/endpoints/seller-financing/confirm-deployment"},{"title":"Build Token Setup","api":"POST /seller-financing/api/markets/{marketId}/token-setup","href":"/endpoints/seller-financing/token-setup"},{"title":"Get Role Audit","api":"GET /seller-financing/api/markets/{marketId}/role-audit","href":"/endpoints/seller-financing/get-role-audit"},{"title":"Get Role Certificate","api":"GET /seller-financing/api/markets/{marketId}/role-audit/certificate","href":"/endpoints/seller-financing/get-role-certificate"}]},{"group":"Listings","pages":[{"title":"List Listings","api":"GET /seller-financing/api/markets/{marketId}/listings","href":"/endpoints/seller-financing/list-listings"},{"title":"Get Listing","api":"GET /seller-financing/api/markets/{marketId}/listings/{listingId}","href":"/endpoints/seller-financing/get-listing"},{"title":"Get Quote","api":"GET /seller-financing/api/markets/{marketId}/quote","href":"/endpoints/seller-financing/quote-terms"},{"title":"Create Listing","api":"POST /seller-financing/api/markets/{marketId}/listings","href":"/endpoints/seller-financing/create-listing"},{"title":"Cancel Listing","api":"POST /seller-financing/api/markets/{marketId}/listings/{listingId}/cancel","href":"/endpoints/seller-financing/cancel-listing"}]},{"group":"Loans","pages":[{"title":"Purchase","api":"POST /seller-financing/api/markets/{marketId}/listings/{listingId}/purchase","href":"/endpoints/seller-financing/purchase"},{"title":"Get Loan Status","api":"GET /seller-financing/api/markets/{marketId}/listings/{listingId}/status","href":"/endpoints/seller-financing/get-loan-status"},{"title":"Repay","api":"POST /seller-financing/api/markets/{marketId}/listings/{listingId}/repay","href":"/endpoints/seller-financing/repay"},{"title":"Claim Asset","api":"POST /seller-financing/api/markets/{marketId}/listings/{listingId}/claim-asset","href":"/endpoints/seller-financing/claim-asset"},{"title":"Liquidate","api":"POST /seller-financing/api/markets/{marketId}/listings/{listingId}/liquidate","href":"/endpoints/seller-financing/liquidate"}]},{"group":"Payouts","pages":[{"title":"Get Claimable","api":"GET /seller-financing/api/markets/{marketId}/claimable/{address}","href":"/endpoints/seller-financing/get-claimable"},{"title":"Withdraw","api":"POST /seller-financing/api/markets/{marketId}/withdraw","href":"/endpoints/seller-financing/withdraw"},{"title":"Claim Escrowed Collateral","api":"POST /seller-financing/api/markets/{marketId}/claim-escrowed-collateral","href":"/endpoints/seller-financing/claim-escrowed-collateral"}]},{"group":"Administration","pages":[{"title":"Update Configuration","api":"POST /seller-financing/api/markets/{marketId}/config","href":"/endpoints/seller-financing/update-config"},{"title":"Set Identity Register","api":"POST /seller-financing/api/markets/{marketId}/identity-registry","href":"/endpoints/seller-financing/set-identity-registry"},{"title":"Pause Market","api":"POST /seller-financing/api/markets/{marketId}/pause","href":"/endpoints/seller-financing/pause-market"},{"title":"Unpause Market","api":"POST /seller-financing/api/markets/{marketId}/unpause","href":"/endpoints/seller-financing/unpause-market"}]}]}]},{"group":"Identity","pages":[{"group":"Customers","pages":[{"title":"Customers","href":"/endpoints/customers/introduction"},{"group":"Management","pages":[{"title":"List Customers","api":"GET /customers/api/manage","href":"/endpoints/customers/list"},{"title":"Create Customer","api":"POST /customers/api/manage","href":"/endpoints/customers/create"},{"title":"Get Customer","api":"GET /customers/api/manage/{identifier}","href":"/endpoints/customers/get"},{"title":"Get Lending Positions","api":"GET /customers/api/manage/{customerId}/lending-positions","href":"/endpoints/customers/get-lending-positions"},{"title":"Update Customer","api":"PUT /customers/api/manage/{customerId}","href":"/endpoints/customers/update"},{"title":"Archive Customer","api":"DELETE /customers/api/manage/{customerId}","href":"/endpoints/customers/archive"},{"title":"Batch Get Countries","api":"POST /customers/api/manage/countries/batch","href":"/endpoints/customers/batch-countries"}]},{"group":"Wallets","pages":[{"title":"Link Wallet","api":"POST /customers/api/manage/link-wallet","href":"/endpoints/customers/link-wallet"},{"title":"List Wallets","api":"GET /customers/api/manage/{customerId}/wallets","href":"/endpoints/customers/list-wallets"},{"title":"Add Wallet","api":"POST /customers/api/manage/{customerId}/wallets","href":"/endpoints/customers/add-wallet"},{"title":"Promote Wallet","api":"POST /customers/api/manage/{customerId}/wallets/{address}/promote","href":"/endpoints/customers/promote-wallet"},{"title":"Remove Wallet","api":"DELETE /customers/api/manage/{customerId}/wallets/{address}","href":"/endpoints/customers/remove-wallet"}]},{"group":"Identity Verification","pages":[{"title":"Verify Identity","api":"POST /customers/api/identity/verify","href":"/endpoints/customers/verify-identity"},{"title":"Batch Verify Identities","api":"POST /customers/api/identity/batch-verify","href":"/endpoints/customers/batch-verify"},{"title":"Revoke Identity","api":"POST /customers/api/identity/revoke","href":"/endpoints/customers/revoke-identity"},{"title":"Identity Status","api":"GET /customers/api/identity/status/{walletAddress}","href":"/endpoints/customers/identity-status"},{"title":"Check Transfer Compliance","api":"POST /customers/api/identity/can-transfer","href":"/endpoints/customers/can-transfer"},{"title":"List Verification Profiles","api":"GET /customers/api/verification-profiles","href":"/endpoints/customers/list-verification-profiles"},{"title":"Deploy ONCHAINID","api":"POST /customers/api/identity/onchainid","href":"/endpoints/customers/deploy-onchainid"},{"title":"Confirm ONCHAINID","api":"POST /customers/api/identity/onchainid/confirm","href":"/endpoints/customers/confirm-onchainid"}]},{"group":"Pending Approvals","pages":[{"title":"List Pending Verifications","api":"GET /customers/api/identity/pending","href":"/endpoints/customers/list-pending-verifications"},{"title":"Build Pending Registration","api":"POST /customers/api/identity/pending/calldata","href":"/endpoints/customers/build-pending-registration"},{"title":"Confirm Pending Registration","api":"POST /customers/api/identity/pending/confirm","href":"/endpoints/customers/confirm-pending-registration"},{"title":"Dismiss Pending Verification","api":"POST /customers/api/identity/pending/{id}/dismiss","href":"/endpoints/customers/dismiss-pending-verification"}]},{"group":"Eligibility Registers","pages":[{"title":"List Eligibility Profiles","api":"GET /customers/api/eligibility/profiles","href":"/endpoints/customers/list-eligibility-profiles"},{"title":"List Admissions","api":"GET /customers/api/eligibility/admissions","href":"/endpoints/customers/list-admissions"},{"title":"Get Wallet Eligibility","api":"GET /customers/api/eligibility/wallet/{walletAddress}","href":"/endpoints/customers/get-wallet-eligibility"},{"title":"Request Admission","api":"POST /customers/api/eligibility/admissions","href":"/endpoints/customers/request-admission"},{"title":"Build Admission","api":"POST /customers/api/eligibility/admissions/calldata","href":"/endpoints/customers/build-admission"},{"title":"Confirm Admission","api":"POST /customers/api/eligibility/admissions/confirm","href":"/endpoints/customers/confirm-admission"},{"title":"Request Removal","api":"POST /customers/api/eligibility/removals","href":"/endpoints/customers/request-removal"},{"title":"Build Removal","api":"POST /customers/api/eligibility/removals/calldata","href":"/endpoints/customers/build-removal"},{"title":"Confirm Removal","api":"POST /customers/api/eligibility/removals/confirm","href":"/endpoints/customers/confirm-removal"}]},{"group":"KYC Proofs","pages":[{"title":"Set Operator Key","api":"PUT /customers/api/identity/operator-key","href":"/endpoints/customers/set-operator-key"},{"title":"Get Operator Key","api":"GET /customers/api/identity/operator-key","href":"/endpoints/customers/get-operator-key"},{"title":"Inspect Manifest","api":"POST /customers/api/identity/manifest/inspect","href":"/endpoints/customers/inspect-manifest"},{"title":"Add Claims from Proof","api":"POST /customers/api/identity/claims/from-proof","href":"/endpoints/customers/add-claims-from-proof"},{"title":"Attest Proofs","api":"POST /customers/api/identity/proofs","href":"/endpoints/customers/attest-proofs"},{"title":"List Proofs","api":"GET /customers/api/identity/proofs/{walletAddress}","href":"/endpoints/customers/list-proofs"},{"title":"Revoke Proof","api":"POST /customers/api/identity/proofs/revoke","href":"/endpoints/customers/revoke-proof"},{"title":"List Claims","api":"GET /customers/api/identity/claims/{walletAddress}","href":"/endpoints/customers/list-claims"},{"title":"Add Claim","api":"POST /customers/api/identity/add-claim","href":"/endpoints/customers/add-claim"},{"title":"Revoke Claim","api":"POST /customers/api/identity/revoke-claim","href":"/endpoints/customers/revoke-claim"}]},{"group":"KYC Sources","pages":[{"title":"Get Record Key","api":"GET /customers/api/kyc-records/recipient-key","href":"/endpoints/customers/get-kyc-record-key"},{"title":"Set Record Key","api":"PUT /customers/api/kyc-records/recipient-key","href":"/endpoints/customers/set-kyc-record-key"},{"title":"List KYC Sources","api":"GET /customers/api/kyc-sources","href":"/endpoints/customers/list-kyc-sources"},{"title":"Add KYC Source","api":"POST /customers/api/kyc-sources","href":"/endpoints/customers/add-kyc-source"},{"title":"Update KYC Source","api":"PATCH /customers/api/kyc-sources/{sourceId}","href":"/endpoints/customers/update-kyc-source"},{"title":"Reissue Source Invite","api":"POST /customers/api/kyc-sources/{sourceId}/invite","href":"/endpoints/customers/reissue-kyc-source-invite"},{"title":"Remove KYC Source","api":"DELETE /customers/api/kyc-sources/{sourceId}","href":"/endpoints/customers/remove-kyc-source"}]},{"group":"Sealed KYC Records","pages":[{"title":"List KYC Records","api":"GET /customers/api/kyc-records","href":"/endpoints/customers/list-kyc-records"},{"title":"Get KYC Record","api":"GET /customers/api/kyc-records/{recordId}","href":"/endpoints/customers/get-kyc-record"},{"title":"Download Envelope","api":"GET /customers/api/kyc-records/{recordId}/envelope","href":"/endpoints/customers/get-kyc-record-envelope"},{"title":"Open KYC Record","api":"POST /customers/api/kyc-records/{recordId}/open","href":"/endpoints/customers/open-kyc-record"},{"title":"Reject KYC Record","api":"POST /customers/api/kyc-records/{recordId}/reject","href":"/endpoints/customers/reject-kyc-record"},{"title":"Approve KYC Record","api":"POST /customers/api/kyc-records/{recordId}/approve","href":"/endpoints/customers/approve-kyc-record"},{"title":"Confirm Record Admission","api":"POST /customers/api/kyc-records/{recordId}/admission/confirm","href":"/endpoints/customers/confirm-kyc-record-admission"},{"title":"Build Record Removal","api":"POST /customers/api/kyc-records/{recordId}/removal","href":"/endpoints/customers/build-kyc-record-removal"},{"title":"Confirm Record Removal","api":"POST /customers/api/kyc-records/{recordId}/removal/confirm","href":"/endpoints/customers/confirm-kyc-record-removal"}]},{"group":"Onboarding","pages":[{"title":"Onboarding","href":"/endpoints/customers/onboarding"},{"title":"Onboarding Options","api":"GET /customers/api/onboarding/options","href":"/endpoints/customers/onboarding-options"},{"title":"Start Onboarding","api":"POST /customers/api/onboarding","href":"/endpoints/customers/start-onboarding"},{"title":"Get Onboarding","api":"GET /customers/api/onboarding/{customer}","href":"/endpoints/customers/get-onboarding"},{"title":"Issue SDK Token","api":"POST /customers/api/onboarding/{customer}/token","href":"/endpoints/customers/issue-onboarding-token"},{"title":"Bind Wallet","api":"POST /customers/api/onboarding/{customer}/wallet","href":"/endpoints/customers/bind-onboarding-wallet"},{"title":"Recheck Onboarding","api":"POST /customers/api/onboarding/{customer}/recheck","href":"/endpoints/customers/recheck-onboarding"},{"title":"Decide Record","api":"POST /customers/api/onboarding/{customer}/decision","href":"/endpoints/customers/decide-onboarding-record"},{"title":"Build Transactions","api":"POST /customers/api/onboarding/{customer}/transactions","href":"/endpoints/customers/build-onboarding-transactions"},{"title":"Confirm Transactions","api":"POST /customers/api/onboarding/{customer}/transactions/confirm","href":"/endpoints/customers/confirm-onboarding-transactions"},{"title":"Cancel Onboarding","api":"POST /customers/api/onboarding/{customer}/cancel","href":"/endpoints/customers/cancel-onboarding"}]},{"group":"ID Links","pages":[{"title":"Create ID Link","api":"POST /customers/api/id-links","href":"/endpoints/customers/create-id-link"},{"title":"List ID Links","api":"GET /customers/api/id-links","href":"/endpoints/customers/list-id-links"},{"title":"Get ID Link","api":"GET /customers/api/id-links/{linkId}","href":"/endpoints/customers/get-id-link"},{"title":"Issue Sumsub Token","api":"POST /customers/api/id-links/{linkId}/sumsub-token","href":"/endpoints/customers/issue-sumsub-token"},{"title":"Bind Link Wallet","api":"POST /customers/api/id-links/{linkId}/wallet","href":"/endpoints/customers/bind-link-wallet"},{"title":"Recheck Link Review","api":"POST /customers/api/id-links/{linkId}/recheck","href":"/endpoints/customers/recheck-link-review"},{"title":"Revoke ID Link","api":"PUT /customers/api/id-links/{linkId}/revoke","href":"/endpoints/customers/revoke-id-link"},{"title":"Resend ID Link","api":"POST /customers/api/id-links/{linkId}/resend","href":"/endpoints/customers/resend-id-link"}]},{"group":"Disclosure Requests","pages":[{"title":"List Disclosure Requests","api":"GET /customers/api/disclosure-requests","href":"/endpoints/customers/list-disclosure-requests"},{"title":"Create Disclosure Request","api":"POST /customers/api/disclosure-requests","href":"/endpoints/customers/create-disclosure-request"},{"title":"Get Disclosure Request","api":"GET /customers/api/disclosure-requests/{id}","href":"/endpoints/customers/get-disclosure-request"},{"title":"Cancel Disclosure Request","api":"POST /customers/api/disclosure-requests/{id}/cancel","href":"/endpoints/customers/cancel-disclosure-request"}]}]},{"group":"KYC Inbox","pages":[{"title":"KYC Inbox","href":"/endpoints/kyc-inbox/introduction"},{"group":"Deliveries","pages":[{"title":"Describe Inbox","api":"GET /kyc-inbox/{sourceId}","href":"/endpoints/kyc-inbox/get-inbox"},{"title":"Deliver Record","api":"POST /kyc-inbox/{sourceId}/records","href":"/endpoints/kyc-inbox/deliver-record"},{"title":"Get Delivery Status","api":"GET /kyc-inbox/{sourceId}/records/{envelopeId}","href":"/endpoints/kyc-inbox/get-delivery-status"},{"title":"Revoke Record","api":"POST /kyc-inbox/{sourceId}/revocations","href":"/endpoints/kyc-inbox/revoke-record"}]}]}]},{"group":"Assets","pages":[{"group":"Token imports","pages":[{"title":"Token imports","href":"/endpoints/tokenization/introduction"},{"group":"Importing","pages":[{"title":"Detect Token","api":"POST /external-tokens/api/detect","href":"/endpoints/tokenization/detect-token"},{"title":"Import Token","api":"POST /external-tokens/api/import","href":"/endpoints/tokenization/import-token"},{"title":"List Imports","api":"GET /external-tokens/api/list","href":"/endpoints/tokenization/list-imports"},{"title":"Get Import","api":"GET /external-tokens/api/{tokenAddress}","href":"/endpoints/tokenization/get-import"},{"title":"Refresh On-Chain State","api":"GET /external-tokens/api/{tokenAddress}/onchain","href":"/endpoints/tokenization/refresh-onchain"},{"title":"Update Profile","api":"PUT /external-tokens/api/{tokenAddress}/profile","href":"/endpoints/tokenization/update-profile"},{"title":"Update Image","api":"PUT /external-tokens/api/{tokenAddress}/image","href":"/endpoints/tokenization/update-image"},{"title":"Update Label","api":"PUT /external-tokens/api/{tokenAddress}/label","href":"/endpoints/tokenization/update-label"},{"title":"Upload File","api":"POST /external-tokens/api/upload","href":"/endpoints/tokenization/upload-file"},{"title":"Remove Import","api":"DELETE /external-tokens/api/{tokenAddress}","href":"/endpoints/tokenization/remove-import"}]},{"group":"Instrument Record","pages":[{"title":"Issuer-Signed Instrument Record","href":"/endpoints/tokenization/issuer-signed-record"},{"title":"Get Instrument Schema","api":"GET /instruments/api/schema","href":"/endpoints/tokenization/get-instrument-schema"},{"title":"Get Instrument","api":"GET /instruments/api/{tokenAddress}","href":"/endpoints/tokenization/get-instrument"},{"title":"Request Instrument Approval","api":"POST /instruments/api/{tokenAddress}/approval-request","href":"/endpoints/tokenization/request-instrument-approval"},{"title":"Save Instrument","api":"PUT /instruments/api/{tokenAddress}","href":"/endpoints/tokenization/save-instrument"},{"title":"Release Instrument","api":"DELETE /instruments/api/{tokenAddress}","href":"/endpoints/tokenization/release-instrument"}]}]},{"group":"Trading","pages":[{"group":"Stock Trading","pages":[{"title":"Stock Trading","href":"/endpoints/stock-trading/introduction"},{"group":"Order Books","pages":[{"title":"Create Order Book","api":"POST /orderbooks/stocks/api/order-books","href":"/endpoints/stock-trading/create-order-book"},{"title":"Get Order Book","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}","href":"/endpoints/stock-trading/get-order-book"},{"title":"List Order Books","api":"GET /orderbooks/stocks/api/order-books","href":"/endpoints/stock-trading/list-order-books"},{"title":"Update Order Book","api":"PATCH /orderbooks/stocks/api/order-books/{orderBookId}","href":"/endpoints/stock-trading/update-order-book"},{"title":"Get Trade Readiness","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/readiness","href":"/endpoints/stock-trading/get-trade-readiness"},{"title":"Get Shared Peers","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/shared-peers","href":"/endpoints/stock-trading/get-shared-peers"},{"title":"List Importable Order Books","api":"GET /orderbooks/stocks/api/order-books/importable","href":"/endpoints/stock-trading/list-importable"},{"title":"Import Order Book","api":"POST /orderbooks/stocks/api/imports","href":"/endpoints/stock-trading/import-order-book"},{"title":"Remove Import","api":"DELETE /orderbooks/stocks/api/imports/{importId}","href":"/endpoints/stock-trading/remove-import"}]},{"group":"Orders","pages":[{"title":"Submit Order","api":"POST /orderbooks/stocks/api/orders","href":"/endpoints/stock-trading/submit-order"},{"title":"Submit Priority Order","api":"POST /orderbooks/stocks/api/orders/priority","href":"/endpoints/stock-trading/submit-priority-order"},{"title":"Cancel Order","api":"DELETE /orderbooks/stocks/api/orders/{orderId}","href":"/endpoints/stock-trading/cancel-order"},{"title":"Get Order","api":"GET /orderbooks/stocks/api/orders/{orderId}","href":"/endpoints/stock-trading/get-order"},{"title":"Get User Orders","api":"GET /orderbooks/stocks/api/users/{userAddress}/orders","href":"/endpoints/stock-trading/get-user-orders"},{"title":"Get User Trades","api":"GET /orderbooks/stocks/api/users/{userAddress}/trades","href":"/endpoints/stock-trading/get-user-trades"}]},{"group":"Market Data","pages":[{"title":"Get Order Book Snapshot","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/snapshot","href":"/endpoints/stock-trading/get-order-book-snapshot"},{"title":"Get Order Book Trades","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/trades","href":"/endpoints/stock-trading/get-order-book-trades"},{"title":"Get Order Book Stats","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/stats","href":"/endpoints/stock-trading/get-order-book-stats"},{"title":"Get Daily Stats","api":"GET /orderbooks/stocks/api/order-books/by-token/{tokenAddress}/daily-stats","href":"/endpoints/stock-trading/get-daily-stats"},{"title":"Get Settlement","api":"GET /orderbooks/stocks/api/settlements/{settlementId}","href":"/endpoints/stock-trading/get-settlement"},{"title":"Get Custody Balance","api":"GET /orderbooks/stocks/api/custody/{custodyContract}/balance/{userAddress}/{tokenAddress}","href":"/endpoints/stock-trading/get-custody-balance"}]},{"group":"Price Reference","pages":[{"title":"Set Price Reference","api":"POST /orderbooks/stocks/api/order-books/{orderBookId}/price-reference","href":"/endpoints/stock-trading/set-price-reference"},{"title":"Get Price Reference","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/price-reference","href":"/endpoints/stock-trading/get-price-reference"},{"title":"Get Price Reference History","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/price-reference/history","href":"/endpoints/stock-trading/get-price-reference-history"}]},{"group":"Auctions","pages":[{"title":"Get Current Auction","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/auctions/current","href":"/endpoints/stock-trading/get-current-auction"},{"title":"Get Auction","api":"GET /orderbooks/stocks/api/order-books/{orderBookId}/auctions/{auctionId}","href":"/endpoints/stock-trading/get-auction"}]},{"group":"Request for Quote (RFQ)","pages":[{"title":"Create RFQ","api":"POST /orderbooks/stocks/api/rfq","href":"/endpoints/stock-trading/create-rfq"},{"title":"Get RFQ","api":"GET /orderbooks/stocks/api/rfq/{id}","href":"/endpoints/stock-trading/get-rfq"},{"title":"List RFQ Quotes","api":"GET /orderbooks/stocks/api/rfq/{id}/quotes","href":"/endpoints/stock-trading/list-rfq-quotes"},{"title":"Accept Quote","api":"POST /orderbooks/stocks/api/rfq/{id}/accept","href":"/endpoints/stock-trading/accept-rfq-quote"},{"title":"Cancel RFQ","api":"POST /orderbooks/stocks/api/rfq/{id}/cancel","href":"/endpoints/stock-trading/cancel-rfq"}]},{"group":"Off-Chain Settlement","pages":[{"title":"Create Off-Chain Order Book","api":"POST /orderbooks/stocks/api/offchain/order-books","href":"/endpoints/stock-trading/offchain-create-order-book"},{"title":"List Off-Chain Order Books","api":"GET /orderbooks/stocks/api/offchain/order-books","href":"/endpoints/stock-trading/offchain-list-order-books"},{"title":"Get Off-Chain Order Book","api":"GET /orderbooks/stocks/api/offchain/order-books/{orderBookId}","href":"/endpoints/stock-trading/offchain-get-order-book"},{"title":"Submit Off-Chain Order","api":"POST /orderbooks/stocks/api/offchain/orders","href":"/endpoints/stock-trading/offchain-submit-order"},{"title":"Cancel Off-Chain Order","api":"DELETE /orderbooks/stocks/api/offchain/orders/{orderId}","href":"/endpoints/stock-trading/offchain-cancel-order"},{"title":"Get Customer Orders","api":"GET /orderbooks/stocks/api/offchain/customers/{customerRef}/orders","href":"/endpoints/stock-trading/offchain-get-customer-orders"},{"title":"Get Customer Trades","api":"GET /orderbooks/stocks/api/offchain/customers/{customerRef}/trades","href":"/endpoints/stock-trading/offchain-get-customer-trades"},{"title":"Get Off-Chain Snapshot","api":"GET /orderbooks/stocks/api/offchain/order-books/{orderBookId}/snapshot","href":"/endpoints/stock-trading/offchain-get-snapshot"},{"title":"Get Off-Chain Trades","api":"GET /orderbooks/stocks/api/offchain/order-books/{orderBookId}/trades","href":"/endpoints/stock-trading/offchain-get-trades"},{"title":"Set Off-Chain Price Reference","api":"POST /orderbooks/stocks/api/offchain/order-books/{orderBookId}/price-reference","href":"/endpoints/stock-trading/offchain-set-price-reference"},{"title":"Get Off-Chain Price Reference","api":"GET /orderbooks/stocks/api/offchain/order-books/{orderBookId}/price-reference","href":"/endpoints/stock-trading/offchain-get-price-reference"}]}]},{"group":"External Securities Trading","pages":[{"title":"External Securities Trading","href":"/endpoints/external-securities-trading/introduction"},{"group":"Venue","pages":[{"title":"Get Custody Contract","api":"GET /orderbooks/external-securities/api/custody-contract","href":"/endpoints/external-securities-trading/get-custody-contract"},{"title":"List Security Tokens","api":"GET /orderbooks/external-securities/api/security-tokens","href":"/endpoints/external-securities-trading/list-security-tokens"}]},{"group":"Order Books","pages":[{"title":"Create Order Book","api":"POST /orderbooks/external-securities/api/order-books","href":"/endpoints/external-securities-trading/create-order-book"},{"title":"Get Order Book","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}","href":"/endpoints/external-securities-trading/get-order-book"},{"title":"List Order Books","api":"GET /orderbooks/external-securities/api/order-books","href":"/endpoints/external-securities-trading/list-order-books"},{"title":"Update Order Book","api":"PATCH /orderbooks/external-securities/api/order-books/{orderBookId}","href":"/endpoints/external-securities-trading/update-order-book"},{"title":"Get Trade Readiness","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/readiness","href":"/endpoints/external-securities-trading/get-trade-readiness"},{"title":"Get Security Status","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/security","href":"/endpoints/external-securities-trading/get-security-status"},{"title":"Get Order Book Access","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/access","href":"/endpoints/external-securities-trading/get-order-book-access"},{"title":"Get Shared Peers","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/shared-peers","href":"/endpoints/external-securities-trading/get-shared-peers"},{"title":"List Importable Order Books","api":"GET /orderbooks/external-securities/api/order-books/importable","href":"/endpoints/external-securities-trading/list-importable"},{"title":"Import Order Book","api":"POST /orderbooks/external-securities/api/imports","href":"/endpoints/external-securities-trading/import-order-book"},{"title":"Remove Import","api":"DELETE /orderbooks/external-securities/api/imports/{importId}","href":"/endpoints/external-securities-trading/remove-import"}]},{"group":"Orders","pages":[{"title":"Prepare Order","api":"POST /orderbooks/external-securities/api/orders/prepare","href":"/endpoints/external-securities-trading/prepare-order"},{"title":"Submit Order","api":"POST /orderbooks/external-securities/api/orders","href":"/endpoints/external-securities-trading/submit-order"},{"title":"Cancel Order","api":"DELETE /orderbooks/external-securities/api/orders/{orderId}","href":"/endpoints/external-securities-trading/cancel-order"},{"title":"Cancel Orders On Chain","api":"POST /orderbooks/external-securities/api/orders/cancel-on-chain","href":"/endpoints/external-securities-trading/cancel-on-chain"},{"title":"Approve Settlement Asset","api":"POST /orderbooks/external-securities/api/order-books/{orderBookId}/quote-approval","href":"/endpoints/external-securities-trading/approve-quote-asset"},{"title":"Approve Security","api":"POST /orderbooks/external-securities/api/order-books/{orderBookId}/security-approval","href":"/endpoints/external-securities-trading/approve-security"},{"title":"Get Order","api":"GET /orderbooks/external-securities/api/orders/{orderId}","href":"/endpoints/external-securities-trading/get-order"},{"title":"Get User Orders","api":"GET /orderbooks/external-securities/api/users/{userAddress}/orders","href":"/endpoints/external-securities-trading/get-user-orders"},{"title":"Get User Trades","api":"GET /orderbooks/external-securities/api/users/{userAddress}/trades","href":"/endpoints/external-securities-trading/get-user-trades"}]},{"group":"Settlement","pages":[{"title":"List Pending Settlements","api":"GET /orderbooks/external-securities/api/settlements/pending","href":"/endpoints/external-securities-trading/list-pending-settlements"},{"title":"Get Settlement","api":"GET /orderbooks/external-securities/api/settlements/{settlementId}","href":"/endpoints/external-securities-trading/get-settlement"},{"title":"Get Settlement Calldata","api":"GET /orderbooks/external-securities/api/settlements/{settlementId}/calldata","href":"/endpoints/external-securities-trading/get-settlement-calldata"},{"title":"Confirm Settlement","api":"POST /orderbooks/external-securities/api/settlements/{settlementId}/confirm","href":"/endpoints/external-securities-trading/confirm-settlement"}]},{"group":"Market Data","pages":[{"title":"Get Order Book Snapshot","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/snapshot","href":"/endpoints/external-securities-trading/get-order-book-snapshot"},{"title":"Get Order Book Trades","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/trades","href":"/endpoints/external-securities-trading/get-order-book-trades"},{"title":"Get Order Book Stats","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/stats","href":"/endpoints/external-securities-trading/get-order-book-stats"},{"title":"Get Daily Stats","api":"GET /orderbooks/external-securities/api/order-books/by-token/{tokenAddress}/daily-stats","href":"/endpoints/external-securities-trading/get-daily-stats"},{"title":"Get Custody Balance","api":"GET /orderbooks/external-securities/api/custody/{custodyContract}/balance/{userAddress}/{tokenAddress}","href":"/endpoints/external-securities-trading/get-custody-balance"}]},{"group":"Price Reference","pages":[{"title":"Set Price Reference","api":"POST /orderbooks/external-securities/api/order-books/{orderBookId}/price-reference","href":"/endpoints/external-securities-trading/set-price-reference"},{"title":"Get Price Reference","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/price-reference","href":"/endpoints/external-securities-trading/get-price-reference"},{"title":"Get Price Reference History","api":"GET /orderbooks/external-securities/api/order-books/{orderBookId}/price-reference/history","href":"/endpoints/external-securities-trading/get-price-reference-history"},{"title":"Preview Price Feed","api":"POST /orderbooks/external-securities/api/price-feeds/preview","href":"/endpoints/external-securities-trading/preview-price-feed"}]}]},{"group":"Commodity Trading","pages":[{"title":"Commodity Trading","href":"/endpoints/commodity-trading/introduction"},{"group":"Order Books","pages":[{"title":"Create Order Book","api":"POST /orderbooks/commodities/api/order-books","href":"/endpoints/commodity-trading/create-order-book"},{"title":"Get Order Book","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}","href":"/endpoints/commodity-trading/get-order-book"},{"title":"List Order Books","api":"GET /orderbooks/commodities/api/order-books","href":"/endpoints/commodity-trading/list-order-books"},{"title":"Update Order Book","api":"PATCH /orderbooks/commodities/api/order-books/{orderBookId}","href":"/endpoints/commodity-trading/update-order-book"},{"title":"Get Trade Readiness","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}/readiness","href":"/endpoints/commodity-trading/get-trade-readiness"},{"title":"List Importable Order Books","api":"GET /orderbooks/commodities/api/order-books/importable","href":"/endpoints/commodity-trading/list-importable"},{"title":"Import Order Book","api":"POST /orderbooks/commodities/api/imports","href":"/endpoints/commodity-trading/import-order-book"},{"title":"Remove Import","api":"DELETE /orderbooks/commodities/api/imports/{importId}","href":"/endpoints/commodity-trading/remove-import"}]},{"group":"Orders","pages":[{"title":"Submit Order","api":"POST /orderbooks/commodities/api/orders","href":"/endpoints/commodity-trading/submit-order"},{"title":"Submit Priority Order","api":"POST /orderbooks/commodities/api/orders/priority","href":"/endpoints/commodity-trading/submit-priority-order"},{"title":"Cancel Order","api":"DELETE /orderbooks/commodities/api/orders/{orderId}","href":"/endpoints/commodity-trading/cancel-order"},{"title":"Get Order","api":"GET /orderbooks/commodities/api/orders/{orderId}","href":"/endpoints/commodity-trading/get-order"},{"title":"Get User Orders","api":"GET /orderbooks/commodities/api/users/{userAddress}/orders","href":"/endpoints/commodity-trading/get-user-orders"},{"title":"Get User Trades","api":"GET /orderbooks/commodities/api/users/{userAddress}/trades","href":"/endpoints/commodity-trading/get-user-trades"}]},{"group":"Market Data","pages":[{"title":"Get Order Book Snapshot","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}/snapshot","href":"/endpoints/commodity-trading/get-order-book-snapshot"},{"title":"Get Order Book Trades","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}/trades","href":"/endpoints/commodity-trading/get-order-book-trades"},{"title":"Get Order Book Stats","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}/stats","href":"/endpoints/commodity-trading/get-order-book-stats"},{"title":"Get Daily Stats","api":"GET /orderbooks/commodities/api/order-books/by-token/{tokenAddress}/daily-stats","href":"/endpoints/commodity-trading/get-daily-stats"},{"title":"Get Settlement","api":"GET /orderbooks/commodities/api/settlements/{settlementId}","href":"/endpoints/commodity-trading/get-settlement"},{"title":"Get Custody Balance","api":"GET /orderbooks/commodities/api/custody/{custodyContract}/balance/{userAddress}/{tokenAddress}","href":"/endpoints/commodity-trading/get-custody-balance"}]},{"group":"Price Reference","pages":[{"title":"Set Price Reference","api":"POST /orderbooks/commodities/api/order-books/{orderBookId}/price-reference","href":"/endpoints/commodity-trading/set-price-reference"},{"title":"Get Price Reference","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}/price-reference","href":"/endpoints/commodity-trading/get-price-reference"},{"title":"Get Price Reference History","api":"GET /orderbooks/commodities/api/order-books/{orderBookId}/price-reference/history","href":"/endpoints/commodity-trading/get-price-reference-history"}]}]}]},{"group":"MiCA Register","pages":[{"title":"MiCA Register","href":"/endpoints/mica-register/introduction"},{"group":"Queries","pages":[{"title":"List Issuers","api":"GET /api/mica/v1/issuers","href":"/endpoints/mica-register/list-issuers"},{"title":"Get Issuer","api":"GET /api/mica/v1/issuers/{id}","href":"/endpoints/mica-register/get-issuer"},{"title":"Search Issuers","api":"GET /api/mica/v1/search","href":"/endpoints/mica-register/search"},{"title":"Registry Statistics","api":"GET /api/mica/v1/statistics","href":"/endpoints/mica-register/statistics"},{"title":"License Types","api":"GET /api/mica/v1/license-types","href":"/endpoints/mica-register/license-types"},{"title":"Countries","api":"GET /api/mica/v1/countries","href":"/endpoints/mica-register/countries"},{"title":"Health Check","api":"GET /api/mica/v1/health","href":"/endpoints/mica-register/health"}]}]}]}]}]},"basePath":"","title":"Trusset Docs - Secured lending infrastructure for real-world assets","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js"]}