Sign in

v1

latestOpenAPI 3.1.02026-08-04123846.7 KB
Valuation

Compare a property's AVM value against a provided LTV amount.

post/valuation/ltv-check

Request body

pidstring required

Property identifier in format xxx-xxx-xxx

ltv_amountnumber required

Loan-to-value amount to compare against the property's AVM value.

Example request

{
  "pid": "xxx-xxx-xxx",
  "ltv_amount": 500000
}

Response

Successful Response

pidstring required

Property identifier in format xxx-xxx-xxx

ltv_amountnumber required

Loan-to-value amount supplied in the request.

has_avmboolean required

Indicates whether the property has an AVM value on record.

avm_exceeds_ltvboolean required

True when the property's AVM value is greater than the provided LTV amount.

Example response

{
  "pid": "xxx-xxx-xxx"
}