> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rentfax.io/llms.txt
> Use this file to discover all available pages before exploring further.

# RentFAX REST API reference overview

> Complete reference for the RentFAX REST API — base URL, versioning, all available endpoints, JSON response format, and HTTP error codes.

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

<CardGroup cols={2}>
  <Card title="GET /v1/ping" icon="activity" href="/api-reference/introduction#ping">
    Verify connectivity and confirm the API is operational.
  </Card>

  <Card title="GET /v1/renter/check" icon="user-search" href="/api-reference/renters/check">
    Look up a renter by email, phone, license, member ID, or name and get a risk recommendation.
  </Card>

  <Card title="GET /v1/renter/score" icon="bar-chart-2" href="/api-reference/renters/score">
    Retrieve the RentFAX risk score (100–1000) for a specific renter.
  </Card>

  <Card title="POST /v1/renter/report" icon="file-text" href="/api-reference/renter/report">
    File a rental history report with raw financial figures, incidents, and damage data.
  </Card>

  <Card title="POST /v1/reports" icon="clipboard-list" href="/api-reference/reports/submit">
    Submit a rental history report and get a computed risk score.
  </Card>

  <Card title="POST /v1/incidents/submit" icon="alert-triangle" href="/api-reference/incidents/submit">
    Submit an incident record to the RentFAX network.
  </Card>

  <Card title="POST /v1/search" icon="search" href="/api-reference/renters/search">
    Search the renter network by name, email, phone, or member ID.
  </Card>

  <Card title="GET /v1/renters" icon="users" href="/api-reference/renters/list">
    List renters associated with your organization.
  </Card>

  <Card title="GET /v1/keys" icon="key" href="/billing/api-keys">
    List active API keys for your account.
  </Card>

  <Card title="POST /v1/keys" icon="key" href="/billing/api-keys">
    Create a new API key (maximum 5 active keys per account).
  </Card>

  <Card title="DELETE /v1/keys" icon="key" href="/billing/api-keys">
    Revoke an API key by ID.
  </Card>

  <Card title="GET /v1/webhooks" icon="webhook" href="/api-reference/webhooks/events">
    Manage webhook endpoints for real-time event delivery.
  </Card>
</CardGroup>

## 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:**

```json theme={null}
{
  "ok": true,
  "found": true,
  "recommendation": "APPROVED",
  "risk_tier": "LOW",
  "score": 842,
  "score_max": 1000
}
```

**Error response:**

```json theme={null}
{
  "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.

```bash theme={null}
curl https://api.rentfax.io/v1/ping \
  -H "x-api-key: rfx_live_your_key_here"
```

**Response:**

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

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/api-reference/authentication">
    Learn how to pass your API key and handle 401 errors.
  </Card>

  <Card title="API keys" icon="key" href="/billing/api-keys">
    Generate, view, and revoke API keys from your dashboard.
  </Card>
</CardGroup>