V1 Calculate Loan

Preview calculations for a loan. This API calculates fields similar to the calculations performed in Update Loan, however, the transient calculations provide a preview and do not save to the loan file.

Body Params

The following attributes are contained within the loanCalculationRequestBody object.

string

The unique identifier of the loan.

loanData
object

Provides the loan contract from which to calculate data.

entities
array of objects

List of loan entities. Refer to V1 Get Supported Entities to view the list of loan entities that can be retrieved from a loan.

entities
boolean
Defaults to true

Indicates whether calculations will be executed for all fields. The default is true.

Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json