Skip to main content
API keys let you authenticate requests to the RentFAX REST API from your own code or third-party tools. Any time your software needs to look up a renter, submit a report, or pull risk data programmatically, it sends your API key with each request so RentFAX can verify who is calling. API access is available on the Enterprise plan; contact sales if you need to enable it on your account.

​
Generate an API key

1

Open API Keys settings

In the RentFAX dashboard, click your account name in the top navigation and select Settings. Then click API Keys in the settings sidebar.
2

Name your key

In the Generate New API Key panel, enter a descriptive name — for example, Production or Zapier Integration. A clear name makes it easier to identify and revoke keys later.
3

Click Generate Key

Click Generate Key. The full key value is displayed once in a confirmation banner at the top of the page.
4

Copy and save the key immediately

Copy the key and store it in a secure location such as a password manager or a .env file. Once you dismiss the banner, the full key is never shown again — only a masked preview.
Your API key is shown only once at creation. If you close or dismiss the confirmation banner without copying the key, you cannot retrieve it. Revoke the key and generate a new one if you lose it.
Each account can have a maximum of 5 active API keys at one time. Revoke keys you are no longer using to stay within this limit.

​
Authenticate your requests

Include your API key in the header of every request you make to the RentFAX API. You can use either of two header formats — both are accepted.
Most HTTP clients and API platforms (Postman, Insomnia, Zapier) have a dedicated field for Bearer tokens. Use the Authorization: Bearer format in those tools.

​
Example requests

The examples below show common API calls with a key passed as the Authorization header. Replace rfx_live_•••••••••••• with your actual key.

​
Search for a renter

​
Get a renter’s risk score

​
Submit a report

​
View your active keys

In Settings → API Keys, the keys table shows all active keys for your account. For each key you can see:
  • The key name you assigned
  • A masked preview of the first characters (e.g., rfx_live_abc1••••••••)
  • The total number of API requests made with that key
  • The date the key was last used
The full key value is never shown after creation.

​
Revoke a key

Revoke a key when you no longer need it, suspect it has been compromised, or want to rotate credentials.
1

Open API Keys settings

Go to Settings → API Keys in the RentFAX dashboard.
2

Find the key to revoke

Locate the key by name or masked preview in the keys table.
3

Click Revoke

Click the Revoke button next to the key. You will be asked to confirm. Once revoked, all requests using that key will immediately return an authentication error.
Revoking a key is permanent. Any integration or service currently using the key will stop working. Make sure you have updated all systems with a new key before revoking the old one.