{
"error": "Entity Not Found",
"errorCode": "EntityNotFound",
"message": "This entity is not found in the system.",
"status": "404 NOT_FOUND",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "This entity is not found in the system."
}
Loans
GET Loan
Returns a single Loan by id, with its collateral buildings. status is the processing status of the loan’s documents, not whether the loan is active, matured or paid off.
Required capabilities:READ:LOAN
GET
/
rest
/
v2
/
accounts
/
{accountId}
/
loans
/
{loanId}
GET Loan
curl --request GET \ --url https://api.prophia.com/rest/v2/accounts/{accountId}/loans/{loanId} \ --header 'X-API-Key: <api-key>'
{
"error": "Entity Not Found",
"errorCode": "EntityNotFound",
"message": "This entity is not found in the system.",
"status": "404 NOT_FOUND",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "This entity is not found in the system."
}
Authorizations
X-API-Key
string
header
required
Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the X-API-Key header, or equivalently as Authorization: Bearer <api-key>. JWTs are rejected on /rest endpoints with 401.
Path Parameters
accountId
string
required
loanId
string
required
Query Parameters
include
enum<string>[]
Optional collections to populate. Unknown keys are rejected with 400.
summary — adds the loan's consolidated summary terms, the values the loan page shows, with each container's child terms nested in its childTags. Covenants and reporting deliverables are left to their own include keys.
Requires the READ:TAG capability.
covenants — adds the loan's covenants: one entry per hardCovenant, softCovenant or otherCovenantReference container, with its terms nested in its childTags. A covenant struck by a later document is kept, with its rightIsStricken child.
Requires the READ:TAG capability.
deliverables — adds the loan's financial reporting deliverables: one entry per financialReportingDeliverable container, with its terms nested in its childTags. A deliverable struck by a later document is kept, with its rightIsStricken child.
Requires the READ:TAG capability.
documents — adds per-document page geometry keyed by loanDocId, for resolving tagSelections[].docPageId references.
Requires the READ:DOCUMENT capability.
Available options:
summary,
covenants,
deliverables,
documents
Response
OK
Representation of a single Loan. A Loan is secured by one or more of the Account's Buildings, listed in collateral. The terms Prophia reads from its documents are returned through the summary, covenants and deliverables include keys.
id
string
read-only
Stable loan identifier.
name
string
The loan's name in Prophia.
loanType
string
Free-text loan type, such as 'Construction Loan'.
borrower
string
The borrower named in the loan's documents. Several borrowers are joined with '; '.
lender
string
The lender's legal name in the loan's documents, or its common name when no legal name was captured. Several lenders are joined with '; '.
closingDate
string<date>
yyyy-MM-dd. The loan's closing date from its documents.
status
enum<string>
The loan's processing status: whether Prophia has read its documents, not whether the loan is active, matured or paid off. PENDING once its documents are uploaded, PROCESSING while Prophia reads them, then COMPLETE or FAILED. Omitted before any document is uploaded.
Available options:
PENDING,
PROCESSING,
COMPLETE,
FAILED
url
string
Deep link to the loan's page in the Prophia app.
collateral
object[]
The buildings pledged as collateral, each with its property.
Show child attributes
summary
object[]
The loan's consolidated summary terms, the values the loan page shows, apart from covenants and reporting deliverables: one entry per term, with a container's terms nested in its childTags. Includes the all-in rate Prophia computes from the index and spread, which has no id or document. Populated only when the summary include key is requested. To resolve tagSelections[].docPageId to page geometry, also pass include=["documents"].
Show child attributes
covenants
object[]
The loan's covenants: one entry per hardCovenant, softCovenant or otherCovenantReference container, with its terms nested in childTags. Two covenants of the same kind are separate entries, told apart by customLabel. A covenant struck by a later document is kept, with a rightIsStricken child. Populated only when the covenants include key is requested; empty when the loan has none.
Show child attributes
deliverables
object[]
The loan's financial reporting deliverables: one entry per financialReportingDeliverable container, with its terms nested in childTags. A deliverable struck by a later document is kept, with a rightIsStricken child. Populated only when the deliverables include key is requested; empty when the loan has none.
Show child attributes
documents
object
Per-document page geometry keyed by loanDocId, then by docPageId under pages. Populated only when the documents include key is requested, and omitted when the loan's documents have no pages yet.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Prophia Docs","colors":{"primary":"#017768","light":"#027F9E","dark":"#004356"},"logo":{"light":"https://mintcdn.com/prophia/D5w3N4ZrYouJq2j1/images/ProphiaBrand_Primary-Logo-ForDarkBG-TealAccent.png?fit=max\u0026auto=format\u0026n=D5w3N4ZrYouJq2j1\u0026q=85\u0026s=dc3bd897dc4e1f0320f0ee18d0bab7bb","dark":"https://mintcdn.com/prophia/D5w3N4ZrYouJq2j1/images/ProphiaBrand_Primary-Logo-ForLightBG-TealAccent.png?fit=max\u0026auto=format\u0026n=D5w3N4ZrYouJq2j1\u0026q=85\u0026s=58a7fdb3deaa004ccf6c4fff99f0c6b8"},"favicon":{"light":"https://mintcdn.com/prophia/U5C5v85ATT-0BVl7/favicon.svg?fit=max\u0026auto=format\u0026n=U5C5v85ATT-0BVl7\u0026q=85\u0026s=7eacea87495b242cb66ef5e6a54ae9c8","dark":"https://mintcdn.com/prophia/U5C5v85ATT-0BVl7/favicon.svg?fit=max\u0026auto=format\u0026n=U5C5v85ATT-0BVl7\u0026q=85\u0026s=7eacea87495b242cb66ef5e6a54ae9c8"},"api":{"playground":{"display":"interactive","proxy":false}},"navbar":{"links":[{"href":"https://app.prophia.com","label":"Sign in"}]},"footer":{"socials":{"website":"https://www.prophia.com"}},"seo":{"metatags":{"canonical":"https://docs.prophia.com"}},"integrations":{"posthog":{"apiKey":"phc_wyQtcLzAHp5CtWuHBKYYXigMWz5pva9HXfUig7T3VmSp","sessionRecording":false}},"contextual":{"options":["copy","view","mcp","add-mcp","cursor","vscode","claude","chatgpt"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"prophia","hasAudioNarration":false,"actualSubdomain":"prophia","customDomains":["docs.prophia.com"],"gitSource":{"type":"github","owner":"prophia-inc","repo":"prophia-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aebdb9191d076e88422a4a3","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":70},{"language":"default","tag":"Endpoints","count":55},{"language":"default","tag":"Custom Fields","count":12},{"language":"default","tag":"Developers","count":10},{"language":"default","tag":"Data Concepts","count":7},{"language":"default","tag":"Leases","count":7},{"language":"default","tag":"Properties","count":7},{"language":"default","tag":"Prophia MCP Server","count":6},{"language":"default","tag":"Buildings","count":6},{"language":"default","tag":"Documents","count":6}],"searchSettings":{"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".tag-tables table{min-width:72rem}.tag-tables table :is(th,td):nth-child(1){min-width:17rem}.tag-tables table :is(th,td):nth-child(2){min-width:11rem}.tag-tables table :is(th,td):nth-child(3){min-width:7rem;white-space:nowrap}.tag-tables table :is(th,td):nth-child(4){min-width:14rem}.tag-tables table :is(th,td):nth-child(5){min-width:20rem}.tag-tables table :is(th,td):nth-child(6){min-width:6rem;white-space:nowrap}.tag-tables table :is(th,td):nth-child(7){min-width:10rem}"}],"page":{"pagePath":"api-reference/v2/loans/get-loan","slug":"/api-reference/v2/loans/get-loan","pageMetadata":{"title":"GET Loan","description":"Returns a single Loan by id, with its collateral buildings. `status` is the processing status of the loan's documents, not whether the loan is active, matured or paid off.\n\n**Required capabilities:** `READ:LOAN`","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/loans/{loanId}","href":"/api-reference/v2/loans/get-loan","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 code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns a single Loan by id, with its collateral buildings. \", _jsx(_components.code, {\n children: \"status\"\n }), \" is the processing status of the loan’s documents, not whether the loan is active, matured or paid off.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required capabilities:\"\n }), \" \", _jsx(_components.code, {\n children: \"READ:LOAN\"\n })]\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 Loan","description":"Returns a single Loan by id, with its collateral buildings. `status` is the processing status of the loan's documents, not whether the loan is active, matured or paid off.\n\n**Required capabilities:** `READ:LOAN`","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/loans/{loanId}","href":"/api-reference/v2/loans/get-loan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Loans"],"summary":"GET Loan","description":"Returns a single Loan by id, with its collateral buildings. `status` is the processing status of the loan's documents, not whether the loan is active, matured or paid off.\n\n**Required capabilities:** `READ:LOAN`","operationId":"getLoan","parameters":["3a407f4b-f675-46af-85e9-e2dbe64af2b5","3f60786a-cda5-42c4-a1d8-ef20d6c501a7","393fbf0d-ebc6-4761-a19c-bd0f125c3dfe"],"responses":{"200":"130eec1f-3bc9-4e05-887f-c8146b6e26c5","400":"d9870029-cff6-44e9-9f6a-649839a5c2d5","401":"597d6ff4-2e8e-4859-adae-7b77c886c601","403":"5637e127-a8c7-4c3d-9a2b-39c6c87427fc","404":"8b0ab272-6c40-42d4-b481-9f50402aa4be"},"method":"get","type":"path","servers":["ac2c6829-ec34-4f73-950d-564389c250a7"],"security":["a4b573e8-9e27-4cda-bbfc-fe4bf588b6a5"],"path":"/rest/v2/accounts/{accountId}/loans/{loanId}","baseUrlOptions":["https://api.prophia.com"],"title":"GET Loan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"3a407f4b-f675-46af-85e9-e2dbe64af2b5":{"name":"accountId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"3f60786a-cda5-42c4-a1d8-ef20d6c501a7":{"name":"loanId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"393fbf0d-ebc6-4761-a19c-bd0f125c3dfe":{"name":"include","in":"query","description":"Optional collections to populate. Unknown keys are rejected with 400.\n\n- `summary` — adds the loan's consolidated summary terms, the values the loan page shows, with each container's child terms nested in its childTags. Covenants and reporting deliverables are left to their own include keys.\n - Requires the `READ:TAG` capability.\n- `covenants` — adds the loan's covenants: one entry per hardCovenant, softCovenant or otherCovenantReference container, with its terms nested in its childTags. A covenant struck by a later document is kept, with its rightIsStricken child.\n - Requires the `READ:TAG` capability.\n- `deliverables` — adds the loan's financial reporting deliverables: one entry per financialReportingDeliverable container, with its terms nested in its childTags. A deliverable struck by a later document is kept, with its rightIsStricken child.\n - Requires the `READ:TAG` capability.\n- `documents` — adds per-document page geometry keyed by loanDocId, for resolving `tagSelections[].docPageId` references.\n - Requires the `READ:DOCUMENT` capability.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["summary","covenants","deliverables","documents"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Optional collections to populate. Unknown keys are rejected with 400.\n\n- `summary` — adds the loan's consolidated summary terms, the values the loan page shows, with each container's child terms nested in its childTags. Covenants and reporting deliverables are left to their own include keys.\n - Requires the `READ:TAG` capability.\n- `covenants` — adds the loan's covenants: one entry per hardCovenant, softCovenant or otherCovenantReference container, with its terms nested in its childTags. A covenant struck by a later document is kept, with its rightIsStricken child.\n - Requires the `READ:TAG` capability.\n- `deliverables` — adds the loan's financial reporting deliverables: one entry per financialReportingDeliverable container, with its terms nested in its childTags. A deliverable struck by a later document is kept, with its rightIsStricken child.\n - Requires the `READ:TAG` capability.\n- `documents` — adds per-document page geometry keyed by loanDocId, for resolving `tagSelections[].docPageId` references.\n - Requires the `READ:DOCUMENT` capability.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}}},"responses":{"130eec1f-3bc9-4e05-887f-c8146b6e26c5":{"description":"OK","content":{"*/*":{"schema":{"type":"object","description":"Representation of a single Loan. A Loan is secured by one or more of the Account's Buildings, listed in `collateral`. The terms Prophia reads from its documents are returned through the `summary`, `covenants` and `deliverables` include keys.","properties":{"id":{"type":"string","description":"Stable loan identifier.","readOnly":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"The loan's name in Prophia.","uniqueKey":"name","typeLabel":"string"},"loanType":{"type":"string","description":"Free-text loan type, such as 'Construction Loan'.","uniqueKey":"loanType","typeLabel":"string"},"borrower":{"type":"string","description":"The borrower named in the loan's documents. Several borrowers are joined with '; '.","uniqueKey":"borrower","typeLabel":"string"},"lender":{"type":"string","description":"The lender's legal name in the loan's documents, or its common name when no legal name was captured. Several lenders are joined with '; '.","uniqueKey":"lender","typeLabel":"string"},"closingDate":{"type":"string","format":"date","description":"yyyy-MM-dd. The loan's closing date from its documents.","uniqueKey":"closingDate","typeLabel":"string\u003cdate>"},"status":{"type":"string","description":"The loan's processing status: whether Prophia has read its documents, not whether the loan is active, matured or paid off. PENDING once its documents are uploaded, PROCESSING while Prophia reads them, then COMPLETE or FAILED. Omitted before any document is uploaded.","enum":["PENDING","PROCESSING","COMPLETE","FAILED"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"Deep link to the loan's page in the Prophia app.","uniqueKey":"url","typeLabel":"string"},"collateral":{"type":"array","description":"The buildings pledged as collateral, each with its property.","items":{"type":"object","description":"A building pledged as collateral for the loan, with the property it belongs to.","properties":{"buildingId":{"type":"string","description":"Stable building identifier.","uniqueKey":"collateral.items.[INDEX].buildingId","typeLabel":"string"},"buildingName":{"type":"string","description":"The building's name in Prophia.","uniqueKey":"collateral.items.[INDEX].buildingName","typeLabel":"string"},"propertyId":{"type":"string","description":"Stable identifier of the property the building belongs to.","uniqueKey":"collateral.items.[INDEX].propertyId","typeLabel":"string"},"propertyName":{"type":"string","description":"The property's name in Prophia.","uniqueKey":"collateral.items.[INDEX].propertyName","typeLabel":"string"}},"uniqueKey":"collateral.items.[INDEX]","typeLabel":"object"},"uniqueKey":"collateral","typeLabel":"object[]"},"summary":{"type":"array","description":"The loan's consolidated summary terms, the values the loan page shows, apart from covenants and reporting deliverables: one entry per term, with a container's terms nested in its childTags. Includes the all-in rate Prophia computes from the index and spread, which has no id or document. Populated only when the `summary` include key is requested. To resolve `tagSelections[].docPageId` to page geometry, also pass include=[\"documents\"].","items":{"type":"object","description":"A loan term read from the loan's documents: its typed value, where it was read, and for a container the terms nested under it.","properties":{"id":{"type":"string","description":"Stable loan tag identifier. Absent only on a value Prophia computes rather than reads from a document, such as the all-in rate built from the index and spread.","readOnly":true,"uniqueKey":"summary.items.[INDEX].id","typeLabel":"string"},"tagName":{"type":"string","description":"Canonical loan term name. A child term uses a dotted form such as 'lender.legalName'; the part before the dot names its container.","uniqueKey":"summary.items.[INDEX].tagName","typeLabel":"string"},"displayName":{"type":"string","description":"Human-readable label for the term.","uniqueKey":"summary.items.[INDEX].displayName","typeLabel":"string"},"category":{"type":"string","description":"STANDARD: a single term whose captured value is in `value`. COMPLEX: a container, such as a lender or a covenant, whose terms are nested in `childTags`; a container carries no `value` of its own.","enum":["STANDARD","COMPLEX","EXHIBIT"],"uniqueKey":"summary.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"object","title":"date","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `date` here.","enum":["date"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.0.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.0.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.0.ocrText","typeLabel":"string"},"value":{"type":"string","description":"Present when `kind` is `date`. The captured date, `yyyy-MM-dd`. Omitted when the captured text was not parseable as a date; `capturedData` still holds what was captured.","uniqueKey":"summary.items.[INDEX].value.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.0","typeLabel":"date · object"},{"type":"object","title":"dateRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `dateRange` here.","enum":["dateRange"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.1.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.1.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.1.ocrText","typeLabel":"string"},"start":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive start of the range, `yyyy-MM-dd`. Omitted together with `end` when `capturedData` could not be split into a parseable pair.","uniqueKey":"summary.items.[INDEX].value.oneOf.1.start","typeLabel":"string"},"end":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive end of the range, `yyyy-MM-dd`. Omitted together with `start` when `capturedData` could not be split into a parseable pair.","uniqueKey":"summary.items.[INDEX].value.oneOf.1.end","typeLabel":"string"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.1","typeLabel":"dateRange · object"},{"type":"object","title":"money","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `money` here.","enum":["money"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.2.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.2.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.2.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.2.ocrText","typeLabel":"string"},"value":{"type":"string","description":"Present when `kind` is `money`. Decimal string (not a JSON number) holding a BigDecimal rounded to 2 decimals — preserves cent precision through JSON, e.g. \"120000.00\".","uniqueKey":"summary.items.[INDEX].value.oneOf.2.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency code for the value (e.g. USD).","uniqueKey":"summary.items.[INDEX].value.oneOf.2.currency","typeLabel":"string"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.2","typeLabel":"money · object"},{"type":"object","title":"number","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `number` here.","enum":["number"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.3.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.3.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.3.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.3.ocrText","typeLabel":"string"},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"summary.items.[INDEX].value.oneOf.3.value","typeLabel":"number"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.3","typeLabel":"number · object"},{"type":"object","title":"numberRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `numberRange` here.","enum":["numberRange"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.4.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.4.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.4.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.4.ocrText","typeLabel":"string"},"start":{"type":"integer","format":"int32","description":"Inclusive start of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `end` when `capturedData` could not be split into a parseable pair.","uniqueKey":"summary.items.[INDEX].value.oneOf.4.start","typeLabel":"integer\u003cint32>"},"end":{"type":"integer","format":"int32","description":"Inclusive end of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `start` when `capturedData` could not be split into a parseable pair.","uniqueKey":"summary.items.[INDEX].value.oneOf.4.end","typeLabel":"integer\u003cint32>"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.4","typeLabel":"numberRange · object"},{"type":"object","title":"percent","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `percent` here.","enum":["percent"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.5.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.5.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.5.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.5.ocrText","typeLabel":"string"},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"summary.items.[INDEX].value.oneOf.5.value","typeLabel":"number"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.5","typeLabel":"percent · object"},{"type":"object","title":"text","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `text` here.","enum":["text"],"isRequired":true,"uniqueKey":"summary.items.[INDEX].value.oneOf.6.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"summary.items.[INDEX].value.oneOf.6.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"summary.items.[INDEX].value.oneOf.6.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"summary.items.[INDEX].value.oneOf.6.ocrText","typeLabel":"string"},"value":{"type":"string","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"summary.items.[INDEX].value.oneOf.6.value","typeLabel":"string"}},"uniqueKey":"summary.items.[INDEX].value.oneOf.6","typeLabel":"text · object"}],"uniqueKey":"summary.items.[INDEX].value","typeLabel":"date · object | dateRange · object | money · object | number · object | numberRange · object | percent · object | text · object"},"prepaymentPeriods":{"type":"array","description":"The rows of a prepaymentSchedule term, in sequence order. The schedule's citations are the term's own tagSelections; a period carries none. Absent when the term carries no periods.","items":{"type":"object","description":"One row of a prepayment schedule.","properties":{"sequence":{"type":"integer","format":"int32","description":"0-indexed position of the period in the schedule.","uniqueKey":"summary.items.[INDEX].prepaymentPeriods.items.[INDEX].sequence","typeLabel":"integer\u003cint32>"},"periodType":{"type":"string","description":"The period's type, such as Lockout, Penalty 1 or Freely Prepayable.","uniqueKey":"summary.items.[INDEX].prepaymentPeriods.items.[INDEX].periodType","typeLabel":"string"},"startDate":{"type":"string","format":"date","description":"First day of the period, yyyy-MM-dd.","uniqueKey":"summary.items.[INDEX].prepaymentPeriods.items.[INDEX].startDate","typeLabel":"string\u003cdate>"},"endDate":{"type":"string","format":"date","description":"Last day of the period, yyyy-MM-dd.","uniqueKey":"summary.items.[INDEX].prepaymentPeriods.items.[INDEX].endDate","typeLabel":"string\u003cdate>"},"description":{"type":"string","description":"What applies during the period.","uniqueKey":"summary.items.[INDEX].prepaymentPeriods.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"summary.items.[INDEX].prepaymentPeriods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"summary.items.[INDEX].prepaymentPeriods","typeLabel":"object[]"},"childTags":{"type":"array","description":"A container's terms, such as 'lender.legalName' under 'lender', sorted by tagName. Each is the current value across the loan's documents, so it can come from a different document than its container. Absent on a term that is not a container.","items":{"$circularRef":"efdffff6-e0d3-4684-ab41-8823eb6eaa99"},"uniqueKey":"summary.items.[INDEX].childTags","typeLabel":"array"},"lifecycleStatus":{"type":"string","description":"Lifecycle status of the term's own tag. A container stays ACTIVE when a later document strikes it; the strike shows as its rightIsStricken child instead.","enum":["ACTIVE","VOID","STRICKEN","EXERCISED"],"uniqueKey":"summary.items.[INDEX].lifecycleStatus","typeLabel":"enum\u003cstring>"},"customLabel":{"type":"string","description":"Label distinguishing one container from another of the same kind on the same loan, such as 'L #2'.","uniqueKey":"summary.items.[INDEX].customLabel","typeLabel":"string"},"loanId":{"type":"string","description":"The loan this term belongs to.","uniqueKey":"summary.items.[INDEX].loanId","typeLabel":"string"},"loanDocId":{"type":"string","description":"The loan document the term was read from. Absent on a computed value.","uniqueKey":"summary.items.[INDEX].loanDocId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"When the tag was written. Absent on a container and on a computed value.","uniqueKey":"summary.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the tag was last changed. Absent on a container and on a computed value.","uniqueKey":"summary.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"tagSelections":{"type":"array","description":"Citations: bounding boxes on the loan document's pages showing where the value was read, in sequence order. Resolve `docPageId` with the loan's `documents` include. Absent on a container and when the term carries none.","items":{"type":"object","description":"One citation: a bounding box on a specific document page.","properties":{"docPageId":{"type":"string","description":"The Page Id (UUID) of the document page the citation sits on; resolve via `include=pages` on the tag or the document's pages listing.","uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].docPageId","typeLabel":"string"},"boundingBox":{"type":"object","description":"Rectangle on the page locating this citation. Coordinates are ten-thousandths of the page dimensions (0–10000), origin top-left — not the pixel space of `PageModel.width` and `PageModel.height`. See the BoundingBox schema for the conversion.","properties":{"x":{"type":"integer","format":"int32","description":"Left edge, in ten-thousandths of the page width (0–10000).","uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].boundingBox.x","typeLabel":"integer\u003cint32>"},"y":{"type":"integer","format":"int32","description":"Top edge, in ten-thousandths of the page height (0–10000).","uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].boundingBox.y","typeLabel":"integer\u003cint32>"},"width":{"type":"integer","format":"int32","description":"Box width, in ten-thousandths of the page width (0–10000). `x + width` can come back as 10001 for a box flush against the right edge.","uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].boundingBox.width","typeLabel":"integer\u003cint32>"},"height":{"type":"integer","format":"int32","description":"Box height, in ten-thousandths of the page height (0–10000). `y + height` can come back as 10001 for a box flush against the bottom edge.","uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].boundingBox.height","typeLabel":"integer\u003cint32>"}},"uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].boundingBox","typeLabel":"object"},"sequence":{"type":"integer","format":"int32","description":"0-based order of this citation within the tag's selections.","uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX].sequence","typeLabel":"integer\u003cint32>"}},"uniqueKey":"summary.items.[INDEX].tagSelections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"summary.items.[INDEX].tagSelections","typeLabel":"object[]"},"url":{"type":"string","description":"Deep link to the loan document the term was read from, in the Prophia app. Absent on a computed value.","uniqueKey":"summary.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"summary.items.[INDEX]","typeLabel":"object"},"uniqueKey":"summary","typeLabel":"object[]"},"covenants":{"type":"array","description":"The loan's covenants: one entry per hardCovenant, softCovenant or otherCovenantReference container, with its terms nested in childTags. Two covenants of the same kind are separate entries, told apart by customLabel. A covenant struck by a later document is kept, with a rightIsStricken child. Populated only when the `covenants` include key is requested; empty when the loan has none.","items":{"type":"object","description":"A loan term read from the loan's documents: its typed value, where it was read, and for a container the terms nested under it.","properties":{"id":{"type":"string","description":"Stable loan tag identifier. Absent only on a value Prophia computes rather than reads from a document, such as the all-in rate built from the index and spread.","readOnly":true,"uniqueKey":"covenants.items.[INDEX].id","typeLabel":"string"},"tagName":{"type":"string","description":"Canonical loan term name. A child term uses a dotted form such as 'lender.legalName'; the part before the dot names its container.","uniqueKey":"covenants.items.[INDEX].tagName","typeLabel":"string"},"displayName":{"type":"string","description":"Human-readable label for the term.","uniqueKey":"covenants.items.[INDEX].displayName","typeLabel":"string"},"category":{"type":"string","description":"STANDARD: a single term whose captured value is in `value`. COMPLEX: a container, such as a lender or a covenant, whose terms are nested in `childTags`; a container carries no `value` of its own.","enum":["STANDARD","COMPLEX","EXHIBIT"],"uniqueKey":"covenants.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"object","title":"date","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `date` here.","enum":["date"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.0.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.0.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.0.ocrText","typeLabel":"string"},"value":{"type":"string","description":"Present when `kind` is `date`. The captured date, `yyyy-MM-dd`. Omitted when the captured text was not parseable as a date; `capturedData` still holds what was captured.","uniqueKey":"covenants.items.[INDEX].value.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.0","typeLabel":"date · object"},{"type":"object","title":"dateRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `dateRange` here.","enum":["dateRange"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.1.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.1.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.1.ocrText","typeLabel":"string"},"start":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive start of the range, `yyyy-MM-dd`. Omitted together with `end` when `capturedData` could not be split into a parseable pair.","uniqueKey":"covenants.items.[INDEX].value.oneOf.1.start","typeLabel":"string"},"end":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive end of the range, `yyyy-MM-dd`. Omitted together with `start` when `capturedData` could not be split into a parseable pair.","uniqueKey":"covenants.items.[INDEX].value.oneOf.1.end","typeLabel":"string"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.1","typeLabel":"dateRange · object"},{"type":"object","title":"money","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `money` here.","enum":["money"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.2.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.2.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.2.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.2.ocrText","typeLabel":"string"},"value":{"type":"string","description":"Present when `kind` is `money`. Decimal string (not a JSON number) holding a BigDecimal rounded to 2 decimals — preserves cent precision through JSON, e.g. \"120000.00\".","uniqueKey":"covenants.items.[INDEX].value.oneOf.2.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency code for the value (e.g. USD).","uniqueKey":"covenants.items.[INDEX].value.oneOf.2.currency","typeLabel":"string"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.2","typeLabel":"money · object"},{"type":"object","title":"number","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `number` here.","enum":["number"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.3.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.3.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.3.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.3.ocrText","typeLabel":"string"},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"covenants.items.[INDEX].value.oneOf.3.value","typeLabel":"number"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.3","typeLabel":"number · object"},{"type":"object","title":"numberRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `numberRange` here.","enum":["numberRange"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.4.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.4.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.4.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.4.ocrText","typeLabel":"string"},"start":{"type":"integer","format":"int32","description":"Inclusive start of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `end` when `capturedData` could not be split into a parseable pair.","uniqueKey":"covenants.items.[INDEX].value.oneOf.4.start","typeLabel":"integer\u003cint32>"},"end":{"type":"integer","format":"int32","description":"Inclusive end of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `start` when `capturedData` could not be split into a parseable pair.","uniqueKey":"covenants.items.[INDEX].value.oneOf.4.end","typeLabel":"integer\u003cint32>"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.4","typeLabel":"numberRange · object"},{"type":"object","title":"percent","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `percent` here.","enum":["percent"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.5.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.5.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.5.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.5.ocrText","typeLabel":"string"},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"covenants.items.[INDEX].value.oneOf.5.value","typeLabel":"number"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.5","typeLabel":"percent · object"},{"type":"object","title":"text","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `text` here.","enum":["text"],"isRequired":true,"uniqueKey":"covenants.items.[INDEX].value.oneOf.6.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"covenants.items.[INDEX].value.oneOf.6.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"covenants.items.[INDEX].value.oneOf.6.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"covenants.items.[INDEX].value.oneOf.6.ocrText","typeLabel":"string"},"value":{"type":"string","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"covenants.items.[INDEX].value.oneOf.6.value","typeLabel":"string"}},"uniqueKey":"covenants.items.[INDEX].value.oneOf.6","typeLabel":"text · object"}],"uniqueKey":"covenants.items.[INDEX].value","typeLabel":"date · object | dateRange · object | money · object | number · object | numberRange · object | percent · object | text · object"},"prepaymentPeriods":{"type":"array","description":"The rows of a prepaymentSchedule term, in sequence order. The schedule's citations are the term's own tagSelections; a period carries none. Absent when the term carries no periods.","items":{"type":"object","description":"One row of a prepayment schedule.","properties":{"sequence":{"type":"integer","format":"int32","description":"0-indexed position of the period in the schedule.","uniqueKey":"covenants.items.[INDEX].prepaymentPeriods.items.[INDEX].sequence","typeLabel":"integer\u003cint32>"},"periodType":{"type":"string","description":"The period's type, such as Lockout, Penalty 1 or Freely Prepayable.","uniqueKey":"covenants.items.[INDEX].prepaymentPeriods.items.[INDEX].periodType","typeLabel":"string"},"startDate":{"type":"string","format":"date","description":"First day of the period, yyyy-MM-dd.","uniqueKey":"covenants.items.[INDEX].prepaymentPeriods.items.[INDEX].startDate","typeLabel":"string\u003cdate>"},"endDate":{"type":"string","format":"date","description":"Last day of the period, yyyy-MM-dd.","uniqueKey":"covenants.items.[INDEX].prepaymentPeriods.items.[INDEX].endDate","typeLabel":"string\u003cdate>"},"description":{"type":"string","description":"What applies during the period.","uniqueKey":"covenants.items.[INDEX].prepaymentPeriods.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"covenants.items.[INDEX].prepaymentPeriods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"covenants.items.[INDEX].prepaymentPeriods","typeLabel":"object[]"},"childTags":{"type":"array","description":"A container's terms, such as 'lender.legalName' under 'lender', sorted by tagName. Each is the current value across the loan's documents, so it can come from a different document than its container. Absent on a term that is not a container.","items":{"$circularRef":"efdffff6-e0d3-4684-ab41-8823eb6eaa99"},"uniqueKey":"covenants.items.[INDEX].childTags","typeLabel":"array"},"lifecycleStatus":{"type":"string","description":"Lifecycle status of the term's own tag. A container stays ACTIVE when a later document strikes it; the strike shows as its rightIsStricken child instead.","enum":["ACTIVE","VOID","STRICKEN","EXERCISED"],"uniqueKey":"covenants.items.[INDEX].lifecycleStatus","typeLabel":"enum\u003cstring>"},"customLabel":{"type":"string","description":"Label distinguishing one container from another of the same kind on the same loan, such as 'L #2'.","uniqueKey":"covenants.items.[INDEX].customLabel","typeLabel":"string"},"loanId":{"type":"string","description":"The loan this term belongs to.","uniqueKey":"covenants.items.[INDEX].loanId","typeLabel":"string"},"loanDocId":{"type":"string","description":"The loan document the term was read from. Absent on a computed value.","uniqueKey":"covenants.items.[INDEX].loanDocId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"When the tag was written. Absent on a container and on a computed value.","uniqueKey":"covenants.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the tag was last changed. Absent on a container and on a computed value.","uniqueKey":"covenants.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"tagSelections":{"type":"array","description":"Citations: bounding boxes on the loan document's pages showing where the value was read, in sequence order. Resolve `docPageId` with the loan's `documents` include. Absent on a container and when the term carries none.","items":{"type":"object","description":"One citation: a bounding box on a specific document page.","properties":{"docPageId":{"type":"string","description":"The Page Id (UUID) of the document page the citation sits on; resolve via `include=pages` on the tag or the document's pages listing.","uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].docPageId","typeLabel":"string"},"boundingBox":{"type":"object","description":"Rectangle on the page locating this citation. Coordinates are ten-thousandths of the page dimensions (0–10000), origin top-left — not the pixel space of `PageModel.width` and `PageModel.height`. See the BoundingBox schema for the conversion.","properties":{"x":{"type":"integer","format":"int32","description":"Left edge, in ten-thousandths of the page width (0–10000).","uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].boundingBox.x","typeLabel":"integer\u003cint32>"},"y":{"type":"integer","format":"int32","description":"Top edge, in ten-thousandths of the page height (0–10000).","uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].boundingBox.y","typeLabel":"integer\u003cint32>"},"width":{"type":"integer","format":"int32","description":"Box width, in ten-thousandths of the page width (0–10000). `x + width` can come back as 10001 for a box flush against the right edge.","uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].boundingBox.width","typeLabel":"integer\u003cint32>"},"height":{"type":"integer","format":"int32","description":"Box height, in ten-thousandths of the page height (0–10000). `y + height` can come back as 10001 for a box flush against the bottom edge.","uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].boundingBox.height","typeLabel":"integer\u003cint32>"}},"uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].boundingBox","typeLabel":"object"},"sequence":{"type":"integer","format":"int32","description":"0-based order of this citation within the tag's selections.","uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX].sequence","typeLabel":"integer\u003cint32>"}},"uniqueKey":"covenants.items.[INDEX].tagSelections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"covenants.items.[INDEX].tagSelections","typeLabel":"object[]"},"url":{"type":"string","description":"Deep link to the loan document the term was read from, in the Prophia app. Absent on a computed value.","uniqueKey":"covenants.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"covenants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"covenants","typeLabel":"object[]"},"deliverables":{"type":"array","description":"The loan's financial reporting deliverables: one entry per financialReportingDeliverable container, with its terms nested in childTags. A deliverable struck by a later document is kept, with a rightIsStricken child. Populated only when the `deliverables` include key is requested; empty when the loan has none.","items":{"type":"object","description":"A loan term read from the loan's documents: its typed value, where it was read, and for a container the terms nested under it.","properties":{"id":{"type":"string","description":"Stable loan tag identifier. Absent only on a value Prophia computes rather than reads from a document, such as the all-in rate built from the index and spread.","readOnly":true,"uniqueKey":"deliverables.items.[INDEX].id","typeLabel":"string"},"tagName":{"type":"string","description":"Canonical loan term name. A child term uses a dotted form such as 'lender.legalName'; the part before the dot names its container.","uniqueKey":"deliverables.items.[INDEX].tagName","typeLabel":"string"},"displayName":{"type":"string","description":"Human-readable label for the term.","uniqueKey":"deliverables.items.[INDEX].displayName","typeLabel":"string"},"category":{"type":"string","description":"STANDARD: a single term whose captured value is in `value`. COMPLEX: a container, such as a lender or a covenant, whose terms are nested in `childTags`; a container carries no `value` of its own.","enum":["STANDARD","COMPLEX","EXHIBIT"],"uniqueKey":"deliverables.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"object","title":"date","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `date` here.","enum":["date"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.0.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.0.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.0.ocrText","typeLabel":"string"},"value":{"type":"string","description":"Present when `kind` is `date`. The captured date, `yyyy-MM-dd`. Omitted when the captured text was not parseable as a date; `capturedData` still holds what was captured.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.0","typeLabel":"date · object"},{"type":"object","title":"dateRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `dateRange` here.","enum":["dateRange"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.1.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.1.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.1.ocrText","typeLabel":"string"},"start":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive start of the range, `yyyy-MM-dd`. Omitted together with `end` when `capturedData` could not be split into a parseable pair.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.1.start","typeLabel":"string"},"end":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive end of the range, `yyyy-MM-dd`. Omitted together with `start` when `capturedData` could not be split into a parseable pair.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.1.end","typeLabel":"string"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.1","typeLabel":"dateRange · object"},{"type":"object","title":"money","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `money` here.","enum":["money"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.2.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.2.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.2.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.2.ocrText","typeLabel":"string"},"value":{"type":"string","description":"Present when `kind` is `money`. Decimal string (not a JSON number) holding a BigDecimal rounded to 2 decimals — preserves cent precision through JSON, e.g. \"120000.00\".","uniqueKey":"deliverables.items.[INDEX].value.oneOf.2.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency code for the value (e.g. USD).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.2.currency","typeLabel":"string"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.2","typeLabel":"money · object"},{"type":"object","title":"number","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `number` here.","enum":["number"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.3.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.3.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.3.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.3.ocrText","typeLabel":"string"},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.3.value","typeLabel":"number"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.3","typeLabel":"number · object"},{"type":"object","title":"numberRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `numberRange` here.","enum":["numberRange"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.4.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.4.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.4.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.4.ocrText","typeLabel":"string"},"start":{"type":"integer","format":"int32","description":"Inclusive start of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `end` when `capturedData` could not be split into a parseable pair.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.4.start","typeLabel":"integer\u003cint32>"},"end":{"type":"integer","format":"int32","description":"Inclusive end of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `start` when `capturedData` could not be split into a parseable pair.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.4.end","typeLabel":"integer\u003cint32>"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.4","typeLabel":"numberRange · object"},{"type":"object","title":"percent","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `percent` here.","enum":["percent"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.5.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.5.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.5.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.5.ocrText","typeLabel":"string"},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.5.value","typeLabel":"number"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.5","typeLabel":"percent · object"},{"type":"object","title":"text","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `text` here.","enum":["text"],"isRequired":true,"uniqueKey":"deliverables.items.[INDEX].value.oneOf.6.kind","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot).","uniqueKey":"deliverables.items.[INDEX].value.oneOf.6.unit","typeLabel":"string"},"capturedData":{"type":"string","description":"The value as captured during extraction, as text.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.6.capturedData","typeLabel":"string"},"ocrText":{"type":"string","description":"Raw source text the value was extracted from.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.6.ocrText","typeLabel":"string"},"value":{"type":"string","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type.","uniqueKey":"deliverables.items.[INDEX].value.oneOf.6.value","typeLabel":"string"}},"uniqueKey":"deliverables.items.[INDEX].value.oneOf.6","typeLabel":"text · object"}],"uniqueKey":"deliverables.items.[INDEX].value","typeLabel":"date · object | dateRange · object | money · object | number · object | numberRange · object | percent · object | text · object"},"prepaymentPeriods":{"type":"array","description":"The rows of a prepaymentSchedule term, in sequence order. The schedule's citations are the term's own tagSelections; a period carries none. Absent when the term carries no periods.","items":{"type":"object","description":"One row of a prepayment schedule.","properties":{"sequence":{"type":"integer","format":"int32","description":"0-indexed position of the period in the schedule.","uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods.items.[INDEX].sequence","typeLabel":"integer\u003cint32>"},"periodType":{"type":"string","description":"The period's type, such as Lockout, Penalty 1 or Freely Prepayable.","uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods.items.[INDEX].periodType","typeLabel":"string"},"startDate":{"type":"string","format":"date","description":"First day of the period, yyyy-MM-dd.","uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods.items.[INDEX].startDate","typeLabel":"string\u003cdate>"},"endDate":{"type":"string","format":"date","description":"Last day of the period, yyyy-MM-dd.","uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods.items.[INDEX].endDate","typeLabel":"string\u003cdate>"},"description":{"type":"string","description":"What applies during the period.","uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deliverables.items.[INDEX].prepaymentPeriods","typeLabel":"object[]"},"childTags":{"type":"array","description":"A container's terms, such as 'lender.legalName' under 'lender', sorted by tagName. Each is the current value across the loan's documents, so it can come from a different document than its container. Absent on a term that is not a container.","items":{"$circularRef":"efdffff6-e0d3-4684-ab41-8823eb6eaa99"},"uniqueKey":"deliverables.items.[INDEX].childTags","typeLabel":"array"},"lifecycleStatus":{"type":"string","description":"Lifecycle status of the term's own tag. A container stays ACTIVE when a later document strikes it; the strike shows as its rightIsStricken child instead.","enum":["ACTIVE","VOID","STRICKEN","EXERCISED"],"uniqueKey":"deliverables.items.[INDEX].lifecycleStatus","typeLabel":"enum\u003cstring>"},"customLabel":{"type":"string","description":"Label distinguishing one container from another of the same kind on the same loan, such as 'L #2'.","uniqueKey":"deliverables.items.[INDEX].customLabel","typeLabel":"string"},"loanId":{"type":"string","description":"The loan this term belongs to.","uniqueKey":"deliverables.items.[INDEX].loanId","typeLabel":"string"},"loanDocId":{"type":"string","description":"The loan document the term was read from. Absent on a computed value.","uniqueKey":"deliverables.items.[INDEX].loanDocId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"When the tag was written. Absent on a container and on a computed value.","uniqueKey":"deliverables.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the tag was last changed. Absent on a container and on a computed value.","uniqueKey":"deliverables.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"tagSelections":{"type":"array","description":"Citations: bounding boxes on the loan document's pages showing where the value was read, in sequence order. Resolve `docPageId` with the loan's `documents` include. Absent on a container and when the term carries none.","items":{"type":"object","description":"One citation: a bounding box on a specific document page.","properties":{"docPageId":{"type":"string","description":"The Page Id (UUID) of the document page the citation sits on; resolve via `include=pages` on the tag or the document's pages listing.","uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].docPageId","typeLabel":"string"},"boundingBox":{"type":"object","description":"Rectangle on the page locating this citation. Coordinates are ten-thousandths of the page dimensions (0–10000), origin top-left — not the pixel space of `PageModel.width` and `PageModel.height`. See the BoundingBox schema for the conversion.","properties":{"x":{"type":"integer","format":"int32","description":"Left edge, in ten-thousandths of the page width (0–10000).","uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].boundingBox.x","typeLabel":"integer\u003cint32>"},"y":{"type":"integer","format":"int32","description":"Top edge, in ten-thousandths of the page height (0–10000).","uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].boundingBox.y","typeLabel":"integer\u003cint32>"},"width":{"type":"integer","format":"int32","description":"Box width, in ten-thousandths of the page width (0–10000). `x + width` can come back as 10001 for a box flush against the right edge.","uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].boundingBox.width","typeLabel":"integer\u003cint32>"},"height":{"type":"integer","format":"int32","description":"Box height, in ten-thousandths of the page height (0–10000). `y + height` can come back as 10001 for a box flush against the bottom edge.","uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].boundingBox.height","typeLabel":"integer\u003cint32>"}},"uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].boundingBox","typeLabel":"object"},"sequence":{"type":"integer","format":"int32","description":"0-based order of this citation within the tag's selections.","uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX].sequence","typeLabel":"integer\u003cint32>"}},"uniqueKey":"deliverables.items.[INDEX].tagSelections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deliverables.items.[INDEX].tagSelections","typeLabel":"object[]"},"url":{"type":"string","description":"Deep link to the loan document the term was read from, in the Prophia app. Absent on a computed value.","uniqueKey":"deliverables.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"deliverables.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deliverables","typeLabel":"object[]"},"documents":{"type":"object","additionalProperties":{"type":"object","description":"The pages of a single document. Appears as the values of a lease's or loan's `documents` map, which is keyed by document id, so `documents[documentId].pages[docPageId]` resolves a tag citation to the page it sits on and the dimensions its bounding boxes scale against.","properties":{"pages":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","description":"Document page id; matches `tagSelections[].docPageId`.","uniqueKey":"documents.additionalProperties.pages.additionalProperties.id","typeLabel":"string"},"pageSequence":{"type":"integer","format":"int32","description":"Position of the page within its document.","uniqueKey":"documents.additionalProperties.pages.additionalProperties.pageSequence","typeLabel":"integer\u003cint32>"},"width":{"type":"integer","format":"int32","description":"Page width in the OCR pipeline's native units (typically pixels). Scale a tag citation onto this page with `pixel_x = boundingBox.x * width / 10000`.","uniqueKey":"documents.additionalProperties.pages.additionalProperties.width","typeLabel":"integer\u003cint32>"},"height":{"type":"integer","format":"int32","description":"Page height in the OCR pipeline's native units (typically pixels). Scale a tag citation onto this page with `pixel_y = boundingBox.y * height / 10000`.","uniqueKey":"documents.additionalProperties.pages.additionalProperties.height","typeLabel":"integer\u003cint32>"}},"uniqueKey":"documents.additionalProperties.pages.additionalProperties","typeLabel":"object"},"description":"Page geometry keyed by document page id — the value a tag citation carries in `tagSelections[].docPageId`. The page's own `id` field is omitted here because the id is the key; under a tag's `pages` include the same model carries `id` instead.","uniqueKey":"documents.additionalProperties.pages","typeLabel":"object"}},"uniqueKey":"documents.additionalProperties","typeLabel":"object"},"description":"Per-document page geometry keyed by loanDocId, then by docPageId under `pages`. Populated only when the `documents` include key is requested, and omitted when the loan's documents have no pages yet.","uniqueKey":"documents","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","loanType":"\u003cstring>","borrower":"\u003cstring>","lender":"\u003cstring>","closingDate":"2023-12-25","status":"PENDING","url":"\u003cstring>","collateral":[{"buildingId":"\u003cstring>","buildingName":"\u003cstring>","propertyId":"\u003cstring>","propertyName":"\u003cstring>"}],"summary":[{"id":"\u003cstring>","tagName":"\u003cstring>","displayName":"\u003cstring>","category":"STANDARD","value":{"kind":"date","unit":"\u003cstring>","capturedData":"\u003cstring>","ocrText":"\u003cstring>","value":"\u003cstring>"},"prepaymentPeriods":[{"sequence":123,"periodType":"\u003cstring>","startDate":"2023-12-25","endDate":"2023-12-25","description":"\u003cstring>"}],"childTags":"\u003carray>","lifecycleStatus":"ACTIVE","customLabel":"\u003cstring>","loanId":"\u003cstring>","loanDocId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","tagSelections":[{"docPageId":"\u003cstring>","boundingBox":{"x":123,"y":123,"width":123,"height":123},"sequence":123}],"url":"\u003cstring>"}],"covenants":[{"id":"\u003cstring>","tagName":"\u003cstring>","displayName":"\u003cstring>","category":"STANDARD","value":{"kind":"date","unit":"\u003cstring>","capturedData":"\u003cstring>","ocrText":"\u003cstring>","value":"\u003cstring>"},"prepaymentPeriods":[{"sequence":123,"periodType":"\u003cstring>","startDate":"2023-12-25","endDate":"2023-12-25","description":"\u003cstring>"}],"childTags":"\u003carray>","lifecycleStatus":"ACTIVE","customLabel":"\u003cstring>","loanId":"\u003cstring>","loanDocId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","tagSelections":[{"docPageId":"\u003cstring>","boundingBox":{"x":123,"y":123,"width":123,"height":123},"sequence":123}],"url":"\u003cstring>"}],"deliverables":[{"id":"\u003cstring>","tagName":"\u003cstring>","displayName":"\u003cstring>","category":"STANDARD","value":{"kind":"date","unit":"\u003cstring>","capturedData":"\u003cstring>","ocrText":"\u003cstring>","value":"\u003cstring>"},"prepaymentPeriods":[{"sequence":123,"periodType":"\u003cstring>","startDate":"2023-12-25","endDate":"2023-12-25","description":"\u003cstring>"}],"childTags":"\u003carray>","lifecycleStatus":"ACTIVE","customLabel":"\u003cstring>","loanId":"\u003cstring>","loanDocId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","tagSelections":[{"docPageId":"\u003cstring>","boundingBox":{"x":123,"y":123,"width":123,"height":123},"sequence":123}],"url":"\u003cstring>"}],"documents":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"d9870029-cff6-44e9-9f6a-649839a5c2d5":{"description":"Invalid input — for example an unknown `include` key or a malformed parameter value","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Stable error category","example":"Invalid Input","uniqueKey":"error","typeLabel":"string"},"errorCode":{"type":"string","description":"Stable error code suitable for programmatic handling","example":"InvalidInput","uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail; may aggregate multiple field errors","uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","description":"HTTP status of the response as code and reason phrase, matching the response's own status line","example":"404 NOT_FOUND","uniqueKey":"status","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"When the error was produced, as an ISO-8601 UTC instant","example":"2026-09-02T20:41:03.118Z","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"localizedMessage":{"type":"string","description":"Same text as `message`; present because the body is a serialized exception. Prefer `message`","uniqueKey":"localizedMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Invalid Input","errorCode":"InvalidInput","message":"Unknown include keys: [bogus]; supported: [tags, documents, subleases]","status":"400 BAD_REQUEST","timestamp":"2026-09-02T20:41:03.118Z","localizedMessage":"Unknown include keys: [bogus]; supported: [tags, documents, subleases]"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid Input","errorCode":"InvalidInput","message":"Unknown include keys: [bogus]; supported: [tags, documents, subleases]","status":"400 BAD_REQUEST","timestamp":"2026-09-02T20:41:03.118Z","localizedMessage":"Unknown include keys: [bogus]; supported: [tags, documents, subleases]"}}},"exampleType":"examples"}},"exampleType":"examples"},"597d6ff4-2e8e-4859-adae-7b77c886c601":{"description":"The credential was rejected before the request reached the endpoint — for example a JWT was presented where an API key is required. Only `error` is populated on this path","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Stable error category","example":"Invalid Input","uniqueKey":"error","typeLabel":"string"},"errorCode":{"type":"string","description":"Stable error code suitable for programmatic handling","example":"InvalidInput","uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail; may aggregate multiple field errors","uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","description":"HTTP status of the response as code and reason phrase, matching the response's own status line","example":"404 NOT_FOUND","uniqueKey":"status","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"When the error was produced, as an ISO-8601 UTC instant","example":"2026-09-02T20:41:03.118Z","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"localizedMessage":{"type":"string","description":"Same text as `message`; present because the body is a serialized exception. Prefer `message`","uniqueKey":"localizedMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"JWT authentication is not supported. Use an API key."},"examples":{"Example":{"title":"Example","value":{"error":"JWT authentication is not supported. Use an API key."}}},"exampleType":"examples"}},"exampleType":"examples"},"5637e127-a8c7-4c3d-9a2b-39c6c87427fc":{"description":"The API key is valid but lacks a required capability, or its building permissions do not cover the requested resource. The message names the missing capabilities only in the former case","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Stable error category","example":"Invalid Input","uniqueKey":"error","typeLabel":"string"},"errorCode":{"type":"string","description":"Stable error code suitable for programmatic handling","example":"InvalidInput","uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail; may aggregate multiple field errors","uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","description":"HTTP status of the response as code and reason phrase, matching the response's own status line","example":"404 NOT_FOUND","uniqueKey":"status","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"When the error was produced, as an ISO-8601 UTC instant","example":"2026-09-02T20:41:03.118Z","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"localizedMessage":{"type":"string","description":"Same text as `message`; present because the body is a serialized exception. Prefer `message`","uniqueKey":"localizedMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Access Denied","errorCode":"AccessDenied","message":"Not authorized. Missing capabilities: READ:TAG","status":"403 FORBIDDEN","timestamp":"2026-09-02T20:41:03.118Z","localizedMessage":"Not authorized. Missing capabilities: READ:TAG"},"examples":{"Example":{"title":"Example","value":{"error":"Access Denied","errorCode":"AccessDenied","message":"Not authorized. Missing capabilities: READ:TAG","status":"403 FORBIDDEN","timestamp":"2026-09-02T20:41:03.118Z","localizedMessage":"Not authorized. Missing capabilities: READ:TAG"}}},"exampleType":"examples"}},"exampleType":"examples"},"8b0ab272-6c40-42d4-b481-9f50402aa4be":{"description":"No such resource is visible to the account named in the path","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Stable error category","example":"Invalid Input","uniqueKey":"error","typeLabel":"string"},"errorCode":{"type":"string","description":"Stable error code suitable for programmatic handling","example":"InvalidInput","uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail; may aggregate multiple field errors","uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","description":"HTTP status of the response as code and reason phrase, matching the response's own status line","example":"404 NOT_FOUND","uniqueKey":"status","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"When the error was produced, as an ISO-8601 UTC instant","example":"2026-09-02T20:41:03.118Z","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"localizedMessage":{"type":"string","description":"Same text as `message`; present because the body is a serialized exception. Prefer `message`","uniqueKey":"localizedMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Entity Not Found","errorCode":"EntityNotFound","message":"This entity is not found in the system.","status":"404 NOT_FOUND","timestamp":"2026-09-02T20:41:03.118Z","localizedMessage":"This entity is not found in the system."},"examples":{"Example":{"title":"Example","value":{"error":"Entity Not Found","errorCode":"EntityNotFound","message":"This entity is not found in the system.","status":"404 NOT_FOUND","timestamp":"2026-09-02T20:41:03.118Z","localizedMessage":"This entity is not found in the system."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"a4b573e8-9e27-4cda-bbfc-fe4bf588b6a5":{"apiKey":{"type":"apiKey","description":"Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the `X-API-Key` header, or equivalently as `Authorization: Bearer \u003capi-key>`. JWTs are rejected on /rest endpoints with 401.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"ac2c6829-ec34-4f73-950d-564389c250a7":{"url":"https://api.prophia.com","description":"Prophia API"}},"schemas":{"efdffff6-e0d3-4684-ab41-8823eb6eaa99":{"type":"object","description":"A loan term read from the loan's documents: its typed value, where it was read, and for a container the terms nested under it.","properties":{"tagName":{"type":"string","description":"Canonical loan term name. A child term uses a dotted form such as 'lender.legalName'; the part before the dot names its container."},"displayName":{"type":"string","description":"Human-readable label for the term."},"category":{"type":"string","description":"STANDARD: a single term whose captured value is in `value`. COMPLEX: a container, such as a lender or a covenant, whose terms are nested in `childTags`; a container carries no `value` of its own.","enum":["STANDARD","COMPLEX","EXHIBIT"]},"value":{"oneOf":[{"type":"object","title":"date","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `date` here.","enum":["date"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"value":{"type":"string","description":"Present when `kind` is `date`. The captured date, `yyyy-MM-dd`. Omitted when the captured text was not parseable as a date; `capturedData` still holds what was captured."}}},{"type":"object","title":"dateRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `dateRange` here.","enum":["dateRange"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"start":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive start of the range, `yyyy-MM-dd`. Omitted together with `end` when `capturedData` could not be split into a parseable pair."},"end":{"type":"string","description":"Present when `kind` is `dateRange`. Inclusive end of the range, `yyyy-MM-dd`. Omitted together with `start` when `capturedData` could not be split into a parseable pair."}}},{"type":"object","title":"money","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `money` here.","enum":["money"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"value":{"type":"string","description":"Present when `kind` is `money`. Decimal string (not a JSON number) holding a BigDecimal rounded to 2 decimals — preserves cent precision through JSON, e.g. \"120000.00\"."},"currency":{"type":"string","description":"Currency code for the value (e.g. USD)."}}},{"type":"object","title":"number","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `number` here.","enum":["number"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type."}}},{"type":"object","title":"numberRange","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `numberRange` here.","enum":["numberRange"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"start":{"type":"integer","format":"int32","description":"Inclusive start of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `end` when `capturedData` could not be split into a parseable pair."},"end":{"type":"integer","format":"int32","description":"Inclusive end of the range: a `yyyy-MM-dd` string for `dateRange`, an integer for `numberRange`. Omitted together with `start` when `capturedData` could not be split into a parseable pair."}}},{"type":"object","title":"percent","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `percent` here.","enum":["percent"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"value":{"type":"number","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type."}}},{"type":"object","title":"text","description":"The term's captured value. Branch on `kind` for its shape and read `unit` alongside it. A `money` value carries the currency of the loan's collateral buildings, or `MIXED` when the collateral spans more than one currency. Absent on a container.","required":["kind"],"properties":{"kind":{"type":"string","description":"Discriminator for this shape — always `text` here.","enum":["text"],"isRequired":true},"unit":{"type":"string","description":"Unit qualifier for the value when the source text carried one (e.g. months, per square foot)."},"capturedData":{"type":"string","description":"The value as captured during extraction, as text."},"ocrText":{"type":"string","description":"Raw source text the value was extracted from."},"value":{"type":"string","description":"The typed value. Its JSON type follows `kind`: a number for `number` and `percent`, a `yyyy-MM-dd` string for `date`, a decimal string for `money`, and the captured text for `text`. Omitted when `capturedData` could not be parsed into that type."}}}]},"prepaymentPeriods":{"type":"array","description":"The rows of a prepaymentSchedule term, in sequence order. The schedule's citations are the term's own tagSelections; a period carries none. Absent when the term carries no periods.","items":{"type":"object","description":"One row of a prepayment schedule.","properties":{"sequence":{"type":"integer","format":"int32","description":"0-indexed position of the period in the schedule."},"periodType":{"type":"string","description":"The period's type, such as Lockout, Penalty 1 or Freely Prepayable."},"startDate":{"type":"string","format":"date","description":"First day of the period, yyyy-MM-dd."},"endDate":{"type":"string","format":"date","description":"Last day of the period, yyyy-MM-dd."},"description":{"type":"string","description":"What applies during the period."}}}},"childTags":{"type":"array","description":"A container's terms, such as 'lender.legalName' under 'lender', sorted by tagName. Each is the current value across the loan's documents, so it can come from a different document than its container. Absent on a term that is not a container.","items":{"$circularRef":"efdffff6-e0d3-4684-ab41-8823eb6eaa99"}},"lifecycleStatus":{"type":"string","description":"Lifecycle status of the term's own tag. A container stays ACTIVE when a later document strikes it; the strike shows as its rightIsStricken child instead.","enum":["ACTIVE","VOID","STRICKEN","EXERCISED"]},"customLabel":{"type":"string","description":"Label distinguishing one container from another of the same kind on the same loan, such as 'L #2'."},"loanId":{"type":"string","description":"The loan this term belongs to."},"loanDocId":{"type":"string","description":"The loan document the term was read from. Absent on a computed value."},"createdAt":{"type":"string","format":"date-time","description":"When the tag was written. Absent on a container and on a computed value."},"updatedAt":{"type":"string","format":"date-time","description":"When the tag was last changed. Absent on a container and on a computed value."},"tagSelections":{"type":"array","description":"Citations: bounding boxes on the loan document's pages showing where the value was read, in sequence order. Resolve `docPageId` with the loan's `documents` include. Absent on a container and when the term carries none.","items":{"type":"object","description":"One citation: a bounding box on a specific document page.","properties":{"docPageId":{"type":"string","description":"The Page Id (UUID) of the document page the citation sits on; resolve via `include=pages` on the tag or the document's pages listing."},"boundingBox":{"type":"object","description":"Rectangle on the page locating this citation. Coordinates are ten-thousandths of the page dimensions (0–10000), origin top-left — not the pixel space of `PageModel.width` and `PageModel.height`. See the BoundingBox schema for the conversion.","properties":{"x":{"type":"integer","format":"int32","description":"Left edge, in ten-thousandths of the page width (0–10000)."},"y":{"type":"integer","format":"int32","description":"Top edge, in ten-thousandths of the page height (0–10000)."},"width":{"type":"integer","format":"int32","description":"Box width, in ten-thousandths of the page width (0–10000). `x + width` can come back as 10001 for a box flush against the right edge."},"height":{"type":"integer","format":"int32","description":"Box height, in ten-thousandths of the page height (0–10000). `y + height` can come back as 10001 for a box flush against the bottom edge."}}},"sequence":{"type":"integer","format":"int32","description":"0-based order of this citation within the tag's selections."}}}},"url":{"type":"string","description":"Deep link to the loan document the term was read from, in the Prophia app. Absent on a computed value."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the `X-API-Key` header, or equivalently as `Authorization: Bearer \u003capi-key>`. JWTs are rejected on /rest endpoints with 401.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the `X-API-Key` header, or equivalently as `Authorization: Bearer \u003capi-key>`. JWTs are rejected on /rest endpoints with 401.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"prophia","siteName":"Prophia Docs","title":"GET Loan - Prophia Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/loans/get-loan","matchLevel":0},"v1 (deprecated)":{"href":"/api-reference/v1/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T18:01:19.444Z","originalFileLocation":"api-reference/v2/loans/get-loan.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a single Loan by id, with its collateral buildings. status is the processing status of the loan\u0026#x27;s documents, not whether the loan is active, matured or paid off. Required capabilities: READ:LOAN\">\u003cmeta data-mint-head name=\"application-name\" content=\"Prophia Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_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/prophia/gMArIoMD4H40C8Fk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"GET Loan - Prophia Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single Loan by id, with its collateral buildings. status is the processing status of the loan\u0026#x27;s documents, not whether the loan is active, matured or paid off. Required capabilities: READ:LOAN\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Prophia Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.prophia.com/api-reference/v2/loans/get-loan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://prophia.mintlify.site/_mintlify/api/og/v2?division=Loans\u0026amp;title=GET+Loan\u0026amp;description=Returns+a+single+Loan+by+id%2C+with+its+collateral+buildings.+%60status%60+is+the+processing+status+of+the+loan%27s+documents%2C+not+whether+the+loan+is+active%2C+matured+o\u0026amp;theme=6175b23fcc3ea68b1ad8492b\u0026amp;signature=e77909426702ca5e51b2ed90d4558b09bd4b9f7fe712b5c6d278a56eaa3fb11d\">\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 Loan - Prophia Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single Loan by id, with its collateral buildings. status is the processing status of the loan\u0026#x27;s documents, not whether the loan is active, matured or paid off. Required capabilities: READ:LOAN\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://prophia.mintlify.site/_mintlify/api/og/v2?division=Loans\u0026amp;title=GET+Loan\u0026amp;description=Returns+a+single+Loan+by+id%2C+with+its+collateral+buildings.+%60status%60+is+the+processing+status+of+the+loan%27s+documents%2C+not+whether+the+loan+is+active%2C+matured+o\u0026amp;theme=6175b23fcc3ea68b1ad8492b\u0026amp;signature=e77909426702ca5e51b2ed90d4558b09bd4b9f7fe712b5c6d278a56eaa3fb11d\">\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/prophia/gMArIoMD4H40C8Fk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Prophia Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#017768\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.prophia.com/api-reference/v2/loans/get-loan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/loans/get-loan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.prophia.com/#organization\",\"name\":\"Prophia Docs\",\"url\":\"https://docs.prophia.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/prophia/D5w3N4ZrYouJq2j1/images/ProphiaBrand_Primary-Logo-ForDarkBG-TealAccent.png?fit=max\u0026auto=format\u0026n=D5w3N4ZrYouJq2j1\u0026q=85\u0026s=dc3bd897dc4e1f0320f0ee18d0bab7bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.prophia.com#website\",\"name\":\"Prophia Docs\",\"url\":\"https://docs.prophia.com\",\"publisher\":{\"@id\":\"https://docs.prophia.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan#webpage\",\"url\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan\",\"name\":\"GET Loan\",\"description\":\"Returns a single Loan by id, with its collateral buildings. status is the processing status of the loan's documents, not whether the loan is active, matured or paid off. Required capabilities: READ:LOAN\",\"dateModified\":\"2026-11-04T18:01:19.444Z\",\"isPartOf\":{\"@id\":\"https://docs.prophia.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Beta\",\"item\":\"https://docs.prophia.com/api-reference/v2/beta\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Loans\",\"item\":\"https://docs.prophia.com/api-reference/v2/loans/list-loan\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"GET Loan\",\"item\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan#apireference\",\"headline\":\"GET Loan\",\"name\":\"GET Loan\",\"description\":\"Returns a single Loan by id, with its collateral buildings. status is the processing status of the loan's documents, not whether the loan is active, matured or paid off. Required capabilities: READ:LOAN\",\"url\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.prophia.com/api-reference/v2/loans/get-loan#webpage\"},\"dateModified\":\"2026-11-04T18:01:19.444Z\",\"publisher\":{\"@id\":\"https://docs.prophia.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.prophia.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Prophia Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Prophia Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/loans/get-loan.md","siteName":"Prophia Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API Reference","versions":[{"version":"v2","default":true,"groups":[{"group":"Getting Started","pages":[{"title":"API Introduction","href":"/api-reference/v2/introduction"}]},{"group":"API Mechanisms","pages":[{"title":"Includes","href":"/api-reference/v2/concepts/includes"},{"title":"Pagination, sorting, and filtering","href":"/api-reference/v2/concepts/pagination-and-filtering"},{"title":"Errors and permissions","href":"/api-reference/v2/concepts/errors-and-permissions"}]},{"group":"Data Concepts","pages":[{"title":"Data model","href":"/api-reference/v2/concepts/data-model"},{"title":"Leases","href":"/api-reference/v2/concepts/leases"},{"title":"Documents","href":"/api-reference/v2/concepts/documents"},{"group":"Tags","pages":[{"title":"Tags and tag values","href":"/api-reference/v2/concepts/tags-and-values"},{"title":"Tag reference","href":"/api-reference/v2/concepts/tag-reference"}]},{"title":"Spaces, applicable spaces, and encumbrances","href":"/api-reference/v2/concepts/spaces-and-encumbrances"},{"title":"Understanding onboarding","href":"/api-reference/v2/concepts/onboarding"}]},{"group":"Endpoints","pages":[{"group":"Accounts","pages":[{"title":"LIST Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts","href":"/api-reference/v2/accounts/list-account"},{"title":"GET Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}","href":"/api-reference/v2/accounts/get-account"},{"title":"LIST Leases Recently Updated","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/recent_changed_leases","href":"/api-reference/v2/accounts/list-leases-recently-updated"}]},{"group":"Properties","pages":[{"title":"LIST Property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/properties","href":"/api-reference/v2/properties/list-property"},{"title":"GET Property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/properties/{propertyId}","href":"/api-reference/v2/properties/get-property"},{"title":"LIST Building","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/properties/{propertyId}/buildings","href":"/api-reference/v2/properties/list-building"},{"title":"LIST Lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/properties/{propertyId}/leases","href":"/api-reference/v2/properties/list-lease"},{"title":"CREATE Property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/properties","href":"/api-reference/v2/properties/create-property"},{"title":"UPDATE Property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/properties/{propertyId}","href":"/api-reference/v2/properties/update-property"}]},{"group":"Buildings","pages":[{"title":"LIST Building","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/buildings","href":"/api-reference/v2/buildings/list-building"},{"title":"GET Building","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/buildings/{buildingId}","href":"/api-reference/v2/buildings/get-building"},{"title":"LIST Lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/buildings/{buildingId}/leases","href":"/api-reference/v2/buildings/list-lease"},{"title":"CREATE Building","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/buildings","href":"/api-reference/v2/buildings/create-building"},{"title":"UPDATE Building","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/buildings/{buildingId}","href":"/api-reference/v2/buildings/update-building"}]},{"group":"Building Spaces","pages":[{"title":"LIST Building Space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/buildings/{buildingId}/spaces","href":"/api-reference/v2/building-spaces/list-building-space"},{"title":"GET Building Space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/buildings/{buildingId}/spaces/{spaceId}","href":"/api-reference/v2/building-spaces/get-building-space"},{"title":"CREATE Building Space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/buildings/{buildingId}/spaces","href":"/api-reference/v2/building-spaces/create-building-space"},{"title":"UPDATE Building Space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/buildings/{buildingId}/spaces/{spaceId}","href":"/api-reference/v2/building-spaces/update-building-space"},{"title":"Delete a building space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rest/v2/accounts/{accountId}/buildings/{buildingId}/spaces/{spaceId}","href":"/api-reference/v2/building-spaces/delete-a-building-space"}]},{"group":"Leases","pages":[{"title":"GET Lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/leases/{leaseId}","href":"/api-reference/v2/leases/get-lease"},{"title":"LIST Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/leases/{leaseId}/docs","href":"/api-reference/v2/leases/list-document"},{"title":"LIST Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/leases/{leaseId}/tags","href":"/api-reference/v2/leases/list-tag"},{"title":"LIST Raw Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/leases/{leaseId}/tags/raw","href":"/api-reference/v2/leases/list-raw-tag"},{"title":"CREATE Lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/leases","href":"/api-reference/v2/leases/create-lease"},{"title":"UPDATE Lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/leases/{leaseId}","href":"/api-reference/v2/leases/update-lease"}]},{"group":"Documents","pages":[{"title":"LIST Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/docs/{leaseDocId}/pages","href":"/api-reference/v2/documents/list-page"},{"title":"LIST Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/docs/{leaseDocId}/tags","href":"/api-reference/v2/documents/list-tag"},{"title":"LIST Raw Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/docs/{leaseDocId}/tags/raw","href":"/api-reference/v2/documents/list-raw-tag"},{"title":"CREATE Document via URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/docs","href":"/api-reference/v2/documents/create-document-via-url"},{"title":"CREATE Document via Upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/docs/upload","href":"/api-reference/v2/documents/create-document-via-upload"},{"title":"UPDATE Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/docs/{leaseDocId}","href":"/api-reference/v2/documents/update-document"}]},{"group":"Tags","pages":[{"title":"GET Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/tags/{tagId}","href":"/api-reference/v2/tags/get-tag"},{"title":"GET Raw Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/tags/{tagId}/raw","href":"/api-reference/v2/tags/get-raw-tag"}]},{"group":"Custom Terms","pages":[{"title":"LIST Custom Term Definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/custom-terms","href":"/api-reference/v2/custom-terms/list-custom-term-definition"},{"title":"GET Custom Term Definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/custom-terms/{customTermId}","href":"/api-reference/v2/custom-terms/get-custom-term-definition"},{"title":"CREATE Custom Term Definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/custom-terms","href":"/api-reference/v2/custom-terms/create-custom-term-definition"},{"title":"UPDATE Custom Term Definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/custom-terms/{customTermId}","href":"/api-reference/v2/custom-terms/update-custom-term-definition"},{"title":"DELETE Custom Term Definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rest/v2/accounts/{accountId}/custom-terms/{customTermId}","href":"/api-reference/v2/custom-terms/delete-custom-term-definition"}]},{"group":"Custom Fields","pages":[{"title":"LIST Custom Field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/custom-fields","href":"/api-reference/v2/custom-fields/list-custom-field"},{"title":"GET Custom Field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/custom-fields/{fieldId}","href":"/api-reference/v2/custom-fields/get-custom-field"},{"title":"LIST Custom Field Option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/options","href":"/api-reference/v2/custom-fields/list-custom-field-option"},{"title":"GET Custom Field Option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/options/{optionId}","href":"/api-reference/v2/custom-fields/get-custom-field-option"},{"title":"CREATE Custom Field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/custom-fields","href":"/api-reference/v2/custom-fields/create-custom-field"},{"title":"CREATE Custom Field Assignment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/assignments","href":"/api-reference/v2/custom-fields/create-custom-field-assignment"},{"title":"CREATE Custom Field Option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/options","href":"/api-reference/v2/custom-fields/create-custom-field-option"},{"title":"UPDATE Custom Field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/custom-fields/{fieldId}","href":"/api-reference/v2/custom-fields/update-custom-field"},{"title":"UPDATE Custom Field Option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/options/{optionId}","href":"/api-reference/v2/custom-fields/update-custom-field-option"},{"title":"DELETE Custom Field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rest/v2/accounts/{accountId}/custom-fields/{fieldId}","href":"/api-reference/v2/custom-fields/delete-custom-field"},{"title":"DELETE Custom Field Assignment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/assignments/{buildingId}","href":"/api-reference/v2/custom-fields/delete-custom-field-assignment"},{"title":"DELETE Custom Field Option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rest/v2/accounts/{accountId}/custom-fields/{fieldId}/options/{optionId}","href":"/api-reference/v2/custom-fields/delete-custom-field-option"}]}]},{"group":"Beta","pages":[{"title":"Beta endpoints","href":"/api-reference/v2/beta"},{"group":"Loans","pages":[{"title":"LIST Loan","description":"Returns a paged list of the Loans in the account that the caller can see, each with its collateral buildings. Narrow to the loans secured by a property's buildings or by one building.\n\n**Required capabilities:** `READ:LOAN`","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/loans","href":"/api-reference/v2/loans/list-loan"},{"title":"GET Loan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rest/v2/accounts/{accountId}/loans/{loanId}","href":"/api-reference/v2/loans/get-loan"}]}]}]},{"version":"v1 (deprecated)","pages":[{"title":"v1 (deprecated)","href":"/api-reference/v1/introduction"}]}]}]},"basePath":"","title":"GET Loan - Prophia Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}