Gets and returns the all Organizations’ profiles.
The authenticated user must have the ‘organizations:read’ permission.
If the authenticated user is an Operator, they can access any Organizations’ profile.
If the authenticated user is a User or an Organization, they can only access the profile of their own Organization.
Args:
auth_context (BaseAuthContext): The authentication context of the request.
Returns:
The Organizations’ profiles.
GET
/
organizations
Get All Organizations Within Scope
curl --request GET \
--url https://api.baselayer.com/organizations \
--header 'X-API-Key: <api-key>'
The list of collateral statement templates for lien filing.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Baselayer","colors":{"primary":"#384ce3","light":"#c6dbf6","dark":"#2232b5"},"logo":{"light":"https://mintcdn.com/baselayer-81245324/D2HqlyNVJCqb8u23/logo/baselayer-wordmark-white.svg?fit=max\u0026auto=format\u0026n=D2HqlyNVJCqb8u23\u0026q=85\u0026s=533e2ee556334e910d3a6d1f2f66ca6a","dark":"https://mintcdn.com/baselayer-81245324/D2HqlyNVJCqb8u23/logo/baselayer-wordmark-white.svg?fit=max\u0026auto=format\u0026n=D2HqlyNVJCqb8u23\u0026q=85\u0026s=533e2ee556334e910d3a6d1f2f66ca6a","href":"https://www.baselayer.com"},"favicon":"https://mintcdn.com/baselayer-81245324/y8jjNyo-CIhfj2Df/favicon.ico?fit=max\u0026auto=format\u0026n=y8jjNyo-CIhfj2Df\u0026q=85\u0026s=5f1029f95d2abd5d4ffd1699330f82ff","navbar":{"links":[{"href":"https://console.baselayer.com","label":"Console"}]},"fonts":{"heading":{"family":"Season Mix","source":"fonts/SeasonMix-Variable.woff2","format":"woff2"},"body":{"family":"Uncut Sans","source":"fonts/UncutSans-Variable.woff2","format":"woff2"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"baselayer-81245324","hasAudioNarration":false,"actualSubdomain":"baselayer-81245324","customDomains":["docs.baselayer.com"],"gitSource":{"type":"github","owner":"osiris-ratings","repo":"docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"c01b8a96-72e8-47f2-acae-28665212b8cb","liveDeploymentHistoryId":"6ae2cd9ed5f357b7dcda2db3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2cd9ed5f357b7dcda2db3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4b13c39bc6f1b8c505ffe","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":270},{"language":"default","tag":"Changelog","count":162},{"language":"default","tag":"Businesses","count":133},{"language":"default","tag":"Webhooks","count":81},{"language":"default","tag":"Webhook Events","count":68},{"language":"default","tag":"PRODUCT GUIDES","count":61},{"language":"default","tag":"Verify Businesses \u0026 People","count":60},{"language":"default","tag":"Know Your Agent","count":54},{"language":"default","tag":"Business Verification","count":49},{"language":"default","tag":"Portfolio Monitoring","count":48}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html:not(.dark) #navbar{background:#384ce3!important}html:not(.dark) #navbar div,html:not(.dark) #navbar nav{background-color:transparent!important;backdrop-filter:none!important}html:not(.dark) #navbar *{border-color:rgba(255,255,255,.18)!important}html:not(.dark) #navbar a,html:not(.dark) #navbar button,html:not(.dark) #navbar div,html:not(.dark) #navbar p,html:not(.dark) #navbar span,html:not(.dark) #navbar svg{color:#fff!important}html:not(.dark) #navbar button{background:rgba(255,255,255,.12)!important;border-color:rgba(255,255,255,.25)!important}"}],"page":{"pagePath":"api-reference/organization-management/get-all-organizations-within-scope","slug":"/api-reference/organization-management/get-all-organizations-within-scope","pageMetadata":{"title":"Get All Organizations Within Scope","description":"Gets and returns the all Organizations' profiles.\nThe authenticated user must have the 'organizations:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile.\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\n\nArgs:\n auth_context (BaseAuthContext): The authentication context of the request.\n\nReturns:\n The Organizations' profiles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organizations","href":"/api-reference/organization-management/get-all-organizations-within-scope","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Gets and returns the all Organizations’ profiles.\\nThe authenticated user must have the ‘organizations:read’ permission.\\nIf the authenticated user is an Operator, they can access any Organizations’ profile.\\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Args:\\nauth_context (BaseAuthContext): The authentication context of the request.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Returns:\\nThe Organizations’ profiles.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get All Organizations Within Scope","description":"Gets and returns the all Organizations' profiles.\nThe authenticated user must have the 'organizations:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile.\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\n\nArgs:\n auth_context (BaseAuthContext): The authentication context of the request.\n\nReturns:\n The Organizations' profiles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organizations","href":"/api-reference/organization-management/get-all-organizations-within-scope","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/baselayer-81245324/8f3f8776472b6600/kya-nudge.js"],"openApiReferenceData":{"operation":{"tags":["Organization Management"],"summary":"Get All Organizations Within Scope","description":"Gets and returns the all Organizations' profiles.\nThe authenticated user must have the 'organizations:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile.\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\n\nArgs:\n auth_context (BaseAuthContext): The authentication context of the request.\n\nReturns:\n The Organizations' profiles.","operationId":"get_all_organizations_within_scope_organizations_get","security":["e88dc6c0-301a-4222-a171-8572616bb3ae"],"parameters":["dc2f343b-9e27-4b71-b0ab-58084bd6cf14","284ab80c-2b78-4d09-a26c-f4957ebd59f5","539c75d0-8824-413d-b1d4-609614037386","a4b51bc0-b87d-44b6-b260-035dd3bb367c"],"responses":{"200":"e1119181-a4b0-4411-8577-a1c9db61abf2","422":"d8297c55-e075-438f-a0ea-24025df5d99e"},"method":"get","type":"path","servers":["788562d2-18e0-4de1-8ca6-c9b3fd720b2d"],"path":"/organizations","baseUrlOptions":["https://api.baselayer.com/"],"title":"Get All Organizations Within Scope","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dc2f343b-9e27-4b71-b0ab-58084bd6cf14":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":10,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"284ab80c-2b78-4d09-a26c-f4957ebd59f5":{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"539c75d0-8824-413d-b1d4-609614037386":{"name":"q","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"q","description":"A search query to limit the Organizations returned by matching on ID, name, or external ID.","example":"Acme, Inc.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"q","description":"A search query to limit the Organizations returned by matching on ID, name, or external ID.","example":"Acme, Inc.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"A search query to limit the Organizations returned by matching on ID, name, or external ID."},"a4b51bc0-b87d-44b6-b260-035dd3bb367c":{"name":"unfederated","in":"query","required":false,"schema":{"type":"boolean","title":"unfederated","description":"When true, return only standalone Organizations (those not in any federation).","default":false,"isRequired":false,"uniqueKey":"","typeLabel":"boolean"},"description":"When true, return only standalone Organizations (those not in any federation)."}},"responses":{"e1119181-a4b0-4411-8577-a1c9db61abf2":{"description":"Response","content":{"application/json":{"schema":{"type":"array","items":{"description":"An Organization plus its lien-filing configuration.\n\nServed by the standalone ``GET /organization`` (and its ``PATCH``/``PUT``),\nthe org-management endpoints, the federation organization list, and the\nadmin organization endpoints. The nested-in-user view (``/me``,\n``/users/{id}``) and the federation summary use the lean\n``OrganizationResponse`` instead — only the single-resource org views carry\nthe lien-filing fields. (``webhooks_version`` lives on the lean base: the\nconsole reads it off the nested org.)","properties":{"id":{"description":"The unique identifier of the Organization.","examples":["51b37909-1f26-4e88-88f2-d3bfc03834eb"],"format":"uuid","title":"Organization Identifier","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","title":"Organization Name","description":"The name of the Organization.","example":"The Avengers","isRequired":true,"uniqueKey":"items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization Name","description":"The name of the Organization.","example":"The Avengers","isRequired":true,"uniqueKey":"items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].name","typeLabel":"string | null"},"domain_name":{"oneOf":[{"type":"string","title":"Organization Domain Name","description":"The domain name of the Organization.","example":"avengers.com","isRequired":true,"uniqueKey":"items.[INDEX].domain_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization Domain Name","description":"The domain name of the Organization.","example":"avengers.com","isRequired":true,"uniqueKey":"items.[INDEX].domain_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].domain_name","typeLabel":"string | null"},"type":{"enum":["neobank","community_bank","credit_union","regional_bank","national_bank","fintech","smb_lender","merchant_cash_advanced","processor","infrastructure","other"],"title":"Organization Type","type":"string","description":"The type of the organization.","isRequired":true,"uniqueKey":"items.[INDEX].type","typeLabel":"enum\u003cstring>"},"external_id":{"oneOf":[{"type":"string","title":"External Identifier","description":"An external identifier for referencing the Organization using the ID from a namespace in an external system.","example":"0c692180-eff6-4d78-81a5-b96938fde161","isRequired":true,"uniqueKey":"items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"An external identifier for referencing the Organization using the ID from a namespace in an external system.","example":"0c692180-eff6-4d78-81a5-b96938fde161","isRequired":true,"uniqueKey":"items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].external_id","typeLabel":"string | null"},"webhooks_version":{"enum":["0.8","1.0","2.0","2.0"],"title":"WebhooksVersion","type":"string","description":"The version of Baselayer Webhooks the Organization utilizies.","examples":["2.0"],"isRequired":true,"uniqueKey":"items.[INDEX].webhooks_version","typeLabel":"enum\u003cstring>"},"federation":{"oneOf":[{"type":"object","title":"FederationResponse (v1)","description":"Represents a Federation response.","required":["id"],"example":{"id":"6d49b18a-c030-4397-b1ff-7cc1fc3a4c53","name":"Stan Lee"},"properties":{"id":{"description":"The unique identifier of the federation.","format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the federation.","uniqueKey":"items.[INDEX].federation.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the federation.","uniqueKey":"items.[INDEX].federation.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.name","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","title":"ContactResponse (v1)","description":"The contact for the federation.","required":["id"],"properties":{"id":{"description":"The unique identifier of the contact.","format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"The email of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","description":"The email of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0","typeLabel":"ContactResponse (v1) · object"},{"type":"null","description":"The contact for the federation.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.contact","typeLabel":"ContactResponse (v1) · object | null"}},"isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.0","typeLabel":"FederationResponse (v1) · object"},{"type":"null","title":"Federation","description":"The Federation that the Organization belongs to (if any).","example":{"email":"stan-lee@marvel.com","id":"6d49b18a-c030-4397-b1ff-7cc1fc3a4c53","name":"Stan Lee"},"isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].federation","typeLabel":"FederationResponse (v1) · object | null"},"applications":{"description":"The Applications belonging to the Organization.","examples":[{"enabled":true,"external_id":null,"id":"45670cb4-c724-422c-bbcf-eb1ac7839c00","name":"Avengers - Sandbox","type":"sandbox"},{"enabled":false,"external_id":null,"id":"07ec800c-2987-4768-a35f-b5b7cd92430b","name":"Avengers - Production","type":"production"}],"items":{"description":"Represents an application response.","properties":{"id":{"description":"The unique identifier of the application.","format":"uuid","title":"Application Identifier","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].applications.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"enum":["sandbox","production"],"title":"Application Type","type":"string","description":"The type of Application.","examples":["sandbox","production"],"isRequired":true,"uniqueKey":"items.[INDEX].applications.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"description":"Whether or not the application is enabled for access via the API and Console.","examples":[true,false],"title":"Application Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].applications.items.[INDEX].enabled","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","title":"Application Name","description":"The name of the application.","example":"The Avengers","uniqueKey":"items.[INDEX].applications.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Application Name","description":"The name of the application.","example":"The Avengers","uniqueKey":"items.[INDEX].applications.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].applications.items.[INDEX].name","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","title":"External Identifier","description":"An identifier for referencing the application in an external namespace.","uniqueKey":"items.[INDEX].applications.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"An identifier for referencing the application in an external namespace.","uniqueKey":"items.[INDEX].applications.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].applications.items.[INDEX].external_id","typeLabel":"string | null"}},"required":["id","type","enabled"],"title":"ApplicationResponse (v1)","type":"object","uniqueKey":"items.[INDEX].applications.items.[INDEX]","typeLabel":"ApplicationResponse (v1) · object"},"title":"Applications","type":"array","isRequired":true,"uniqueKey":"items.[INDEX].applications","typeLabel":"ApplicationResponse (v1) · object[]"},"settings":{"description":"The settings in effect for this Organization.","properties":{"watchlist_settings":{"properties":{"ofac":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.ofac.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.ofac.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Office of Foreign Assets Control (OFAC) sanction list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.ofac","typeLabel":"WatchlistSettingResponse (v1) · object"},"pep":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.pep.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.pep.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Politically Exposed Persons (PEP) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.pep","typeLabel":"WatchlistSettingResponse (v1) · object"},"csl":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.csl.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.csl.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Consolidated Screening List (CSL) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.csl","typeLabel":"WatchlistSettingResponse (v1) · object"},"fbi":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.fbi.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.fbi.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Federal Bureau of Investigation (FBI) wanted list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.fbi","typeLabel":"WatchlistSettingResponse (v1) · object"},"cns":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.cns.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.cns.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Canadian National Security (CNS) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.cns","typeLabel":"WatchlistSettingResponse (v1) · object"},"oig":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.oig.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.oig.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Office of Inspector General (OIG) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.oig","typeLabel":"WatchlistSettingResponse (v1) · object"}},"required":["ofac","pep","csl","fbi","cns","oig"],"title":"WatchlistSettingsResponse (v1)","type":"object","description":"Settings for watchlist screening in US and international business searches.","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings","typeLabel":"WatchlistSettingsResponse (v1) · object"},"lien_settings":{"properties":{"alternative_name_matching_enabled":{"description":"Whether to include liens that match with the searched entity's alternative names, if applicable.","title":"Alternative Name Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.alternative_name_matching_enabled","typeLabel":"boolean"},"suffix_mismatch_matching_enabled":{"description":"Whether to include liens with a suffix mismatch. This will allow matches that are exact in base name but differ in corporate suffix. e.g., 'Acme Holdings Inc' and 'Acme Holdings LLC'.","title":"Suffix Mismatch Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.suffix_mismatch_matching_enabled","typeLabel":"boolean"},"fuzzy_matching_enabled":{"description":"Whether to include liens that match with typos or small spelling variations. e.g., 'Acme Holdngs LLC' and 'Acme Holdings LLC'.","title":"Fuzzy Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.fuzzy_matching_enabled","typeLabel":"boolean"},"collapsed_initialism_matching_enabled":{"description":"Whether to include liens that match with collapsed initialisms. e.g., 'F B I Headquarters' and 'FBI Headquarters'.","title":"Collapsed Initialism Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.collapsed_initialism_matching_enabled","typeLabel":"boolean"}},"required":["alternative_name_matching_enabled","suffix_mismatch_matching_enabled","fuzzy_matching_enabled","collapsed_initialism_matching_enabled"],"title":"LienSettingsResponse (v1)","type":"object","description":"Settings related to lien searches.","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings","typeLabel":"LienSettingsResponse (v1) · object"},"business_search_settings":{"properties":{"unknown_registration_status_treatment":{"description":"How the KYB score treats a business whose US Secretary of State registrations all have an unknown status. 'missing_information' leaves the status check out of the score; 'not_active' scores it the same as an inactive registration. International business searches are not affected.","enum":["missing_information","not_active"],"title":"UnknownRegistrationStatusTreatment","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].settings.business_search_settings.unknown_registration_status_treatment","typeLabel":"enum\u003cstring>"}},"required":["unknown_registration_status_treatment"],"title":"BusinessSearchSettingsResponse (v1)","type":"object","description":"Settings related to business searches.","isRequired":true,"uniqueKey":"items.[INDEX].settings.business_search_settings","typeLabel":"BusinessSearchSettingsResponse (v1) · object"}},"required":["watchlist_settings","lien_settings","business_search_settings"],"title":"Settings","type":"object","isRequired":true,"uniqueKey":"items.[INDEX].settings","typeLabel":"Settings · object"},"settings_source":{"enum":["organization","federation","system"],"title":"Settings source","type":"string","description":"Where the current active settings are sourced from.","isRequired":true,"uniqueKey":"items.[INDEX].settings_source","typeLabel":"enum\u003cstring>"},"lien_filing_decision_policy":{"oneOf":[{"type":"object","title":"LienFilingDecisionPolicy","description":"One organization's filing rules.","properties":{"max_liens":{"default":2,"description":"How many counting liens a business may already have and still be filed against. Above this the row is `no_lien_priority`.","minimum":0,"title":"Max Liens","type":"integer","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.max_liens","typeLabel":"integer"},"min_loan_amount":{"oneOf":[{"type":"string","title":"Min Loan Amount","description":"Rows below this loan amount are excluded before any search runs (`insufficient_amount`). None means no floor.","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.min_loan_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Min Loan Amount","description":"Rows below this loan amount are excluded before any search runs (`insufficient_amount`). None means no floor.","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.min_loan_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.min_loan_amount","typeLabel":"string | null"},"state_min_loan_amounts":{"additionalProperties":{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.state_min_loan_amounts.additionalProperties","typeLabel":"string"},"description":"Per-state loan floors, keyed by two-letter state, that OVERRIDE `min_loan_amount` for rows filing in that state. A state absent from the map falls back to the global floor; the global floor being None means no floor at all. The console has always offered this control — it was collected and silently discarded, so a lender could set a $75k Texas floor, watch it vanish on reload, and have their $20k Texas rows file anyway.","title":"State Min Loan Amounts","type":"object","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.state_min_loan_amounts","typeLabel":"State Min Loan Amounts · object"},"counting_types":{"description":"Collateral types that count toward `max_liens`, in the vocabulary of `osiris.enums.CollateralType` plus the two values derived from filing_type (`tax`, `judicial`). Order is preserved because it drives the reason-string label.","items":{"type":"string","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.counting_types.items.[INDEX]","typeLabel":"string"},"title":"Counting Types","type":"array","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.counting_types","typeLabel":"string[]"},"disabled_states":{"description":"Two-letter states the customer has switched OFF. Sparse on purpose: a state Baselayer adds coverage for is on by default, rather than silently off because it did not exist when this was saved. States Baselayer cannot search are excluded regardless.","items":{"type":"string","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.disabled_states.items.[INDEX]","typeLabel":"string"},"title":"Disabled States","type":"array","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.disabled_states","typeLabel":"string[]"}},"uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0","typeLabel":"LienFilingDecisionPolicy · object"},{"type":"null","title":"Batch Filing Decision Policy","description":"The organization's Batch Filing rules. Null when the organization has not set them, in which case the engine defaults apply.","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_decision_policy","typeLabel":"LienFilingDecisionPolicy · object | null"},"lien_filing_correspondence_email":{"oneOf":[{"type":"string","title":"Lien Filing Correspondence Email","description":"The email address for lien filing correspondence.","format":"email","example":"lien-filing-email@example.com","uniqueKey":"items.[INDEX].lien_filing_correspondence_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Lien Filing Correspondence Email","description":"The email address for lien filing correspondence.","example":"lien-filing-email@example.com","uniqueKey":"items.[INDEX].lien_filing_correspondence_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_correspondence_email","typeLabel":"string\u003cemail> | null"},"lien_filing_secured_party":{"oneOf":[{"type":"object","title":"LienFilingOrganizationSecuredPartyPreference (v1)","description":"An organization's stored default secured party for lien filings.\n\nThis is the template applied to newly created drafts — not a persisted\nlien party row — so unlike the submission list item it carries no\nparty id.","required":["type"],"properties":{"type":{"const":"ORGANIZATION","default":"ORGANIZATION","description":"Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.","title":"Organization Party Type","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.type","typeLabel":"string"},"mailing_address":{"oneOf":[{"type":"string","title":"Mailing Address","description":"The mailing address for the lien filing party, excluding city, state, and postal code.","maxLength":128,"example":"123 Main St","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.mailing_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"No Mailing Address","description":"No mailing address is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.mailing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.mailing_address","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"The city of the lien filing party's mailing address.","maxLength":128,"example":"Springfield","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"No City","description":"No city is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"The state abbreviation of the lien filing party's mailing address.","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","PR","VI","AE","AA","AP","GU","AS"],"example":"AL","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"No State","description":"No state is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.state","typeLabel":"enum\u003cstring> | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","description":"The postal code of the lien filing party's mailing address.","maxLength":16,"example":"62701","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"No Postal Code","description":"No postal code is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.postal_code","typeLabel":"string | null"},"masked":{"oneOf":[{"type":"boolean","title":"Masked","description":"When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492).","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.masked.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Not Masked","description":"The secured party is not masked when filing a lien.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.masked.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.masked","typeLabel":"boolean | null"},"is_assignor":{"oneOf":[{"type":"boolean","title":"Is Assignor","description":"Whether the secured party is the assignor of the lien.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.is_assignor.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Assignor Not Specified","description":"The assignor status of the secured party is not specified.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.is_assignor.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.is_assignor","typeLabel":"boolean | null"},"organization_name":{"oneOf":[{"type":"string","title":"Organization Name","description":"The name of the organization involved in the lien filing.","maxLength":128,"example":"Acme Inc","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"No Organization Name","description":"No organization name is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_name","typeLabel":"string | null"},"organization_type":{"oneOf":[{"type":"string","title":"Organization Type","description":"The type of organization involved in the lien filing, if applicable.","enum":["SOLE_PROPRIETORSHIP","GENERAL_PARTNERSHIP","LLC","LLP","LLLP","LP","C_CORPORATION","S_CORPORATION","B_CORPORATION","NONPROFIT","COOPERATIVE","TRUST","PROFESSIONAL_ASSOCIATION","PROFESSIONAL_CORPORATION","TRADE_NAME","BANK","CREDIT_UNION","INSURANCE","OTHER"],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"No Organization Type","description":"No organization type is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0","typeLabel":"LienFilingOrganizationSecuredPartyPreference (v1) · object"},{"type":"null","title":"Lien Filing Secured Party","description":"The secured party for lien filing.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party","typeLabel":"LienFilingOrganizationSecuredPartyPreference (v1) · object | null"},"lien_filing_collateral_statement":{"oneOf":[{"type":"string","title":"Lien Filing Collateral Statement","description":"The collateral statement for lien filing.","uniqueKey":"items.[INDEX].lien_filing_collateral_statement.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lien Filing Collateral Statement","description":"The collateral statement for lien filing.","uniqueKey":"items.[INDEX].lien_filing_collateral_statement.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_collateral_statement","typeLabel":"string | null"},"lien_filing_collateral_statement_templates":{"description":"The list of collateral statement templates for lien filing.","items":{"description":"Represents a template for a collateral statement in a UCC-3 filing.","properties":{"title":{"description":"The title of the collateral statement option.","title":"Collateral Statement Title","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates.items.[INDEX].title","typeLabel":"string"},"text":{"description":"The text of the collateral statement option.","title":"Collateral Statement Text","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates.items.[INDEX].text","typeLabel":"string"}},"required":["title","text"],"title":"LienFilingCollateralStatementTemplate","type":"object","uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates.items.[INDEX]","typeLabel":"LienFilingCollateralStatementTemplate · object"},"title":"Lien Filing Collateral Statement Templates","type":"array","uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates","typeLabel":"LienFilingCollateralStatementTemplate · object[]"}},"required":["id","name","domain_name","type","external_id","webhooks_version","federation","applications","settings","settings_source"],"title":"OrganizationDetailResponse (v1)","type":"object","uniqueKey":"items.[INDEX]","typeLabel":"OrganizationDetailResponse (v1) · object"},"uniqueKey":"","typeLabel":"OrganizationDetailResponse (v1) · object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"51b37909-1f26-4e88-88f2-d3bfc03834eb","name":"The Avengers","domain_name":"avengers.com","type":"neobank","external_id":"0c692180-eff6-4d78-81a5-b96938fde161","webhooks_version":"2.0","federation":{"id":"6d49b18a-c030-4397-b1ff-7cc1fc3a4c53","name":"Stan Lee"},"applications":{"enabled":true,"external_id":null,"id":"45670cb4-c724-422c-bbcf-eb1ac7839c00","name":"Avengers - Sandbox","type":"sandbox"},"settings":{"watchlist_settings":{"ofac":{"enabled":true,"similarity_threshold":123},"pep":{"enabled":true,"similarity_threshold":123},"csl":{"enabled":true,"similarity_threshold":123},"fbi":{"enabled":true,"similarity_threshold":123},"cns":{"enabled":true,"similarity_threshold":123},"oig":{"enabled":true,"similarity_threshold":123}},"lien_settings":{"alternative_name_matching_enabled":true,"suffix_mismatch_matching_enabled":true,"fuzzy_matching_enabled":true,"collapsed_initialism_matching_enabled":true},"business_search_settings":{"unknown_registration_status_treatment":"missing_information"}},"settings_source":"organization","lien_filing_decision_policy":{"max_liens":2,"min_loan_amount":"\u003cstring>","state_min_loan_amounts":{},"counting_types":["\u003cstring>"],"disabled_states":["\u003cstring>"]},"lien_filing_correspondence_email":"lien-filing-email@example.com","lien_filing_secured_party":{"type":"ORGANIZATION","mailing_address":"123 Main St","city":"Springfield","state":"AL","postal_code":"62701","masked":true,"is_assignor":true,"organization_name":"Acme Inc","organization_type":"SOLE_PROPRIETORSHIP"},"lien_filing_collateral_statement":"\u003cstring>","lien_filing_collateral_statement_templates":[{"title":"\u003cstring>","text":"\u003cstring>"}]}]}},"exampleType":"generated"},"application/vnd.baselayer.v1+json":{"schema":{"type":"array","items":{"description":"An Organization plus its lien-filing configuration.\n\nServed by the standalone ``GET /organization`` (and its ``PATCH``/``PUT``),\nthe org-management endpoints, the federation organization list, and the\nadmin organization endpoints. The nested-in-user view (``/me``,\n``/users/{id}``) and the federation summary use the lean\n``OrganizationResponse`` instead — only the single-resource org views carry\nthe lien-filing fields. (``webhooks_version`` lives on the lean base: the\nconsole reads it off the nested org.)","properties":{"id":{"description":"The unique identifier of the Organization.","examples":["51b37909-1f26-4e88-88f2-d3bfc03834eb"],"format":"uuid","title":"Organization Identifier","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","title":"Organization Name","description":"The name of the Organization.","example":"The Avengers","isRequired":true,"uniqueKey":"items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization Name","description":"The name of the Organization.","example":"The Avengers","isRequired":true,"uniqueKey":"items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].name","typeLabel":"string | null"},"domain_name":{"oneOf":[{"type":"string","title":"Organization Domain Name","description":"The domain name of the Organization.","example":"avengers.com","isRequired":true,"uniqueKey":"items.[INDEX].domain_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization Domain Name","description":"The domain name of the Organization.","example":"avengers.com","isRequired":true,"uniqueKey":"items.[INDEX].domain_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].domain_name","typeLabel":"string | null"},"type":{"enum":["neobank","community_bank","credit_union","regional_bank","national_bank","fintech","smb_lender","merchant_cash_advanced","processor","infrastructure","other"],"title":"Organization Type","type":"string","description":"The type of the organization.","isRequired":true,"uniqueKey":"items.[INDEX].type","typeLabel":"enum\u003cstring>"},"external_id":{"oneOf":[{"type":"string","title":"External Identifier","description":"An external identifier for referencing the Organization using the ID from a namespace in an external system.","example":"0c692180-eff6-4d78-81a5-b96938fde161","isRequired":true,"uniqueKey":"items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"An external identifier for referencing the Organization using the ID from a namespace in an external system.","example":"0c692180-eff6-4d78-81a5-b96938fde161","isRequired":true,"uniqueKey":"items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].external_id","typeLabel":"string | null"},"webhooks_version":{"enum":["0.8","1.0","2.0","2.0"],"title":"WebhooksVersion","type":"string","description":"The version of Baselayer Webhooks the Organization utilizies.","examples":["2.0"],"isRequired":true,"uniqueKey":"items.[INDEX].webhooks_version","typeLabel":"enum\u003cstring>"},"federation":{"oneOf":[{"type":"object","title":"FederationResponse (v1)","description":"Represents a Federation response.","required":["id"],"example":{"id":"6d49b18a-c030-4397-b1ff-7cc1fc3a4c53","name":"Stan Lee"},"properties":{"id":{"description":"The unique identifier of the federation.","format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the federation.","uniqueKey":"items.[INDEX].federation.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the federation.","uniqueKey":"items.[INDEX].federation.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.name","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","title":"ContactResponse (v1)","description":"The contact for the federation.","required":["id"],"properties":{"id":{"description":"The unique identifier of the contact.","format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"The email of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","description":"The email of the contact.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.0","typeLabel":"ContactResponse (v1) · object"},{"type":"null","description":"The contact for the federation.","uniqueKey":"items.[INDEX].federation.oneOf.0.contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].federation.oneOf.0.contact","typeLabel":"ContactResponse (v1) · object | null"}},"isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.0","typeLabel":"FederationResponse (v1) · object"},{"type":"null","title":"Federation","description":"The Federation that the Organization belongs to (if any).","example":{"email":"stan-lee@marvel.com","id":"6d49b18a-c030-4397-b1ff-7cc1fc3a4c53","name":"Stan Lee"},"isRequired":true,"uniqueKey":"items.[INDEX].federation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].federation","typeLabel":"FederationResponse (v1) · object | null"},"applications":{"description":"The Applications belonging to the Organization.","examples":[{"enabled":true,"external_id":null,"id":"45670cb4-c724-422c-bbcf-eb1ac7839c00","name":"Avengers - Sandbox","type":"sandbox"},{"enabled":false,"external_id":null,"id":"07ec800c-2987-4768-a35f-b5b7cd92430b","name":"Avengers - Production","type":"production"}],"items":{"description":"Represents an application response.","properties":{"id":{"description":"The unique identifier of the application.","format":"uuid","title":"Application Identifier","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].applications.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"enum":["sandbox","production"],"title":"Application Type","type":"string","description":"The type of Application.","examples":["sandbox","production"],"isRequired":true,"uniqueKey":"items.[INDEX].applications.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"description":"Whether or not the application is enabled for access via the API and Console.","examples":[true,false],"title":"Application Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].applications.items.[INDEX].enabled","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","title":"Application Name","description":"The name of the application.","example":"The Avengers","uniqueKey":"items.[INDEX].applications.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Application Name","description":"The name of the application.","example":"The Avengers","uniqueKey":"items.[INDEX].applications.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].applications.items.[INDEX].name","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","title":"External Identifier","description":"An identifier for referencing the application in an external namespace.","uniqueKey":"items.[INDEX].applications.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"An identifier for referencing the application in an external namespace.","uniqueKey":"items.[INDEX].applications.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].applications.items.[INDEX].external_id","typeLabel":"string | null"}},"required":["id","type","enabled"],"title":"ApplicationResponse (v1)","type":"object","uniqueKey":"items.[INDEX].applications.items.[INDEX]","typeLabel":"ApplicationResponse (v1) · object"},"title":"Applications","type":"array","isRequired":true,"uniqueKey":"items.[INDEX].applications","typeLabel":"ApplicationResponse (v1) · object[]"},"settings":{"description":"The settings in effect for this Organization.","properties":{"watchlist_settings":{"properties":{"ofac":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.ofac.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.ofac.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Office of Foreign Assets Control (OFAC) sanction list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.ofac","typeLabel":"WatchlistSettingResponse (v1) · object"},"pep":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.pep.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.pep.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Politically Exposed Persons (PEP) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.pep","typeLabel":"WatchlistSettingResponse (v1) · object"},"csl":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.csl.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.csl.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Consolidated Screening List (CSL) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.csl","typeLabel":"WatchlistSettingResponse (v1) · object"},"fbi":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.fbi.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.fbi.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Federal Bureau of Investigation (FBI) wanted list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.fbi","typeLabel":"WatchlistSettingResponse (v1) · object"},"cns":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.cns.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.cns.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Canadian National Security (CNS) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.cns","typeLabel":"WatchlistSettingResponse (v1) · object"},"oig":{"properties":{"enabled":{"description":"Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.oig.enabled","typeLabel":"boolean"},"similarity_threshold":{"description":"How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.","title":"Similarity Threshold","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.oig.similarity_threshold","typeLabel":"number"}},"required":["enabled","similarity_threshold"],"title":"WatchlistSettingResponse (v1)","type":"object","description":"Settings for the Office of Inspector General (OIG) list","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings.oig","typeLabel":"WatchlistSettingResponse (v1) · object"}},"required":["ofac","pep","csl","fbi","cns","oig"],"title":"WatchlistSettingsResponse (v1)","type":"object","description":"Settings for watchlist screening in US and international business searches.","isRequired":true,"uniqueKey":"items.[INDEX].settings.watchlist_settings","typeLabel":"WatchlistSettingsResponse (v1) · object"},"lien_settings":{"properties":{"alternative_name_matching_enabled":{"description":"Whether to include liens that match with the searched entity's alternative names, if applicable.","title":"Alternative Name Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.alternative_name_matching_enabled","typeLabel":"boolean"},"suffix_mismatch_matching_enabled":{"description":"Whether to include liens with a suffix mismatch. This will allow matches that are exact in base name but differ in corporate suffix. e.g., 'Acme Holdings Inc' and 'Acme Holdings LLC'.","title":"Suffix Mismatch Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.suffix_mismatch_matching_enabled","typeLabel":"boolean"},"fuzzy_matching_enabled":{"description":"Whether to include liens that match with typos or small spelling variations. e.g., 'Acme Holdngs LLC' and 'Acme Holdings LLC'.","title":"Fuzzy Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.fuzzy_matching_enabled","typeLabel":"boolean"},"collapsed_initialism_matching_enabled":{"description":"Whether to include liens that match with collapsed initialisms. e.g., 'F B I Headquarters' and 'FBI Headquarters'.","title":"Collapsed Initialism Matching Enabled","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings.collapsed_initialism_matching_enabled","typeLabel":"boolean"}},"required":["alternative_name_matching_enabled","suffix_mismatch_matching_enabled","fuzzy_matching_enabled","collapsed_initialism_matching_enabled"],"title":"LienSettingsResponse (v1)","type":"object","description":"Settings related to lien searches.","isRequired":true,"uniqueKey":"items.[INDEX].settings.lien_settings","typeLabel":"LienSettingsResponse (v1) · object"},"business_search_settings":{"properties":{"unknown_registration_status_treatment":{"description":"How the KYB score treats a business whose US Secretary of State registrations all have an unknown status. 'missing_information' leaves the status check out of the score; 'not_active' scores it the same as an inactive registration. International business searches are not affected.","enum":["missing_information","not_active"],"title":"UnknownRegistrationStatusTreatment","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].settings.business_search_settings.unknown_registration_status_treatment","typeLabel":"enum\u003cstring>"}},"required":["unknown_registration_status_treatment"],"title":"BusinessSearchSettingsResponse (v1)","type":"object","description":"Settings related to business searches.","isRequired":true,"uniqueKey":"items.[INDEX].settings.business_search_settings","typeLabel":"BusinessSearchSettingsResponse (v1) · object"}},"required":["watchlist_settings","lien_settings","business_search_settings"],"title":"Settings","type":"object","isRequired":true,"uniqueKey":"items.[INDEX].settings","typeLabel":"Settings · object"},"settings_source":{"enum":["organization","federation","system"],"title":"Settings source","type":"string","description":"Where the current active settings are sourced from.","isRequired":true,"uniqueKey":"items.[INDEX].settings_source","typeLabel":"enum\u003cstring>"},"lien_filing_decision_policy":{"oneOf":[{"type":"object","title":"LienFilingDecisionPolicy","description":"One organization's filing rules.","properties":{"max_liens":{"default":2,"description":"How many counting liens a business may already have and still be filed against. Above this the row is `no_lien_priority`.","minimum":0,"title":"Max Liens","type":"integer","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.max_liens","typeLabel":"integer"},"min_loan_amount":{"oneOf":[{"type":"string","title":"Min Loan Amount","description":"Rows below this loan amount are excluded before any search runs (`insufficient_amount`). None means no floor.","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.min_loan_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Min Loan Amount","description":"Rows below this loan amount are excluded before any search runs (`insufficient_amount`). None means no floor.","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.min_loan_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.min_loan_amount","typeLabel":"string | null"},"state_min_loan_amounts":{"additionalProperties":{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.state_min_loan_amounts.additionalProperties","typeLabel":"string"},"description":"Per-state loan floors, keyed by two-letter state, that OVERRIDE `min_loan_amount` for rows filing in that state. A state absent from the map falls back to the global floor; the global floor being None means no floor at all. The console has always offered this control — it was collected and silently discarded, so a lender could set a $75k Texas floor, watch it vanish on reload, and have their $20k Texas rows file anyway.","title":"State Min Loan Amounts","type":"object","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.state_min_loan_amounts","typeLabel":"State Min Loan Amounts · object"},"counting_types":{"description":"Collateral types that count toward `max_liens`, in the vocabulary of `osiris.enums.CollateralType` plus the two values derived from filing_type (`tax`, `judicial`). Order is preserved because it drives the reason-string label.","items":{"type":"string","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.counting_types.items.[INDEX]","typeLabel":"string"},"title":"Counting Types","type":"array","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.counting_types","typeLabel":"string[]"},"disabled_states":{"description":"Two-letter states the customer has switched OFF. Sparse on purpose: a state Baselayer adds coverage for is on by default, rather than silently off because it did not exist when this was saved. States Baselayer cannot search are excluded regardless.","items":{"type":"string","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.disabled_states.items.[INDEX]","typeLabel":"string"},"title":"Disabled States","type":"array","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0.disabled_states","typeLabel":"string[]"}},"uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.0","typeLabel":"LienFilingDecisionPolicy · object"},{"type":"null","title":"Batch Filing Decision Policy","description":"The organization's Batch Filing rules. Null when the organization has not set them, in which case the engine defaults apply.","uniqueKey":"items.[INDEX].lien_filing_decision_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_decision_policy","typeLabel":"LienFilingDecisionPolicy · object | null"},"lien_filing_correspondence_email":{"oneOf":[{"type":"string","title":"Lien Filing Correspondence Email","description":"The email address for lien filing correspondence.","format":"email","example":"lien-filing-email@example.com","uniqueKey":"items.[INDEX].lien_filing_correspondence_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Lien Filing Correspondence Email","description":"The email address for lien filing correspondence.","example":"lien-filing-email@example.com","uniqueKey":"items.[INDEX].lien_filing_correspondence_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_correspondence_email","typeLabel":"string\u003cemail> | null"},"lien_filing_secured_party":{"oneOf":[{"type":"object","title":"LienFilingOrganizationSecuredPartyPreference (v1)","description":"An organization's stored default secured party for lien filings.\n\nThis is the template applied to newly created drafts — not a persisted\nlien party row — so unlike the submission list item it carries no\nparty id.","required":["type"],"properties":{"type":{"const":"ORGANIZATION","default":"ORGANIZATION","description":"Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.","title":"Organization Party Type","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.type","typeLabel":"string"},"mailing_address":{"oneOf":[{"type":"string","title":"Mailing Address","description":"The mailing address for the lien filing party, excluding city, state, and postal code.","maxLength":128,"example":"123 Main St","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.mailing_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"No Mailing Address","description":"No mailing address is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.mailing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.mailing_address","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"The city of the lien filing party's mailing address.","maxLength":128,"example":"Springfield","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"No City","description":"No city is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"The state abbreviation of the lien filing party's mailing address.","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","PR","VI","AE","AA","AP","GU","AS"],"example":"AL","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"No State","description":"No state is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.state","typeLabel":"enum\u003cstring> | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","description":"The postal code of the lien filing party's mailing address.","maxLength":16,"example":"62701","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"No Postal Code","description":"No postal code is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.postal_code","typeLabel":"string | null"},"masked":{"oneOf":[{"type":"boolean","title":"Masked","description":"When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492).","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.masked.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Not Masked","description":"The secured party is not masked when filing a lien.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.masked.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.masked","typeLabel":"boolean | null"},"is_assignor":{"oneOf":[{"type":"boolean","title":"Is Assignor","description":"Whether the secured party is the assignor of the lien.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.is_assignor.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Assignor Not Specified","description":"The assignor status of the secured party is not specified.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.is_assignor.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.is_assignor","typeLabel":"boolean | null"},"organization_name":{"oneOf":[{"type":"string","title":"Organization Name","description":"The name of the organization involved in the lien filing.","maxLength":128,"example":"Acme Inc","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"No Organization Name","description":"No organization name is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_name","typeLabel":"string | null"},"organization_type":{"oneOf":[{"type":"string","title":"Organization Type","description":"The type of organization involved in the lien filing, if applicable.","enum":["SOLE_PROPRIETORSHIP","GENERAL_PARTNERSHIP","LLC","LLP","LLLP","LP","C_CORPORATION","S_CORPORATION","B_CORPORATION","NONPROFIT","COOPERATIVE","TRUST","PROFESSIONAL_ASSOCIATION","PROFESSIONAL_CORPORATION","TRADE_NAME","BANK","CREDIT_UNION","INSURANCE","OTHER"],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"No Organization Type","description":"No organization type is provided for the party.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0.organization_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.0","typeLabel":"LienFilingOrganizationSecuredPartyPreference (v1) · object"},{"type":"null","title":"Lien Filing Secured Party","description":"The secured party for lien filing.","uniqueKey":"items.[INDEX].lien_filing_secured_party.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_secured_party","typeLabel":"LienFilingOrganizationSecuredPartyPreference (v1) · object | null"},"lien_filing_collateral_statement":{"oneOf":[{"type":"string","title":"Lien Filing Collateral Statement","description":"The collateral statement for lien filing.","uniqueKey":"items.[INDEX].lien_filing_collateral_statement.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lien Filing Collateral Statement","description":"The collateral statement for lien filing.","uniqueKey":"items.[INDEX].lien_filing_collateral_statement.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lien_filing_collateral_statement","typeLabel":"string | null"},"lien_filing_collateral_statement_templates":{"description":"The list of collateral statement templates for lien filing.","items":{"description":"Represents a template for a collateral statement in a UCC-3 filing.","properties":{"title":{"description":"The title of the collateral statement option.","title":"Collateral Statement Title","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates.items.[INDEX].title","typeLabel":"string"},"text":{"description":"The text of the collateral statement option.","title":"Collateral Statement Text","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates.items.[INDEX].text","typeLabel":"string"}},"required":["title","text"],"title":"LienFilingCollateralStatementTemplate","type":"object","uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates.items.[INDEX]","typeLabel":"LienFilingCollateralStatementTemplate · object"},"title":"Lien Filing Collateral Statement Templates","type":"array","uniqueKey":"items.[INDEX].lien_filing_collateral_statement_templates","typeLabel":"LienFilingCollateralStatementTemplate · object[]"}},"required":["id","name","domain_name","type","external_id","webhooks_version","federation","applications","settings","settings_source"],"title":"OrganizationDetailResponse (v1)","type":"object","uniqueKey":"items.[INDEX]","typeLabel":"OrganizationDetailResponse (v1) · object"},"uniqueKey":"","typeLabel":"OrganizationDetailResponse (v1) · object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"51b37909-1f26-4e88-88f2-d3bfc03834eb","name":"The Avengers","domain_name":"avengers.com","type":"neobank","external_id":"0c692180-eff6-4d78-81a5-b96938fde161","webhooks_version":"2.0","federation":{"id":"6d49b18a-c030-4397-b1ff-7cc1fc3a4c53","name":"Stan Lee"},"applications":{"enabled":true,"external_id":null,"id":"45670cb4-c724-422c-bbcf-eb1ac7839c00","name":"Avengers - Sandbox","type":"sandbox"},"settings":{"watchlist_settings":{"ofac":{"enabled":true,"similarity_threshold":123},"pep":{"enabled":true,"similarity_threshold":123},"csl":{"enabled":true,"similarity_threshold":123},"fbi":{"enabled":true,"similarity_threshold":123},"cns":{"enabled":true,"similarity_threshold":123},"oig":{"enabled":true,"similarity_threshold":123}},"lien_settings":{"alternative_name_matching_enabled":true,"suffix_mismatch_matching_enabled":true,"fuzzy_matching_enabled":true,"collapsed_initialism_matching_enabled":true},"business_search_settings":{"unknown_registration_status_treatment":"missing_information"}},"settings_source":"organization","lien_filing_decision_policy":{"max_liens":2,"min_loan_amount":"\u003cstring>","state_min_loan_amounts":{},"counting_types":["\u003cstring>"],"disabled_states":["\u003cstring>"]},"lien_filing_correspondence_email":"lien-filing-email@example.com","lien_filing_secured_party":{"type":"ORGANIZATION","mailing_address":"123 Main St","city":"Springfield","state":"AL","postal_code":"62701","masked":true,"is_assignor":true,"organization_name":"Acme Inc","organization_type":"SOLE_PROPRIETORSHIP"},"lien_filing_collateral_statement":"\u003cstring>","lien_filing_collateral_statement_templates":[{"title":"\u003cstring>","text":"\u003cstring>"}]}]}},"exampleType":"generated"}},"exampleType":"generated"},"d8297c55-e075-438f-a0ea-24025df5d99e":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e88dc6c0-301a-4222-a171-8572616bb3ae":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"}}},"servers":{"788562d2-18e0-4de1-8ca6-c9b3fd720b2d":{"url":"https://api.baselayer.com/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-Key"}],"title":"APIKeyHeader"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"baselayer-81245324","siteName":"Baselayer","title":"Get All Organizations Within Scope - Baselayer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T05:45:39.939Z","originalFileLocation":"api-reference/organization-management/get-all-organizations-within-scope.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=\"Gets and returns the all Organizations\u0026#x27; profiles. The authenticated user must have the \u0026#x27;organizations:read\u0026#x27; permission. If the authenticated user is an Operator, they can access any Organizations\u0026#x27; profile. If the authenticated user is a User or an Organization, they can only access the profile of their own Organization. Args: auth_context (BaseAuthContext): The authentication context of the request. Returns: The Organizations\u0026#x27; profiles.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Baselayer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get All Organizations Within Scope - Baselayer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets and returns the all Organizations\u0026#x27; profiles. The authenticated user must have the \u0026#x27;organizations:read\u0026#x27; permission. If the authenticated user is an Operator, they can access any Organizations\u0026#x27; profile. If the authenticated user is a User or an Organization, they can only access the profile of their own Organization. Args: auth_context (BaseAuthContext): The authentication context of the request. Returns: The Organizations\u0026#x27; profiles.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Baselayer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://baselayer-81245324.mintlify.app/_mintlify/api/og/v2?division=Organizations\u0026amp;title=Get+All+Organizations+Within+Scope\u0026amp;description=Gets+and+returns+the+all+Organizations%27+profiles.%0AThe+authenticated+user+must+have+the+%27organizations%3Aread%27+permission.%0AIf+the+authenticated+user+is+an+Operator\u0026amp;theme=da3e09036423c5729d7edf96\u0026amp;signature=53d2fb1e771d2ee5edccb07b26f189a4c154baff0dbad7baa3353ed88c32ea03\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get All Organizations Within Scope - Baselayer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets and returns the all Organizations\u0026#x27; profiles. The authenticated user must have the \u0026#x27;organizations:read\u0026#x27; permission. If the authenticated user is an Operator, they can access any Organizations\u0026#x27; profile. If the authenticated user is a User or an Organization, they can only access the profile of their own Organization. Args: auth_context (BaseAuthContext): The authentication context of the request. Returns: The Organizations\u0026#x27; profiles.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://baselayer-81245324.mintlify.app/_mintlify/api/og/v2?division=Organizations\u0026amp;title=Get+All+Organizations+Within+Scope\u0026amp;description=Gets+and+returns+the+all+Organizations%27+profiles.%0AThe+authenticated+user+must+have+the+%27organizations%3Aread%27+permission.%0AIf+the+authenticated+user+is+an+Operator\u0026amp;theme=da3e09036423c5729d7edf96\u0026amp;signature=53d2fb1e771d2ee5edccb07b26f189a4c154baff0dbad7baa3353ed88c32ea03\">\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/baselayer-81245324/PX_ZXIXr1oHoY_hi/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Baselayer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#384ce3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/organization-management/get-all-organizations-within-scope.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.baselayer.com/#organization\",\"name\":\"Baselayer\",\"url\":\"https://docs.baselayer.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/baselayer-81245324/D2HqlyNVJCqb8u23/logo/baselayer-wordmark-white.svg?fit=max\u0026auto=format\u0026n=D2HqlyNVJCqb8u23\u0026q=85\u0026s=533e2ee556334e910d3a6d1f2f66ca6a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.baselayer.com#website\",\"name\":\"Baselayer\",\"url\":\"https://docs.baselayer.com\",\"publisher\":{\"@id\":\"https://docs.baselayer.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope#webpage\",\"url\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope\",\"name\":\"Get All Organizations Within Scope\",\"description\":\"Gets and returns the all Organizations' profiles. The authenticated user must have the 'organizations:read' permission. If the authenticated user is an Operator, they can access any Organizations' profile. If the authenticated user is a User or an Organization, they can only access the profile of their own Organization. Args: auth_context (BaseAuthContext): The authentication context of the request. Returns: The Organizations' profiles.\",\"dateModified\":\"2026-10-29T05:45:39.939Z\",\"isPartOf\":{\"@id\":\"https://docs.baselayer.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Organizations\",\"item\":\"https://docs.baselayer.com/api-reference/organization-management/create-organization-for-federation\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get All Organizations Within Scope\",\"item\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope#apireference\",\"headline\":\"Get All Organizations Within Scope\",\"name\":\"Get All Organizations Within Scope\",\"description\":\"Gets and returns the all Organizations' profiles. The authenticated user must have the 'organizations:read' permission. If the authenticated user is an Operator, they can access any Organizations' profile. If the authenticated user is a User or an Organization, they can only access the profile of their own Organization. Args: auth_context (BaseAuthContext): The authentication context of the request. Returns: The Organizations' profiles.\",\"url\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope\",\"mainEntityOfPage\":{\"@id\":\"https://docs.baselayer.com/api-reference/organization-management/get-all-organizations-within-scope#webpage\"},\"dateModified\":\"2026-10-29T05:45:39.939Z\",\"publisher\":{\"@id\":\"https://docs.baselayer.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.baselayer.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Baselayer\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Baselayer","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"rocket","pages":[{"title":"Get Started","href":"/docs/meet-baselayer"}]},{"tab":"Verify Businesses \u0026 People","icon":"book-open","pages":[{"title":"Verify Businesses \u0026 People","href":"/docs/business-verification-basics"}]},{"tab":"Know Your Agent","icon":"robot","pages":[{"title":"Know Your Agent","href":"/docs/kya-overview"}]},{"tab":"Hosted Enrollment","icon":"id-card","pages":[{"title":"Hosted Enrollment","href":"/hosted-enrollment/overview"}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/docs/mcp"}]},{"tab":"API Reference","icon":"square-terminal","anchors":[{"anchor":"Businesses","icon":"building","pages":[{"title":"Businesses","href":"/api-reference/search/post-search"}]},{"anchor":"People","icon":"user","pages":[{"title":"People","href":"/api-reference/people/create-person"}]},{"anchor":"Know Your Agent","icon":"robot","pages":[{"title":"Know Your Agent","href":"/api-reference/credentials/mint-a-credential-for-a-person-or-a-business-operator"}]},{"anchor":"Admin","icon":"gear","groups":[{"group":"Organizations","pages":[{"title":"Create Organization For Federation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /federations/{federation_id}/organizations","href":"/api-reference/organization-management/create-organization-for-federation"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /organizations","href":"/api-reference/organization-management/create-organization"},{"title":"Get Organization","description":"Gets and returns the Organization profile of a specific Organization.\nThe authenticated user must have the 'organizations:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile.\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\n\nArgs:\n organization_id (uuid.UUID): The unique identifier of the Organization.\n auth_context (BaseAuthContext): The authentication context of the request.\n\nReturns:\n The Organization's profile.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organizations/{organization_id}","href":"/api-reference/organization-management/get-organization"},{"title":"Get All Organizations Within Scope","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organizations","href":"/api-reference/organization-management/get-all-organizations-within-scope"},{"title":"Get All Organizations For Federation Within Scope","description":"Gets and returns all Organizations' profiles within a specific Federation.\n\nThe authenticated user must have the 'federation:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile within the Federation.\nIf the authenticated user is a User or an Organization, they can only access the profiles of their own Organization within the Federation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /federations/{federation_id}/organizations","href":"/api-reference/organization-management/get-all-organizations-for-federation-within-scope"},{"title":"Patch Organization In Federation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /organizations/{organization_id}","href":"/api-reference/organization-management/patch-organization-in-federation"},{"title":"Delete Organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /organizations/{organization_id}","href":"/api-reference/organization-management/delete-organization"}]}]},{"anchor":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/api-reference/webhook-management/create-webhook-endpoint"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog/texas-comptroller-franchise-tax-standing"}]}]},"basePath":"","title":"Get All Organizations Within Scope - Baselayer","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}