RentFAX REST API reference overview

The RentFAX API gives you programmatic access to the full RentFAX platform: renter lookups, risk scores, full reports, incident submission, search, and webhook management. All requests and responses use JSON, and every endpoint is versioned under /v1.

Base URL

https://api.rentfax.io/v1

All requests must be made over HTTPS. Every path in this reference is relative to this base URL.

Versioning

The current API version is v1. The version is part of the URL path, not a header. When breaking changes are introduced, a new version path will be announced with a deprecation timeline for the previous version.

Available endpoints

GET /v1/ping

Verify connectivity and confirm the API is operational.

GET /v1/renter/check

Look up a renter by email, phone, license, member ID, or name and get a risk recommendation.

GET /v1/renter/score

Retrieve the RentFAX risk score (100–1000) for a specific renter.

POST /v1/renter/report

File a rental history report with raw financial figures, incidents, and damage data.

POST /v1/reports

Submit a rental history report and get a computed risk score.

POST /v1/incidents/submit

Submit an incident record to the RentFAX network.

POST /v1/search

Search the renter network by name, email, phone, or member ID.

GET /v1/renters

List renters associated with your organization.

GET /v1/keys

List active API keys for your account.

POST /v1/keys

Create a new API key (maximum 5 active keys per account).

DELETE /v1/keys

Revoke an API key by ID.

GET /v1/webhooks

Manage webhook endpoints for real-time event delivery.

Response format

Every response is a JSON object. Successful responses include an ok: true field alongside the result data. Error responses include an error string describing what went wrong. Successful response:

{
  "ok": true,
  "found": true,
  "recommendation": "APPROVED",
  "risk_tier": "LOW",
  "score": 842,
  "score_max": 1000
}

Error response:

{
  "error": "Provide at least one identifier: email, phone, license, member_id, or name."
}

HTTP status codes

Status	Meaning
`200`	Request succeeded.
`400`	Bad request — a required parameter is missing or malformed.
`401`	Unauthorized — your API key is missing, invalid, or revoked.
`404`	Not found — the requested resource does not exist.
`429`	Rate limit exceeded.
`500`	Server error — something went wrong on the RentFAX side.

Quick example

The /v1/ping endpoint requires no parameters and confirms the API is reachable. Use it to verify your credentials and connectivity before making more complex calls.

curl https://api.rentfax.io/v1/ping \
  -H "x-api-key: rfx_live_your_key_here"

Response:

{
  "ok": true,
  "service": "RentFAX API",
  "version": "1.0",
  "status": "operational",
  "timestamp": "2026-05-04T12:00:00.000Z",
  "docs": "https://docs.rentfax.io/api"
}

Overview

Renters

Reports & Incidents

Webhooks

RentFAX REST API reference overview

Base URL

Versioning

Available endpoints

GET /v1/ping

GET /v1/renter/check

GET /v1/renter/score

POST /v1/renter/report

POST /v1/reports

POST /v1/incidents/submit

POST /v1/search

GET /v1/renters

GET /v1/keys

POST /v1/keys

DELETE /v1/keys

GET /v1/webhooks

Response format

HTTP status codes

Quick example

Next steps

Authentication

API keys

​Base URL

​Versioning

​Available endpoints

GET /v1/ping

GET /v1/renter/check

GET /v1/renter/score

POST /v1/renter/report

POST /v1/reports

POST /v1/incidents/submit

POST /v1/search

GET /v1/renters

GET /v1/keys

POST /v1/keys

DELETE /v1/keys

GET /v1/webhooks

​Response format

​HTTP status codes

​Quick example

​Next steps

Authentication

API keys

Base URL

Versioning

Available endpoints

Response format

HTTP status codes

Quick example

Next steps