Skip to main content
The POST /v1/incidents/submit endpoint lets you record a specific incident associated with a renter — such as a late payment, property damage event, or lease violation. Each incident is stored under your organization and can be referenced in a full rental history report submitted via POST /v1/reports.
All requests must include a valid API key in the Authorization header. See Authentication for details.

Endpoint

How incidents affect risk scores

Incidents submitted through this endpoint are discrete records stored in the RentFAX network. When you submit a rental history report via POST /v1/reports, you can include incident IDs in the incidents array field. The presence and type of linked incidents are considered as part of the overall renter risk profile.
Log incidents as they occur rather than in bulk at the end of a lease. Accurate timestamps and detailed descriptions give the risk model better signal and help resolve disputes faster.

Request body

renterId
string
required
The identifier for the renter this incident is associated with. This should match the renter’s record in your system or the RentFAX network.
industry
string
required
The industry vertical this incident belongs to (for example, "residential", "commercial", "equipment"). Must be consistent with the industryType used when filing reports for this renter.
type
string
required
A short category label for the incident. Examples: "late_payment", "property_damage", "lease_violation", "noise_complaint". This value is stored as-is; use a consistent taxonomy across your integration.
details
string
required
A plain-text description of the incident. Include relevant context such as the date it occurred, the severity, and any corrective action taken. This field is surfaced to reviewers and AI risk summaries.

Response

A successful request returns HTTP 200 with the following fields.
success
boolean
required
true when the incident was recorded successfully.
incidentId
string
required
The unique identifier for the created incident record. Store this value if you intend to reference the incident in a future POST /v1/reports request via the incidents array.

Examples

Example response

200

Error responses

400
401