Skip to main content
GET
GET Loan

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.

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"].

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.

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.

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.