{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-v1.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"v1.yaml","settings":{"baseUrlPath":"/v1"},"disableAutoScroll":true,"seo":{"title":"Checkr Tenant API"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"Checkr Tenant API","version":"1.0","description":"The Checkr Tenant API lets property managers and landlords order tenant\nscreenings, manage rental properties, and retrieve screening reports\nprogrammatically. It is organized around four core resources:\n\n- **Properties** — rental addresses you screen applicants for.\n- **Applicants** — people being screened.\n- **Orders** — a screening request placed for an applicant against a property.\n- **Reports** — the results returned by an order, broken down by check type.\n\nReports are produced asynchronously. You can either listen for `report.*`\n[webhooks](webhooks.md) or poll `GET /orders/{id}/report`. All resources are\nisolated per environment via test and live API keys — see the\n[Testing guide](testing.md) for how mode isolation works and which scenarios\nare available against test keys.\n\nNew to the API? Start with the [Getting Started guide](index.md) for the\nend-to-end walkthrough, including authorization, billing setup, and your first\norder.\n","summary":"The Tenant Monolith API is a RESTful service that powers tenant screening\nworkflows at Checkr. It uses resource-oriented URLs, supports HTTPS for\nauthentication and requests, and returns JSON responses.\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"checkr-tenant-api-docs.redocly.app","port":4000,"ipAddress":"216.73.216.196"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}