Skip to main content
POST
/
lending
/
affordability
/
check
Check affordability
curl --request POST \
  --url https://api.txcloud.io/v1/lending/affordability/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicant_id": "<string>",
  "monthly_income": 123,
  "monthly_expenses": 123,
  "existing_debt_payments": 123,
  "proposed_loan": {
    "amount": 123,
    "term_months": 123,
    "rate": 123
  }
}
'
{
  "id": "<string>",
  "affordable": true,
  "monthly_payment": 123,
  "ratios": {},
  "stress_test": {},
  "recommendation": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
applicant_id
string
monthly_income
number
monthly_expenses
number
existing_debt_payments
number
proposed_loan
object

Response

200 - application/json

Affordability result

id
string
affordable
boolean
monthly_payment
number
ratios
object
stress_test
object
recommendation
string