{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d30a60d5-d95a-46d8-a496-e5b571e70c75","name":"RenterFile API v1","description":"The RenterFile API allows you to request landlord references also known as verification of rent (VOR) inside your software.\n\n# About RenterFile:\n\nOur landlord reference check automation software contacts your applicant's landlords asking them to provide a rental verification online. Our system also follows up with the landlords four times per day via email and text messages until they respond. This results in 80.4% of landlords responding to our verification of rent requests. Those who respond, do it extremely fast (on average in 16 hours or less)\n\n# About RenterFile API:\n\nThe RenterFile API enables PropTech software to add landlord reference checks to their existing tenant screening offering without their clients even needing to leave their software. You can request landlord reference from RenterFile and our team will reach out to landlords and get them to respond with a landlord reference about their tenant. Once we have a landlord reference report for you, you will be able to show that report inside your software or make dicissions based on this report. For example, if landlord reference report show that the landlord filed a eviction notice, you could automatically deny the applicant. (This is not legal advice)\n\nLearn more about the [benefits of the RenterFile API](https://docs.google.com/presentation/d/1JfXud88j3TYkxPvk5KfrDeG2GKp7xoEhLqpkxTq48No/edit?usp=sharing)\n\n## Authorization:\n\nWe use OAuth (Open Authorization) to authorize access to your API. OAuth is an open standard protocol that enables secure authorization for third-party applications to access user resources on an API. It allows users to grant permission to external applications without sharing their credentials (such as username and password) with those applications.\n\n# How it works\n\n1.  Request a landlord reference\n    1.  Prepare Request\n        1.  Generate an access token  \n            To obtain an access token for API authentication, you need to follow these steps:\n            1.  Register your application with the Renterfile to obtain a client ID and client secret.\n            2.  Call the authorization endpoint, including the necessary parameters such as client ID, scope, username and password.\n            3.  The API service responds with an access token, which your application should store securely for future API requests.\n            4.  It also return a refresh token which then can be used to generate a new access token when it expires.\n            5.  To make API requests using the OAuth-based API, you need to include the access token in the request header.\n        2.  **Upload Consent File** to be included in request\n    2.  Request Landlord Reference\n        1.  Provide the Landlord's contact info\n        2.  Provide the Tenant(s) info\n        3.  Provide a webhook url if you'd like to be notified of updates of the request\n        4.  Choose if you would like RenterFile to check if the landlord is legitimate or not\n    3.  When Request Submitted Successfully, you get an request id, you will need the request id to request a landlord reference status or landlord reference report\n2.  RenterFile will do their magic\n    1.  Contact the landlord and ask them to provide a landlord reference\n    2.  Send request reminder emails, text messages as well as phone calls.\n    3.  Landlord will provide a landlord reference on RenterFile system\n    4.  If you choose to validate the landlord, RenterFile will also validate if the landlord is legitimate landlord or not. (currently in closed beta)\n    5.  If you provided the webhook details, RenterFile will send updates to your webhook any time there is any updates to the request.\n    6.  You will be able to check the status of the request by using **Request Status** method\n3.  Landlord Reference Report is ready\n    1.  If you provided the webhook details, you will be notified via webhook when the report is ready.\n    2.  You can request Landlord Reference Report to see the completed report and display it in your software.\n\nEnvironments:\n\nRenterFile provides two environments: Staging and Production. The staging uses the following url:\n\n```\nhttps://landlordreferencecheck.com\n\n```\n\nUse the staging environment for development, as no charges will occur. reach out to [support@renterinc.com](mailto:support@renterinc.com) and you will be provided a staging login.\n\nThe production environment is where all live production traffic should take place. Once you're ready to gain production access, reach out to our team and we will set you up for production access. Our production environment uses the following url\n\n```\nhttps://renterfile.com\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23496276","team":2676017,"collectionId":"d30a60d5-d95a-46d8-a496-e5b571e70c75","publishedId":"2s9YJXYjd9","public":true,"publicUrl":"https://documenter-api.postman.tech/view/23496276/2s9YJXYjd9","privateUrl":"https://go.postman.co/documentation/23496276-d30a60d5-d95a-46d8-a496-e5b571e70c75","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8fba4d"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"The RenterFile API enables PropTech software to add landlord reference checks to their existing tenant screening offering without their clients even needing to leave their software. Your client can request landlord reference inside your software, we get the reports for you, you show the reports inside your software. "},{"name":"title","value":"RenterFile API Docs - Request Landlord References via API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"8fba4d"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8fba4d"}}]}},"version":"8.10.1","publishDate":"2023-09-26T03:02:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"RenterFile API Docs - Request Landlord References via API","description":"The RenterFile API enables PropTech software to add landlord reference checks to their existing tenant screening offering without their clients even needing to leave their software. Your client can request landlord reference inside your software, we get the reports for you, you show the reports inside your software. "},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"RenterFile API v1 - Staging","id":"e5faf7c4-52cd-4a6c-b598-dabf069b02fa","owner":"23496276","values":[{"key":"API_URL","value":"https://dev.renterfile.com","enabled":true,"type":"default"},{"key":"ACCESS_TOKEN","value":"","enabled":false,"type":"default"},{"key":"REFRESH_TOKEN","value":"","enabled":false,"type":"default"},{"key":"client_id","value":"","enabled":false,"type":"secret"},{"key":"client_secret_key","value":"","enabled":false,"type":"secret"},{"key":"Username","value":"","enabled":false,"type":"secret"},{"key":"Password","value":"","enabled":false,"type":"secret"},{"key":"requestid","value":"4642","enabled":false},{"key":"consent_fileid","value":"2132","enabled":false,"type":"default"},{"key":"API_KEY","value":"24652e9ecb425599bd3ffacf9c19a8e7","enabled":true,"type":"secret","description":{"content":"","type":"text/plain"}},{"key":"FILE_ID","value":"","enabled":true,"type":"any"},{"key":"REQUEST_ID","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/218b0db4a88f880cfd1219738199948020ca238b99e9a0e4d2274878b00b36ba","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"RenterFile API v1 - Staging","value":"23496276-e5faf7c4-52cd-4a6c-b598-dabf069b02fa"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9YJXYjd9"}