The RenterFile API allows you to request landlord reference checks inside your software.
\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 so extremely fast (on average in 16 hours or less).
\nThe RenterFile API enables PropTech software to add landlord reference checks to their existing tenant screening offering without their clients even needing to leave your software. You can request a 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.
\nAll endpoints in this collection use API Key authentication. Send your API key on every request using the api-key header:
api-key: YOUR_API_KEY\n\nConfigure these Postman environment variables before sending requests:
\nAppend ?_format=json to all request URLs.
Upload Consent File — upload the applicant's signed consent document. Save the returned fid as FILE_ID.
Request Landlord Reference — submit the verification request. Save the returned requestId as REQUEST_ID.
Request Status or Request Progress Report — poll for updates, or use the webhook (PostbackUri) if configured.
Modify Request (optional) — correct details while requestStatus is pending_landlord_response.
Cancel Request (optional) — cancel while requestStatus is pending_landlord_response or landlord_legitimacy_check.
Get Reference Report — retrieve the full report when requestStatus is a completed variant.
Poll Request Status by ID to track progress. Webhook payloads (PostbackUri) include the requestStatus machine name.
When you create a landlord reference request with PostbackUri, RenterFile sends HTTP POST callbacks to that URL as the request progresses.
Configure the webhook when calling Request a new landlord reference:
\nIf PostbackUri is omitted, no webhooks are sent for that request.
Webhooks fire only when PostbackUri is set on the request. Delivery is best-effort (synchronous at the time of the triggering action); there is no automatic retry queue exposed via the API. Prefer idempotent handlers and still poll Request status by ID as a fallback.
Every payload includes:
\nstatus_updateSent whenever the request status changes (for example from pending_landlord_response to landlord_legitimacy_check, or to a completed/canceled/expired state).
{\n \"type\": \"status_update\",\n \"status\": \"completed_verified_landlord\",\n \"requestId\": \"5460\",\n \"time\": 1720886400\n}\n\nStatus values:
\nOn status_update for a completed status, fetch the full report via Get Reference Report.
staff_noteSent when staff records an action on the request (phone call, SMS, email, response, or other).
\nEach note object:
\n{\n \"type\": \"staff_note\",\n \"notes\": [\n {\n \"title\": \"Staff made a phone call to 6285553901\",\n \"items\": [\n \"Phone call outcome: Left voicemail\",\n \"Phone call notes: Called property manager, no answer\"\n ]\n },\n {\n \"title\": \"Staff sent an email regarding this request\",\n \"items\": [\n \"Email ID: manager@example.com\",\n \"Email notes: Followed up with lease documentation request\"\n ]\n }\n ],\n \"requestId\": \"5460\",\n \"time\": 1720886400\n}\n\nPossible title prefixes:
Staff made a phone call to …
Staff made an SMS to …
Staff sent an email regarding this request
Staff responsed to a phone/sms regarding this request
Staff took other action regarding this request
A single webhook may include multiple note objects when several action types were logged in one staff note.
\nlandlord_validation_commentSent when staff adds a comment on the landlord validation / legitimacy check for this request.
\n{\n \"type\": \"landlord_validation_comment\",\n \"comment\": \"Deed search matches the listed property manager.\",\n \"requestId\": \"5460\",\n \"time\": 1720886400\n}\n\nRespond quickly with 2xx; do heavy work asynchronously.
Branch on type.
For status_update, treat status the same as requestStatus from the REST API.
Do not rely on webhooks alone — poll Request status by ID if a callback is missed.
\nContent-Disposition\" header is required. A file name in the format \"filename=FILENAME\" must be provided. Make sure the extension here matches the actual file extension.
\n","type":"text"},{"key":"Content-Type","value":"application/octet-stream","description":"The Content-Type header specifies the media type of the resource. For file uploads, it helps the server understand the type of file being uploaded. The application/octet-stream MIME type is used for binary data, indicating that the file content is in a generic binary format.
\n","type":"text"}],"body":{"mode":"file","file":{"src":"{{CONSENT_FILE_PATH}}"}},"url":"{{API_URL}}/api/v1/consent/file/upload?_format=json","description":"Provide a signed consent file that states that this applicant consented to landlord reference check (applicant gives the landlord a permission to reach out to all current/past landlords, and applicant give permission to the current/past landlords to provide a landlord reference about them)
\nAllowed file types: txt, png, pdf, jpeg, jpg
\n","urlObject":{"path":["api","v1","consent","file","upload"],"host":["{{API_URL}}"],"query":[{"description":{"content":"Request format
\n","type":"text/plain"},"key":"_format","value":"json"}],"variable":[]}},"response":[{"id":"5a4e86b2-c89f-4a9e-9bbd-fac7b11c9394","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Disposition","value":"file; filename=\"test.jpg\"","description":"Provide a signed consent file that states that this applicant consented to landlord reference check (applicant gives the landlord a permission to reach out to all current/past landlords, and applicant give permission to the current/past landlords to provide a landlord reference about them)\n","type":"text"},{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"{{API_URL}}/api/v1/consent/file/upload?_format=json","host":["{{API_URL}}"],"path":["api","v1","consent","file","upload"],"query":[{"key":"_format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 09:24:29 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"fid\": \"3114\"\n}"},{"id":"0033db41-c77a-4643-a0ac-faa3461926d0","name":"Bad Request with Content-Disposition header","originalRequest":{"method":"POST","header":[{"key":"Content-Disposition","value":"file; filename=\"test.jpg\"","description":"Content-Disposition\" header is required. A file name in the format \"filename=FILENAME\" must be provided","type":"text","disabled":true},{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"{{API_URL}}/api/v1/consent/file/upload?_format=json","host":["{{API_URL}}"],"path":["api","v1","consent","file","upload"],"query":[{"key":"_format","value":"json","description":"Request format"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 09:31:19 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\\\"Content-Disposition\\\" header is required. A file name in the format \\\"filename=FILENAME\\\" must be provided\"\n}"},{"id":"f7908fd5-880e-4052-8f6d-d68676d08aeb","name":"Invalid Content-Type header","originalRequest":{"method":"POST","header":[{"key":"Content-Disposition","value":"file; filename=\"test.jpg\"","description":"Content-Disposition\" header is required. A file name in the format \"filename=FILENAME\" must be provided","type":"text"},{"key":"Content-Type","value":"application/octet-stream","description":"The Content-Type header specifies the media type of the resource. For file uploads, it helps the server understand the type of file being uploaded. The application/octet-stream MIME type is used for binary data, indicating that the file content is in a generic binary format.","type":"text","disabled":true}],"body":{"mode":"file","file":{}},"url":{"raw":"{{API_URL}}/api/v1/consent/file/upload?_format=json","host":["{{API_URL}}"],"path":["api","v1","consent","file","upload"],"query":[{"key":"_format","value":"json","description":"Request format"}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 09:32:10 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No route found that matches \\\"Content-Type: image/png\\\"\"\n}"},{"id":"a210f37e-935b-4992-8c5f-eeee5bd10c79","name":"Not allowed file type","originalRequest":{"method":"POST","header":[{"key":"Content-Disposition","value":"file; filename=\"test.docx\"","description":"Content-Disposition\" header is required. A file name in the format \"filename=FILENAME\" must be provided. Make sure the extension here matches the actual file extension.","type":"text"},{"key":"Content-Type","value":"application/octet-stream","description":"The Content-Type header specifies the media type of the resource. For file uploads, it helps the server understand the type of file being uploaded. The application/octet-stream MIME type is used for binary data, indicating that the file content is in a generic binary format.","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"{{API_URL}}/api/v1/consent/file/upload?_format=json","host":["{{API_URL}}"],"path":["api","v1","consent","file","upload"],"query":[{"key":"_format","value":"json","description":"Request format"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 10:20:01 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unprocessable Entity: file validation failed.\\nOnly files with the following extensions are allowed: txt png pdf jpeg jpg.\"\n}"}],"_postman_id":"5875257a-8c6c-437a-a0f8-8f6aea76ed72"},{"name":"Request a new landlord reference","event":[{"listen":"test","script":{"id":"782d0047-c1da-4e82-b63a-70c3ea2dc93a","exec":["var requestId = pm.response.json().requestId;","pm.environment.set(\"REQUEST_ID\", requestId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"45affca6-a826-49e2-84f4-9322f6e25ff1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"residents\": [\n {\n \"ResidentFirstName\": \"Ava\",\n \"ResidentMiddleName\": \"\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentDateOfBirth\": \"1993-02-11\",\n \"ResidentPhoneNumber\": \"4155552109\",\n \"ResidentSsnLastFour\": \"3412\",\n \"ResidentEmail\": \"akshitggrwl+resident1@gmail.com\",\n \"ResidentSignedConsentFid\": {{FILE_ID}}\n }\n ],\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"address_line2\": \"Apt 14D\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"akshitggrwl+landlord3@gmail.com\",\n \"LandlordCompanyName\": \"Bayview Property Management\",\n \"LandlordPhoneNumber\": \"6285553901\",\n \"LandlordExtensionNumber\": \"105\",\n\n \"Requester\": {\n \"RequesterFirstName\": \"Lucas\",\n \"RequesterLastName\": \"Perez\",\n \"RequesterEmail\": \"akshitggrwl+requester3@gmail.com\",\n \"RequesterCompanyName\": \"UrbanNest Apartments\",\n \"RequesterPhoneNumber\": \"4155559982\",\n \"RequesterExtensionNumber\": \"105\",\n \"RequesterCompanyLogoUrl\": \"https://example.com/logos/urbannest.png\"\n },\n\n \"PostbackUri\": \"https://webhook.site/ab42e39a-8b92-4b51-9d3a-2d8b91e4c777\",\n \"PostbackUsername\": \"\",\n \"PostbackPassword\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/api/v1/request-landlord-reference?_format=json","description":"Submit a new landlord reference verification request.
\nBefore calling this endpoint:
\nUpload a consent file via Consent File Upload and note the returned fid.
Ensure your RenterFile account has a valid payment method on file (required for production accounts).
\nOn success, save the returned requestId as REQUEST_ID for subsequent calls.
201){\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\"\n}\n\nYou can include one or more residents. Add each resident as an object in the residents array.
Contact information for the landlord being asked to provide a reference.
\nLandlordPhoneNumber is checked against Melissa Global Phone. If the number is not reachable, the API returns HTTP 422:
{\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"LandlordPhoneNumber\": \"is not reachable, please provide a correct phone number and re-submit this request. If you verified the number is correct, set LandlordPhoneNumberConfirmed to true and re-submit.\"\n }\n}\nRe-submit with \"LandlordPhoneNumberConfirmed\": true to bypass the check (same as the “This phone number is correct” option on the RenterFile website). Checks are skipped when Settings::local is enabled on the server.
The requestor information defaults to the authenticated requestor user's details. If you need to use different values, specify them in the requestor object to override the defaults.
If provided, RenterFile sends status updates to your endpoint whenever the request changes.
\nRetrieve the current status of a landlord reference request.
\nPoll this endpoint after creating a request, or when you receive a webhook notification, to determine whether the report is ready.
\n200){\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\"\n}\nRequest format
\n","type":"text/plain"},"key":"_format","value":"json"},{"description":{"content":"ID of the request to get the status for. It is an integer type
\n","type":"text/plain"},"key":"id","value":"{{REQUEST_ID}}"}],"variable":[]}},"response":[{"id":"c2ed412a-e07f-4eeb-9c71-2e2044866d1d","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/api/v1/request-status?_format=json&id=5456","host":["{{API_URL}}"],"path":["api","v1","request-status"],"query":[{"key":"_format","value":"json","description":"Request format"},{"key":"id","value":"5456","description":"ID of the request to get the status for. It is an integer type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 09:21:38 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-Drupal-Dynamic-Cache","value":"MISS"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Drupal-Cache-Tags","value":"config:rest.resource.request_status_by_id http_response"},{"key":"X-Drupal-Cache-Contexts","value":"user.permissions"},{"key":"X-Drupal-Cache-Max-Age","value":"-1 (Permanent)"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"5456\",\n \"requestStatus\": \"completed_verified_landlord\"\n}"},{"id":"e1e5dc36-0551-4fa4-98af-e758e21190ef","name":"Request Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/api/v1/request-status?_format=json&id=5457","host":["{{API_URL}}"],"path":["api","v1","request-status"],"query":[{"key":"_format","value":"json","description":"Request format"},{"key":"id","value":"5457","description":"ID of the request to get the status for. It is an integer type"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 09:22:26 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No request found!\"\n}"},{"id":"a7c381f2-b770-4aeb-b3cc-cfbb59165d2e","name":"Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/api/v1/request-status?_format=json","host":["{{API_URL}}"],"path":["api","v1","request-status"],"query":[{"key":"_format","value":"json","description":"Request format"},{"key":"id","value":"5457","description":"ID of the request to get the status for. It is an integer type","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 Aug 2024 09:22:55 GMT"},{"key":"Server","value":"Apache/2.4.59 (Unix) PHP/8.2.20"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Cache-Control","value":"must-revalidate, no-cache, private"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Content-language","value":"en"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Expires","value":"Sun, 19 Nov 1978 05:00:00 GMT"},{"key":"X-Generator","value":"Drupal 9 (https://www.drupal.org)"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request id is required!\"\n}"}],"_postman_id":"44d612d6-2674-486e-aff3-ccca2b20c7e1"},{"name":"Request Progress Report","id":"d9bc1631-b00f-4334-a41f-5da6e2cdc353","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/api/v1/request-progress-report?_format=json&id={{REQUEST_ID}}","description":"Retrieve a chronological activity log for a landlord reference request.
\nUse this endpoint to show your users what RenterFile has done on their behalf — for example, when the landlord was contacted, reminders sent, or the request was canceled.
\nThe response also includes a request object with the current request details (property address, landlord contacts, residents, requester). This reflects the latest data on file, including changes made by RenterFile staff or via Modify Request.
200){\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\",\n \"request\": {\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ],\n \"Requester\": {\n \"RequesterFirstName\": \"Lucas\",\n \"RequesterLastName\": \"Perez\",\n \"RequesterEmail\": \"requester@example.com\"\n }\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n },\n {\n \"time\": 1722953100,\n \"comment\": \"Landlord contacted via email\"\n }\n ]\n}\nEach progress entry contains:
Format time on the client for display (e.g. 2024-08-06 13:22:13 in your local timezone).
Response format
\n","type":"text/plain"},"key":"_format","value":"json"},{"description":{"content":"Request ID returned from Request Landlord Reference
\n","type":"text/plain"},"key":"id","value":"{{REQUEST_ID}}"}],"variable":[]}},"response":[{"id":"b1feafdd-1c94-4b62-869c-4b978c8d5020","name":"Success","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"GET","header":[],"url":{"raw":"{{API_URL}}/api/v1/request-progress-report?_format=json&id={{REQUEST_ID}}","host":["{{API_URL}}"],"path":["api","v1","request-progress-report"],"query":[{"description":"Response format","key":"_format","value":"json"},{"description":"Request ID returned from Request Landlord Reference","key":"id","value":"{{REQUEST_ID}}"}]},"description":"Retrieve a chronological activity log for a landlord reference request.\n\nUse this endpoint to show your users what RenterFile has done on their behalf — for example, when the landlord was contacted, reminders sent, or the request was canceled.\n\nThe response also includes a `request` object with the **current** request details (property address, landlord contacts, residents, requester). This reflects the latest data on file, including changes made by RenterFile staff or via **Modify Request**.\n\n## Query parameters\n\n| Parameter | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n| `_format` | Response format | Yes | String (`json`) |\n\n## Success response (`200`)\n\n```json\n{\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\",\n \"request\": {\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ],\n \"Requester\": {\n \"RequesterFirstName\": \"Lucas\",\n \"RequesterLastName\": \"Perez\",\n \"RequesterEmail\": \"requester@example.com\"\n }\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n },\n {\n \"time\": 1722953100,\n \"comment\": \"Landlord contacted via email\"\n }\n ]\n}\n```\n\nEach `progress` entry contains:\n\n| Field | Description |\n| --- | --- |\n| `time` | Unix timestamp (seconds since epoch) when the activity occurred |\n| `comment` | Human-readable description of what happened |\n\nFormat `time` on the client for display (e.g. `2024-08-06 13:22:13` in your local timezone).\n\n## Common errors\n\n| HTTP status | Cause |\n| --- | --- |\n| `422` | `id` query parameter missing (`errors.id`) |\n| `403` | API key does not own this request |\n| `404` | Invalid request ID |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\",\n \"request\": {\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ],\n \"Requester\": {\n \"RequesterFirstName\": \"Lucas\",\n \"RequesterLastName\": \"Perez\",\n \"RequesterEmail\": \"requester@example.com\"\n }\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n },\n {\n \"time\": 1722953100,\n \"comment\": \"Landlord contacted via email\"\n }\n ]\n}"}],"_postman_id":"d9bc1631-b00f-4334-a41f-5da6e2cdc353"},{"name":"Get Reference Report","id":"442dc1f1-7723-4a56-aeb9-3ca8137544c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/api/v1/get-landlord-reference-report?_format=json&id={{REQUEST_ID}}","description":"Retrieve the landlord reference report for a request.
\nPoll this endpoint after Request Status indicates the report may be ready. The response always includes requestId, requestStatus, request, and progress.
The request object contains the current request details (property address, landlord contacts, residents, requester). Use it to see the latest data on file, including changes made by RenterFile staff or via Modify Request, without waiting for a completed reference response.
Full report details (residents, reference, referenceProvider, requester) are included only when requestStatus is one of:
completed_verified_landlordcompleted_landlord_not_verifiedcompleted_invalid_landlordNote: the top-level residents and requester fields on completed reports are the landlord-response report format. The request object always uses the same field names as Request Landlord Reference / Modify Request.
When status is not a completed variant, the response contains status, current request details, and progress:
\n{\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\",\n \"request\": {\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ]\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n }\n ]\n}\nWhen status is a completed variant, the response includes the full report:
\nreference fieldsResponse format
\n","type":"text/plain"},"key":"_format","value":"json"},{"description":{"content":"Request ID returned from Request Landlord Reference
\n","type":"text/plain"},"key":"id","value":"{{REQUEST_ID}}"}],"variable":[]}},"response":[{"id":"2c11ec29-ccb7-4da6-89a7-e12c5f5281d9","name":"In Progress","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"GET","header":[],"url":{"raw":"{{API_URL}}/api/v1/get-landlord-reference-report?_format=json&id={{REQUEST_ID}}","host":["{{API_URL}}"],"path":["api","v1","get-landlord-reference-report"],"query":[{"description":"Response format","value":"json","key":"_format"},{"description":"Request ID returned from Request Landlord Reference","value":"{{REQUEST_ID}}","key":"id"}]},"description":"Retrieve the landlord reference report for a request.\n\nPoll this endpoint after **Request Status** indicates the report may be ready. The response always includes `requestId`, `requestStatus`, `request`, and `progress`.\n\nThe `request` object contains the **current** request details (property address, landlord contacts, residents, requester). Use it to see the latest data on file, including changes made by RenterFile staff or via **Modify Request**, without waiting for a completed reference response.\n\n**Full report details** (`residents`, `reference`, `referenceProvider`, `requester`) are included only when `requestStatus` is one of:\n\n- `completed_verified_landlord`\n- `completed_landlord_not_verified`\n- `completed_invalid_landlord`\n\nNote: the top-level `residents` and `requester` fields on completed reports are the landlord-response report format. The `request` object always uses the same field names as **Request Landlord Reference** / **Modify Request**.\n\n## Query parameters\n\n| Parameter | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n| `_format` | Response format | Yes | String (`json`) |\n\n## Response when report is not yet complete\n\nWhen status is not a completed variant, the response contains status, current request details, and progress:\n\n```json\n{\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\",\n \"request\": {\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ]\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n }\n ]\n}\n```\n\n## Response when report is complete\n\nWhen status is a completed variant, the response includes the full report:\n\n| Top-level field | Description |\n| --- | --- |\n| `requestId` | Request ID |\n| `requestStatus` | Current status (a `completed_*` variant) |\n| `request` | Current request snapshot (same field names as **Request Landlord Reference** / **Modify Request**) |\n| `progress` | Activity log (same format as **Request Progress Report**; `time` is a Unix timestamp) |\n| `residents` | Array of resident details from the landlord response (`Name`, `Email`, `DateOfBirth`, `SSLastFour`) |\n| `reference` | Landlord's answers (rent amount, move-in/out dates, late payments, eviction, animals, etc.) |\n| `referenceProvider` | Landlord who provided the reference (`Name`, `Email`, `CompanyName`, `Phone`, `verificationStatus`, `validationNotes`) |\n| `requester` | Person/company who submitted the request (report format) |\n\n### Completed status variants\n\n| `requestStatus` | Meaning |\n| --- | --- |\n| `completed_verified_landlord` | Landlord verified as legitimate owner or property manager |\n| `completed_landlord_not_verified` | Report complete; landlord legitimacy could not be verified — review before relying on the reference |\n| `completed_invalid_landlord` | Reference did not come from the legitimate landlord or property manager |\n\n### Key `reference` fields\n\n| Field | Description |\n| --- | --- |\n| `TenancyAddress` | Rental property address |\n| `ReferenceStatus` | `current` or `past` tenancy |\n| `MoveInDate` / `MoveOutDate` | Tenancy dates (`YYYY-MM-DD`) |\n| `RentAmount` | Monthly rent (formatted, e.g. `$2,500`) |\n| `LatePayments` | Whether resident made late payments (`Yes`/`No`) |\n| `Eviction` | Whether an eviction was filed (`Yes`/`No`) |\n| `AnimalsAuthorized` / `AnimalsUnauthorized` | `true`/`false` when animals were reported; `null` when resident had no animals |\n| `OwnsBalance` | `1`/`0` — resident currently owes money (current residents) or left owing funds (previous residents) |\n| `LeftOwningBalance` | Amount owed, formatted like `$5,000`, or `0` when none |\n| `LandlordComment` | Free-text comment from the landlord |\n\n## Common errors\n\n| HTTP status | Cause |\n| --- | --- |\n| `422` | `id` query parameter missing (`errors.id`) |\n| `403` | API key does not own this request |\n| `404` | Invalid request ID |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"5460\",\n \"requestStatus\": \"landlord_legitimacy_check\",\n \"request\": {\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ]\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n },\n {\n \"time\": 1723022100,\n \"comment\": \"Landlord provided reference\"\n }\n ]\n}"},{"id":"63d1c86d-1036-48fc-a79a-a1060ee77d2a","name":"Completed Report","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"GET","header":[],"url":{"raw":"{{API_URL}}/api/v1/get-landlord-reference-report?_format=json&id={{REQUEST_ID}}","host":["{{API_URL}}"],"path":["api","v1","get-landlord-reference-report"],"query":[{"description":"Response format","value":"json","key":"_format"},{"description":"Request ID returned from Request Landlord Reference","value":"{{REQUEST_ID}}","key":"id"}]},"description":"Retrieve the landlord reference report for a request.\n\nPoll this endpoint after **Request Status** indicates the report may be ready. The response always includes `requestId`, `requestStatus`, `request`, and `progress`.\n\nThe `request` object contains the **current** request details (property address, landlord contacts, residents, requester). Use it to see the latest data on file, including changes made by RenterFile staff or via **Modify Request**, without waiting for a completed reference response.\n\n**Full report details** (`residents`, `reference`, `referenceProvider`, `requester`) are included only when `requestStatus` is one of:\n\n- `completed_verified_landlord`\n- `completed_landlord_not_verified`\n- `completed_invalid_landlord`\n\nNote: the top-level `residents` and `requester` fields on completed reports are the landlord-response report format. The `request` object always uses the same field names as **Request Landlord Reference** / **Modify Request**.\n\n## Query parameters\n\n| Parameter | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n| `_format` | Response format | Yes | String (`json`) |\n\n## Response when report is not yet complete\n\nWhen status is not a completed variant, the response contains status, current request details, and progress:\n\n```json\n{\n \"requestId\": \"5460\",\n \"requestStatus\": \"pending_landlord_response\",\n \"request\": {\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ]\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n }\n ]\n}\n```\n\n## Response when report is complete\n\nWhen status is a completed variant, the response includes the full report:\n\n| Top-level field | Description |\n| --- | --- |\n| `requestId` | Request ID |\n| `requestStatus` | Current status (a `completed_*` variant) |\n| `request` | Current request snapshot (same field names as **Request Landlord Reference** / **Modify Request**) |\n| `progress` | Activity log (same format as **Request Progress Report**; `time` is a Unix timestamp) |\n| `residents` | Array of resident details from the landlord response (`Name`, `Email`, `DateOfBirth`, `SSLastFour`) |\n| `reference` | Landlord's answers (rent amount, move-in/out dates, late payments, eviction, animals, etc.) |\n| `referenceProvider` | Landlord who provided the reference (`Name`, `Email`, `CompanyName`, `Phone`, `verificationStatus`, `validationNotes`) |\n| `requester` | Person/company who submitted the request (report format) |\n\n### Completed status variants\n\n| `requestStatus` | Meaning |\n| --- | --- |\n| `completed_verified_landlord` | Landlord verified as legitimate owner or property manager |\n| `completed_landlord_not_verified` | Report complete; landlord legitimacy could not be verified — review before relying on the reference |\n| `completed_invalid_landlord` | Reference did not come from the legitimate landlord or property manager |\n\n### Key `reference` fields\n\n| Field | Description |\n| --- | --- |\n| `TenancyAddress` | Rental property address |\n| `ReferenceStatus` | `current` or `past` tenancy |\n| `MoveInDate` / `MoveOutDate` | Tenancy dates (`YYYY-MM-DD`) |\n| `RentAmount` | Monthly rent (formatted, e.g. `$2,500`) |\n| `LatePayments` | Whether resident made late payments (`Yes`/`No`) |\n| `Eviction` | Whether an eviction was filed (`Yes`/`No`) |\n| `AnimalsAuthorized` / `AnimalsUnauthorized` | `true`/`false` when animals were reported; `null` when resident had no animals |\n| `OwnsBalance` | `1`/`0` — resident currently owes money (current residents) or left owing funds (previous residents) |\n| `LeftOwningBalance` | Amount owed, formatted like `$5,000`, or `0` when none |\n| `LandlordComment` | Free-text comment from the landlord |\n\n## Common errors\n\n| HTTP status | Cause |\n| --- | --- |\n| `422` | `id` query parameter missing (`errors.id`) |\n| `403` | API key does not own this request |\n| `404` | Invalid request ID |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"5460\",\n \"requestStatus\": \"completed_verified_landlord\",\n \"request\": {\n \"LandlordFirstName\": \"Rachel\",\n \"LandlordLastName\": \"Nguyen\",\n \"LandlordEmail\": \"landlord@example.com\",\n \"residents\": [\n {\n \"ResidentId\": 77,\n \"ResidentFirstName\": \"Ava\",\n \"ResidentLastName\": \"Thompson\",\n \"ResidentEmail\": \"resident@example.com\"\n }\n ]\n },\n \"progress\": [\n {\n \"time\": 1722950533,\n \"comment\": \"Rental verification request created\"\n },\n {\n \"time\": 1723022100,\n \"comment\": \"Landlord provided reference\"\n }\n ],\n \"residents\": [\n {\n \"Name\": \"Ava Thompson\",\n \"Email\": \"resident@example.com\",\n \"DateOfBirth\": \"1993-02-11\",\n \"SSLastFour\": \"3412\"\n }\n ],\n \"reference\": {\n \"TenancyAddress\": \"525 Market Street, San Francisco, CA 94105\",\n \"ReferenceStatus\": \"current\",\n \"IsCurrentResident\": 1,\n \"MoveInDate\": \"2021-06-01\",\n \"MoveOutDate\": null,\n \"RentAmount\": \"$3,200\",\n \"Animals\": 1,\n \"AnimalsType\": \"Dog\",\n \"AnimalsAuthorized\": true,\n \"AnimalsUnauthorized\": false,\n \"LatePayments\": 0,\n \"Eviction\": 0,\n \"OwnsBalance\": 1,\n \"LeftOwningBalance\": \"$5000\",\n \"LandlordComment\": \"Tenant is current and owes back rent.\"\n },\n \"referenceProvider\": {\n \"Name\": \"Rachel Nguyen\",\n \"Email\": \"landlord@example.com\",\n \"CompanyName\": \"Bayview Property Management\",\n \"Phone\": \"6285553901\",\n \"verificationStatus\": \"Completed\",\n \"validationNotes\": \"\"\n },\n \"requester\": {\n \"FirstName\": \"Lucas\",\n \"LastName\": \"Perez\",\n \"Email\": \"requester@example.com\",\n \"CompanyName\": \"UrbanNest Apartments\"\n }\n}"}],"_postman_id":"442dc1f1-7723-4a56-aeb9-3ca8137544c3"},{"name":"Cancel Request","id":"b301e103-f39e-4bea-a5ef-deeda418b1cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Request content type
\n"}],"body":{"mode":"raw","raw":"{\n \"id\": {{REQUEST_ID}}\n}"},"url":"{{API_URL}}/api/v1/cancel-request?_format=json","description":"Cancel an in-progress landlord reference request.
\nUse this endpoint when a verification is no longer needed. Cancellation is permanent and cannot be undone.
\nThe request must be in one of these statuses:
\npending_landlord_responselandlord_legitimacy_checkRequests that are already canceled, any completed status (completed_verified_landlord, completed_landlord_not_verified, completed_invalid_landlord), declined, or expired_no_landlord_response cannot be canceled.
200){\n \"requestId\": 5460,\n \"requestStatus\": \"canceled\"\n}\nResponse format
\n","type":"text/plain"},"key":"_format","value":"json"}],"variable":[]}},"response":[{"id":"6ae37db7-ac97-4ba4-a1ce-ce3499bc8c0e","name":"Success","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"POST","header":[{"value":"application/json","key":"Content-Type","description":"Request content type"}],"body":{"mode":"raw","raw":"{\n \"id\": {{REQUEST_ID}}\n}"},"url":{"raw":"{{API_URL}}/api/v1/cancel-request?_format=json","host":["{{API_URL}}"],"path":["api","v1","cancel-request"],"query":[{"value":"json","key":"_format","description":"Response format"}]},"description":"Cancel an in-progress landlord reference request.\n\nUse this endpoint when a verification is no longer needed. Cancellation is permanent and cannot be undone.\n\n## When cancellation is allowed\n\nThe request must be in one of these statuses:\n\n- `pending_landlord_response`\n- `landlord_legitimacy_check`\n\nRequests that are already `canceled`, any completed status (`completed_verified_landlord`, `completed_landlord_not_verified`, `completed_invalid_landlord`), `declined`, or `expired_no_landlord_response` cannot be canceled.\n\n## Request body\n\n| Field | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n\n## Success response (`200`)\n\n```json\n{\n \"requestId\": 5460,\n \"requestStatus\": \"canceled\"\n}\n```\n\n## Common errors\n\n| HTTP status | Message | Cause |\n| --- | --- | --- |\n| `400` | `Request id is required!` | `id` missing from body |\n| `400` | `Request is already canceled.` | Request was previously canceled |\n| `400` | `Request cannot be canceled in its current status.` | Status does not allow cancellation |\n| `403` | `Access Denied!` | API key does not own this request |\n| `404` | `No request found!` | Invalid request ID |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": 5460,\n \"requestStatus\": \"canceled\"\n}"},{"id":"7e4c911c-4e1f-4d4a-84e8-6c7875deca73","name":"Cannot Cancel - Wrong Status","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"POST","header":[{"value":"application/json","key":"Content-Type","description":"Request content type"}],"body":{"mode":"raw","raw":"{\n \"id\": {{REQUEST_ID}}\n}"},"url":{"raw":"{{API_URL}}/api/v1/cancel-request?_format=json","host":["{{API_URL}}"],"path":["api","v1","cancel-request"],"query":[{"value":"json","key":"_format","description":"Response format"}]},"description":"Cancel an in-progress landlord reference request.\n\nUse this endpoint when a verification is no longer needed. Cancellation is permanent and cannot be undone.\n\n## When cancellation is allowed\n\nThe request must be in one of these statuses:\n\n- `pending_landlord_response`\n- `landlord_legitimacy_check`\n\nRequests that are already `canceled`, any completed status (`completed_verified_landlord`, `completed_landlord_not_verified`, `completed_invalid_landlord`), `declined`, or `expired_no_landlord_response` cannot be canceled.\n\n## Request body\n\n| Field | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n\n## Success response (`200`)\n\n```json\n{\n \"requestId\": 5460,\n \"requestStatus\": \"canceled\"\n}\n```\n\n## Common errors\n\n| HTTP status | Message | Cause |\n| --- | --- | --- |\n| `400` | `Request id is required!` | `id` missing from body |\n| `400` | `Request is already canceled.` | Request was previously canceled |\n| `400` | `Request cannot be canceled in its current status.` | Status does not allow cancellation |\n| `403` | `Access Denied!` | API key does not own this request |\n| `404` | `No request found!` | Invalid request ID |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request cannot be canceled in its current status.\"\n}"}],"_postman_id":"b301e103-f39e-4bea-a5ef-deeda418b1cd"},{"name":"Modify Request","id":"1722667d-15e3-4820-b6e8-3818d83ce051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Request content type
\n"}],"body":{"mode":"raw","raw":"{\n \"id\": {{REQUEST_ID}},\n \"LandlordEmail\": \"corrected-landlord@example.com\",\n \"LandlordPhoneNumber\": \"6285553901\",\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"address_line2\": \"Apt 14D\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n \"updateResidents\": [\n {\n \"ResidentEmail\": \"resident@example.com\",\n \"ResidentPhoneNumber\": \"4155552109\"\n }\n ]\n}"},"url":"{{API_URL}}/api/v1/modify-request?_format=json","description":"Update an existing landlord reference request before the landlord responds.
\nUse this endpoint to correct landlord contact details, the rental property address, or the list of residents on a request.
\nModification is only permitted while the request status is pending_landlord_response. Once the landlord has responded or verification has started, use Cancel Request and submit a new request instead.
*At least one modifiable field (besides id) is required.
*When the request has a single resident, neither ResidentId nor ResidentEmail is required — the attached resident is updated directly (e.g. to correct a wrong email). When multiple residents are attached, provide ResidentId or ResidentEmail to identify which resident to update.
**At least one of ResidentNewEmail or ResidentPhoneNumber must be provided per entry.
Array of resident email addresses to remove. At least one resident must remain on the request.
\n200){\n \"requestId\": 5460,\n \"requestStatus\": \"pending_landlord_response\"\n}\nResponse format
\n","type":"text/plain"},"key":"_format","value":"json"}],"variable":[]}},"response":[{"id":"eb7154a1-5a29-4876-8048-32def2b5776c","name":"Success","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"POST","header":[{"value":"application/json","key":"Content-Type","description":"Request content type"}],"body":{"mode":"raw","raw":"{\n \"id\": {{REQUEST_ID}},\n \"LandlordEmail\": \"corrected-landlord@example.com\",\n \"LandlordPhoneNumber\": \"6285553901\",\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"address_line2\": \"Apt 14D\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n \"updateResidents\": [\n {\n \"ResidentEmail\": \"resident@example.com\",\n \"ResidentPhoneNumber\": \"4155552109\"\n }\n ]\n}"},"url":{"raw":"{{API_URL}}/api/v1/modify-request?_format=json","host":["{{API_URL}}"],"path":["api","v1","modify-request"],"query":[{"description":"Response format","value":"json","key":"_format"}]},"description":"Update an existing landlord reference request before the landlord responds.\n\nUse this endpoint to correct landlord contact details, the rental property address, or the list of residents on a request.\n\n## When modification is allowed\n\nModification is only permitted while the request status is **`pending_landlord_response`**. Once the landlord has responded or verification has started, use **Cancel Request** and submit a new request instead.\n\n## Request body\n\n| Field | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n| `LandlordFirstName` | Updated landlord first name | No* | String |\n| `LandlordLastName` | Updated landlord last name | No* | String |\n| `LandlordCompanyName` | Updated landlord company name | No* | String |\n| `LandlordEmail` | Updated landlord email (validated for deliverability) | No* | String |\n| `LandlordPhoneNumber` | Updated landlord phone (10-digit US; validated for reachability via Melissa) | No* | String |\n| `LandlordPhoneNumberConfirmed` | Set to `true` to skip Melissa reachability check when updating `LandlordPhoneNumber` (false-positive override) | No* | Boolean |\n| `PropertyAddress` | Full replacement property address object | No* | Object |\n| `addResidents` | Residents to add to the request | No* | Array |\n| `updateResidents` | Residents to update on the request | No* | Array |\n| `removeResidents` | Resident email addresses to remove | No* | Array of strings |\n\n\\*At least one modifiable field (besides `id`) is required.\n\n### PropertyAddress object\n\n| Field | Required | Type |\n| --- | --- | --- |\n| `country_code` | Yes | String (e.g. `US`) |\n| `address_line1` | Yes | String |\n| `address_line2` | No | String |\n| `city` | Yes | String |\n| `state` | Yes | String (2-letter code) |\n| `zip` | Yes | String |\n\n### addResidents[] object\n\n| Field | Required | Type |\n| --- | --- | --- |\n| `ResidentFirstName` | Yes | String |\n| `ResidentLastName` | Yes | String |\n| `ResidentMiddleName` | No | String |\n| `ResidentEmail` | Yes | String |\n| `ResidentDateOfBirth` | Yes | String (`YYYY-MM-DD`) |\n| `ResidentSsnLastFour` | Yes | String (4 digits) |\n| `ResidentPhoneNumber` | No | String |\n| `ResidentSignedConsentFid` | Yes | Integer (from **Consent File Upload**) |\n\n### updateResidents[] object\n\n| Field | Required | Type |\n| --- | --- | --- |\n| `ResidentId` | No* | Integer (user ID of the resident on the request) |\n| `ResidentEmail` | No* | String (current email on the request; used to identify the resident when multiple residents are attached) |\n| `ResidentNewEmail` | No** | String |\n| `ResidentPhoneNumber` | No** | String |\n\n\\*When the request has a single resident, neither `ResidentId` nor `ResidentEmail` is required — the attached resident is updated directly (e.g. to correct a wrong email). When multiple residents are attached, provide `ResidentId` or `ResidentEmail` to identify which resident to update.\n\n\\**At least one of `ResidentNewEmail` or `ResidentPhoneNumber` must be provided per entry.\n\n### removeResidents\n\nArray of resident email addresses to remove. At least one resident must remain on the request.\n\n## Success response (`200`)\n\n```json\n{\n \"requestId\": 5460,\n \"requestStatus\": \"pending_landlord_response\"\n}\n```\n\n## Common errors\n\n| HTTP status | Message | Cause |\n| --- | --- | --- |\n| `400` | `Request id is required!` | `id` missing |\n| `400` | `At least one modifiable field is required.` | Only `id` was sent |\n| `400` | `Request cannot be modified in its current status.` | Status is not `pending_landlord_response` |\n| `400` | `At least one resident must remain on the request.` | `removeResidents` would remove all residents |\n| `403` | `Access Denied!` | API key does not own this request |\n| `404` | `No request found!` | Invalid request ID |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": 5460,\n \"requestStatus\": \"pending_landlord_response\"\n}"},{"id":"3bc4345e-06c4-460d-a843-29d9a397421e","name":"Cannot Modify - Wrong Status","originalRequest":{"auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":"api-key"}},"method":"POST","header":[{"value":"application/json","key":"Content-Type","description":"Request content type"}],"body":{"mode":"raw","raw":"{\n \"id\": {{REQUEST_ID}},\n \"LandlordEmail\": \"corrected-landlord@example.com\",\n \"LandlordPhoneNumber\": \"6285553901\",\n \"PropertyAddress\": {\n \"country_code\": \"US\",\n \"address_line1\": \"525 Market Street\",\n \"address_line2\": \"Apt 14D\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94105\"\n },\n \"updateResidents\": [\n {\n \"ResidentEmail\": \"resident@example.com\",\n \"ResidentPhoneNumber\": \"4155552109\"\n }\n ]\n}"},"url":{"raw":"{{API_URL}}/api/v1/modify-request?_format=json","host":["{{API_URL}}"],"path":["api","v1","modify-request"],"query":[{"description":"Response format","value":"json","key":"_format"}]},"description":"Update an existing landlord reference request before the landlord responds.\n\nUse this endpoint to correct landlord contact details, the rental property address, or the list of residents on a request.\n\n## When modification is allowed\n\nModification is only permitted while the request status is **`pending_landlord_response`**. Once the landlord has responded or verification has started, use **Cancel Request** and submit a new request instead.\n\n## Request body\n\n| Field | Description | Required | Type |\n| --- | --- | --- | --- |\n| `id` | Request ID returned from **Request Landlord Reference** | Yes | Integer |\n| `LandlordFirstName` | Updated landlord first name | No* | String |\n| `LandlordLastName` | Updated landlord last name | No* | String |\n| `LandlordCompanyName` | Updated landlord company name | No* | String |\n| `LandlordEmail` | Updated landlord email (validated for deliverability) | No* | String |\n| `LandlordPhoneNumber` | Updated landlord phone (10-digit US; validated for reachability via Melissa) | No* | String |\n| `LandlordPhoneNumberConfirmed` | Set to `true` to skip Melissa reachability check when updating `LandlordPhoneNumber` (false-positive override) | No* | Boolean |\n| `PropertyAddress` | Full replacement property address object | No* | Object |\n| `addResidents` | Residents to add to the request | No* | Array |\n| `updateResidents` | Residents to update on the request | No* | Array |\n| `removeResidents` | Resident email addresses to remove | No* | Array of strings |\n\n\\*At least one modifiable field (besides `id`) is required.\n\n### PropertyAddress object\n\n| Field | Required | Type |\n| --- | --- | --- |\n| `country_code` | Yes | String (e.g. `US`) |\n| `address_line1` | Yes | String |\n| `address_line2` | No | String |\n| `city` | Yes | String |\n| `state` | Yes | String (2-letter code) |\n| `zip` | Yes | String |\n\n### addResidents[] object\n\n| Field | Required | Type |\n| --- | --- | --- |\n| `ResidentFirstName` | Yes | String |\n| `ResidentLastName` | Yes | String |\n| `ResidentMiddleName` | No | String |\n| `ResidentEmail` | Yes | String |\n| `ResidentDateOfBirth` | Yes | String (`YYYY-MM-DD`) |\n| `ResidentSsnLastFour` | Yes | String (4 digits) |\n| `ResidentPhoneNumber` | No | String |\n| `ResidentSignedConsentFid` | Yes | Integer (from **Consent File Upload**) |\n\n### updateResidents[] object\n\n| Field | Required | Type |\n| --- | --- | --- |\n| `ResidentId` | No* | Integer (user ID of the resident on the request) |\n| `ResidentEmail` | No* | String (current email on the request; used to identify the resident when multiple residents are attached) |\n| `ResidentNewEmail` | No** | String |\n| `ResidentPhoneNumber` | No** | String |\n\n\\*When the request has a single resident, neither `ResidentId` nor `ResidentEmail` is required — the attached resident is updated directly (e.g. to correct a wrong email). When multiple residents are attached, provide `ResidentId` or `ResidentEmail` to identify which resident to update.\n\n\\**At least one of `ResidentNewEmail` or `ResidentPhoneNumber` must be provided per entry.\n\n### removeResidents\n\nArray of resident email addresses to remove. At least one resident must remain on the request.\n\n## Success response (`200`)\n\n```json\n{\n \"requestId\": 5460,\n \"requestStatus\": \"pending_landlord_response\"\n}\n```\n\n## Common errors\n\n| HTTP status | Message | Cause |\n| --- | --- | --- |\n| `400` | `Request id is required!` | `id` missing |\n| `400` | `At least one modifiable field is required.` | Only `id` was sent |\n| `400` | `Request cannot be modified in its current status.` | Status is not `pending_landlord_response` |\n| `400` | `At least one resident must remain on the request.` | `removeResidents` would remove all residents |\n| `403` | `Access Denied!` | API key does not own this request |\n| `404` | `No request found!` | Invalid request ID |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request cannot be modified in its current status.\"\n}"}],"_postman_id":"1722667d-15e3-4820-b6e8-3818d83ce051"}]}