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 oAuth2 API

The oAuth2 API from RentCheck — 8 operation(s) for oauth2.

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

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

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

8 operations 8 paths 7 schemas 1 GET7 POST

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 oAuth2 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 8

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

oAuth2 8
POST
/v1/oAuth2/access
Grant OAuth2 access and redirect back to the integration
body → 302
GET
/v1/oAuth2/authentication
Render the RentCheck OAuth2 login form
3 params → 200400401
POST
/v1/oAuth2/emailPasswordAuth
Creates an access/refresh token pair
body → 200400401
POST
/v1/oAuth2/me
Identify the caller by their OAuth2 access token
→ 200401
POST
/v1/oAuth2/refreshToken
Refresh tokens
body → 200401
POST
/v1/oAuth2/token
Exchange an OAuth2 authorization code for access + refresh tokens
body → 200401
POST
/v1/oAuth2/validateOrg
Confirm the organisation the OAuth2 code should be scoped to
body → 200409
POST
/v1/oAuth2/validateUser
Validate user credentials during the OAuth2 login form submit
body → 200409

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are oauth2_me_response_model (5 properties), oauth2_token_request_model (3 properties), oauth2_token_response_model (3 properties), oauth2_refresh_token_response_model (2 properties). Each schema is shown below with its type and property counts.

oauth2_token_response_model
object
Successful token-exchange response for POST /v1/oAuth2/token.
3 properties 3 required
oauth2_email_password_auth_response_model
object
2 properties 2 required
oauth2_token_request_model
object
Body for POST /v1/oAuth2/token. Used to complete the RentCheck OAuth2 authorization-code exchange (primary consumer is the Zapier integration).
3 properties 3 required
oauth2_me_response_model
object
Response body for POST /v1/oAuth2/me. Returns a synthetic identity payload the OAuth2 client can display back to the user.
5 properties 5 required
oauth2_email_password_auth_request_model
Credentials for POST /v1/oAuth2/emailPasswordAuth. Either the account password OR the integration password (never both) must accompany the email.
oauth2_refresh_token_response_model
object
2 properties 2 required
oauth2_refresh_token_request_model
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-oauth2-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