Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RentCheck Leases API

The Leases API from RentCheck — 9 operation(s) for leases.

RentCheck Leases API is one of 31 APIs that RentCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Leases. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 14 operations across 9 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://prod-public-api.getrentcheck.com.

14 operations 9 paths 8 schemas 2 DELETE5 GET3 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://prod-public-api.getrentcheck.com
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

RentCheck Leases API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as x-app-id (x-app-id). An API key is passed in the header as x-app-secret (x-app-secret). By default, every request must be authenticated.

  • bearerAuth — Authorization key needed to use the API
  • x-app-id — Represents the identification of you application
  • x-app-secret — Represents the secret for your application

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 2 DELETE, 5 GET, 3 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Leases 14
POST
/v2/residents/{residentId}/leases
Create a lease for a resident
1 param body → 200400401404
GET
/v2/residents/{residentId}/leases
Get all leases for resident
1 param → 200401404
DELETE
/v2/residents/{residentId}/leases/{leaseId}
Delete lease
2 params → 204401404
GET
/v2/residents/{residentId}/leases/{leaseId}
Get a lease by ID for a resident
2 params → 200401404
PUT
/v2/residents/{residentId}/leases/{leaseId}
Update a lease for a resident
2 params body → 200400401404
PATCH
/v2/residents/{residentId}/leases/{leaseId}/move-in
Update a lease move in date and status
2 params → 200400401404
PATCH
/v2/residents/{residentId}/leases/{leaseId}/move-out
Update a lease move out date and status
2 params → 200400401404
GET
/v1/properties/{propertyId}/leases
List every lease on a property
1 param → 200401404
POST
/v1/properties/{propertyId}/resident-leases
Create a resident lease
1 param body → 200400401403404
DELETE
/v1/properties/{propertyId}/resident-leases/{residentLeaseId}
Delete a resident lease
2 params → 200400401403404
GET
/v1/properties/{propertyId}/resident-leases/{residentLeaseId}
Get a resident lease by id
2 params → 200401403404
PUT
/v1/properties/{propertyId}/resident-leases/{residentLeaseId}
Update a resident lease
2 params body → 200400401403404
GET
/v1/properties/resident-leases
Get all resident leases
7 params → 200400401403
PATCH
/v1/properties/{propertyId}/resident-leases/move-out
Move out the current resident from a property
1 param → 200401403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are lease_v2_response_model (11 properties), lease_v2_update_request_model (10 properties), api_tenant_occupancy (10 properties), lease_v2_create_request_model (10 properties). Each schema is shown below with its type and property counts.

api_tenant_occupancy
object
10 properties 6 required
tenant_occupancy_create_request_model
object
3 properties 1 required
tenant_occupancy_update_request_model
object
3 properties
rentvine_sync
object
Rentvine sync metadata.
8 properties 1 required
lease_v2_create_request_model
object
10 properties 1 required
lease_v2_update_request_model
object
10 properties
lease_v2_response_model
object
11 properties 5 required
resident_moved_out_response_model
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-leases-api-openapi.yml Raw ↑

Other APIs RentCheck publishes across the network.

RentCheck Account Settings API
RentCheck Automations API
RentCheck Buildings API
RentCheck Chargebee API
RentCheck Communities API
RentCheck Dashboard API
RentCheck File Requests API
RentCheck Filter Segments API
RentCheck Inspection Features API
RentCheck Inspections API
RentCheck Inspections Templates API
RentCheck Inspections V2 API