API reference · Communities & institutions

Rentals financing

GET/rental/tenancy/{reference}/financing-eligibilityCould this tenancy be financed or guaranteed

GET Could this tenancy be financed or guaranteed

GET /rental/tenancy/{reference}/financing-eligibility

The occupant's own view, computed only from payments the platform observed. No product is offered from it until a market has been cleared to lend; the reasons say what is missing.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseFinancingEligibilityResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/financing-eligibility" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "observedHistoryMonths": 0,
    "onTimeRate": 0,
    "onTimeObservations": 0,
    "arrearsDaysMax": 0,
    "rentFinancingEligible": true,
    "landlordGuaranteeEligible": true,
    "reasons": [
      "string"
    ]
  },
  "description": "Eligibility retrieved successfully"
}

Responses

Status	When
`200`	Eligibility retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors