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 Residents (deprecated) API

The Residents (deprecated) API from RentCheck — 3 operation(s) for residents (deprecated).

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

Tagged areas include Residents (deprecated). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 3 paths, and defines 4 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.

4 operations 3 paths 4 schemas 1 GET2 POST1 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 Residents (deprecated) 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 4

Across 3 paths, the API surfaces 4 operations — 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Residents (deprecated) 4
POST
/v1/residentsdeprecated
Create a resident (v1, deprecated)
body → 200400401404
GET
/v1/residents/{residentId}deprecated
Get a resident by ID (v1, deprecated)
1 param → 200401404
PUT
/v1/residents/{residentId}deprecated
Update a resident (v1, deprecated)
1 param body → 200400401404
POST
/v1/zapier/residents
Create a resident from a Zapier trigger
body → 200401404409

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are resident_response_model (19 properties), resident_create_request_model (11 properties), zapier_resident_create_request_model (10 properties), resident_update_request_model (4 properties). Each schema is shown below with its type and property counts.

resident_create_request_model
object
11 properties 4 required
resident_update_request_model
object
4 properties
zapier_resident_create_request_model
object
10 properties 5 required
resident_response_model
object
19 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-residents-deprecated-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