GET /v1/renter/score — get composite risk score

The /v1/renter/score endpoint returns the full breakdown of a renter’s composite risk score. While /v1/renter/check gives you a pass/review/deny recommendation, this endpoint gives you the underlying math: four weighted components that add up to a score out of 1000, plus the financial data that feeds those calculations. Use it when you need to explain a decision to a renter, build a custom scoring UI, or audit how a score changed over time.

Endpoint

GET https://api.rentfax.io/v1/renter/score

Authentication

Include your API key in one of two ways:

x-api-key: <your-api-key>

Authorization: Bearer <your-api-key>

Query parameters

renter_id

string

required

The internal RentFAX renter ID. You can obtain this from the renterId field in a /v1/search response, or from your own renter records.

Score components

The composite score is a weighted average of four components:

Component	Weight	What it measures
`payment_history`	40%	Proportion of reports with no outstanding balance
`asset_condition`	30%	Proportion of reports with no damage findings
`identity_verified`	20%	Whether the renter has completed identity verification
`network_standing`	10%	Absence of outstanding unpaid balances across the network

Each component score is on a 0 – 1000 scale. The composite is computed as:

composite = (payment_history × 0.40) + (asset_condition × 0.30)
          + (identity_verified × 0.20) + (network_standing × 0.10)

Response fields

boolean

required

true when the request was processed successfully.

renter_id

string

required

The renter ID that was scored, echoed back for correlation.

composite_score

number

required

The weighted composite score, 0 – 1000.

score_max

number

required

Maximum possible score. Always 1000.

components

object

required

Individual score components with their weights and qualitative labels.

Show components properties

payment_history

object

Measures how consistently the renter has settled balances. Weighted at 40%.

Show payment_history properties

score

number

Component score, 0 – 1000.

weight

string

Always "40%".

label

string

Qualitative label: "Excellent", "Good", or "Poor".

asset_condition

object

Measures how often the renter returns assets without damage. Weighted at 30%.

Show asset_condition properties

score

number

Component score, 0 – 1000.

weight

string

Always "30%".

label

string

Qualitative label: "Excellent", "Good", or "Poor".

identity_verified

object

Reflects whether the renter has completed RentFAX identity verification. Weighted at 20%.

Show identity_verified properties

score

number

900 if the renter is verified, 600 if not.

weight

string

Always "20%".

label

string

"Verified" or "Unverified".

network_standing

object

Reflects the absence of outstanding balances across the network. Weighted at 10%.

Show network_standing properties

score

number

Component score, 0 – 1000. Decreases by 150 for each unpaid report, floored at 0.

weight

string

Always "10%".

label

string

"Good Standing" or "Has Outstanding Balances".

financials

object

required

Raw financial data from the renter’s report history.

Show financials properties

total_reports

number

Total number of reports considered in this score calculation (up to the 20 most recent).

paid_in_full

number

Number of reports where the renter owed no outstanding balance.

outstanding_balances

number

Number of reports where the renter still has an unpaid amount.

total_owed

number

Sum of all outstanding balances across all reports, in cents.

calculated_at

string

required

ISO 8601 timestamp of when this score was calculated.

Example

cURL

curl --request GET \
  --url "https://api.rentfax.io/v1/renter/score?renter_id=rtr_7f3a92c1d8e04b6f" \
  --header "x-api-key: rfx_live_your_api_key_here"

Response

{
  "ok": true,
  "renter_id": "rtr_7f3a92c1d8e04b6f",
  "composite_score": 847,
  "score_max": 1000,
  "components": {
    "payment_history": {
      "score": 909,
      "weight": "40%",
      "label": "Excellent"
    },
    "asset_condition": {
      "score": 833,
      "weight": "30%",
      "label": "Excellent"
    },
    "identity_verified": {
      "score": 900,
      "weight": "20%",
      "label": "Verified"
    },
    "network_standing": {
      "score": 700,
      "weight": "10%",
      "label": "Has Outstanding Balances"
    }
  },
  "financials": {
    "total_reports": 11,
    "paid_in_full": 10,
    "outstanding_balances": 1,
    "total_owed": 32500
  },
  "calculated_at": "2026-05-04T10:22:45.000Z"
}

Scores are calculated on demand from the renter’s most recent 20 reports. Call this endpoint again after new reports are filed to get an updated score.

Overview

Renters

Reports & Incidents

Webhooks

GET /v1/renter/score — get composite risk score

Endpoint

Authentication

Query parameters

Score components

Response fields

Example

Response

​Endpoint

​Authentication

​Query parameters

​Score components

​Response fields

​Example

​Response

Endpoint

Authentication

Query parameters

Score components

Response fields

Example

Response