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 File Requests API

The File Requests API from RentCheck — 2 operation(s) for file requests.

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

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

This API exposes 3 operations across 2 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.

3 operations 2 paths 4 schemas 2 GET1 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 File Requests 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 3

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

File Requests 3
POST
/v1/fileRequests
Create a file request
1 param body → 201400401
GET
/v1/fileRequests
Get all file requests
5 params → 200400401
GET
/v1/fileRequests/{fileRequestId}
Get a file request by ID
1 param → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are file_request_v1_get_by_id_response_model (15 properties), api_file_request (9 properties), file_request_response_model (1 property). Each schema is shown below with its type and property counts.

file_request_v1_get_by_id_response_model
object
15 properties 9 required
api_file_request
object
9 properties 7 required
file_request_response_model
object
1 property 1 required
file_request_create_request_model
A file request is the API surface for asynchronous PDF/ZIP/CSV report generation. The required fields depend on documenttype: for per-record exports (INSPECTIO…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-file-requests-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 Filter Segments API
RentCheck Inspection Features API
RentCheck Inspections API
RentCheck Inspections Templates API
RentCheck Inspections V2 API
RentCheck Integrations API