> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.fortresstech.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.fortresstech.io/_mcp/server.

# Read Screening Request

GET https://api.fortresstech.io/v1/screening-requests/{screeningRequestId}

Onboarding RequiredRetrieve a specific screening request by its ID.Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration.

Reference: https://developer.fortresstech.io/api-reference/screenings/read-screening-request

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `screeningRequestId` (string, required) — The ID of the screening request to retrieve.

## Response

### 200

Expected response to a valid request

- `id` (string, optional)
- `idempotencyId` (string, optional)
- `status` (enum, optional)
  - Allowed values: `NOT_STARTED`, `IN_PROGRESS`, `COMPLETED`, `ERROR`
- `screening` (ScreeningRequestScreening, optional)
- `screeningMethods` (list of ScreeningRequestScreeningMethodsItems, optional) — List of screening methods configured for the request

## Types

### ScreeningRequestScreening

- `householdId` (string, optional) — Household identifier
- `isAffordable` (boolean, optional)
- `screeningAmount` (float, optional)
- `purpose` (enum, optional, nullable) — The purpose of the screening
  - Allowed values: `Application`, `Recert`, `Renewal`, `New Member`, `Other`
- `payload` (ScreeningRequestScreeningPayload, optional)
- `createdById` (string, optional, nullable) — ID of the user who created the screening

### ScreeningRequestScreeningMethodsItems

- `id` (string, optional) — The unique identifier for the screening method
- `method` (enum, optional) — The type of screening method
  - Allowed values: `credit`, `criminal`, `eviction`

### ScreeningRequestScreeningPayload

- `unit` (ScreeningRequestScreeningPayloadUnit, optional, nullable) — The unit the screening is for, with its floor plan. Occupancy wins over the applied-for unit: whenever the household already occupies a unit, that is the unit reported, even when the application is for a different one. Only when the household occupies nothing does this fall back to the unit most recently assigned to the application, which is the usual case for a new applicant. A household part-way through a transfer reports the unit it still occupies, not the transfer destination, until the transfer completes. Assigned units are not required in order to screen, so this is `null` when the household has no unit assigned, and also when the unit could not be resolved as the screening was submitted — that lookup is deliberately non-blocking, so a transient failure is indistinguishable from an unassigned unit and is never backfilled. Absent entirely on screenings created before this field was introduced.
- `depositAmount` (float, optional)
- `leaseTerm` (string, optional)
- `applicants` (list of ScreeningRequestScreeningPayloadApplicantsItems, optional)

### ScreeningRequestScreeningPayloadUnit

The unit the screening is for, with its floor plan. Occupancy wins over the applied-for unit: whenever the household already occupies a unit, that is the unit reported, even when the application is for a different one. Only when the household occupies nothing does this fall back to the unit most recently assigned to the application, which is the usual case for a new applicant. A household part-way through a transfer reports the unit it still occupies, not the transfer destination, until the transfer completes. Assigned units are not required in order to screen, so this is `null` when the household has no unit assigned, and also when the unit could not be resolved as the screening was submitted — that lookup is deliberately non-blocking, so a transient failure is indistinguishable from an unassigned unit and is never backfilled. Absent entirely on screenings created before this field was introduced.

- `id` (string, optional) — Unit identifier
- `number` (string, optional, nullable) — The unit number as configured in Fortress
- `floorplan` (ScreeningRequestScreeningPayloadUnitFloorplan, optional, nullable) — The unit's floor plan. `null` when the unit has no floor plan assigned.

### ScreeningRequestScreeningPayloadApplicantsItems

- `customerId` (string, optional) — Customer identifier
- `firstName` (string, optional)
- `lastName` (string, optional)
- `emailAddress` (string, optional)
- `phoneNumber` (string, optional)
- `dob` (date, optional)
- `address` (string, optional)
- `city` (string, optional)
- `state` (string, optional)
- `zipCode` (string, optional)
- `annualIncome` (double, optional)
- `employmentStatus` (string, optional)
- `financiallyResponsible` (boolean, optional)
- `assets` (double, optional)
- `middleName` (string, optional)
- `suffix` (string, optional)
- `companyName` (string, optional)
- `currentSalary` (double, optional)
- `socialSecurityNumber` (string, optional) — Encrypted SSN
- `leaseSignerType` (enum, optional, nullable) — The applicant's lease signer type as configured in Fortress
  - Allowed values: `Financial Lease Signer`, `Employee Lease Signer`, `Courtesy Officer Lease Signer`, `Guarantor Lease Signer`, `Vendor Unit Lease Signer`, `Corporate Unit Lease Signer`, `Non Financial Lease Signer`, `Live-In-Caretaker`, `Aged up Minor`
- `previousScreening` (ScreeningRequestScreeningPayloadApplicantsItemsPreviousScreening, optional, nullable) — Details of the most recent prior screening for this applicant on the same property and provider. Present only when a prior screening exists for the applicant; `null` otherwise. This can be used as a signal of a prior screening and may help identify possible re-screens or duplicate submissions.

### ScreeningRequestScreeningPayloadUnitFloorplan

The unit's floor plan. `null` when the unit has no floor plan assigned.

- `id` (string, optional) — Floor plan identifier
- `internalName` (string, optional, nullable) — The floor plan's internal name in Fortress. The floor plan endpoints expose this same value as `name`.
- `marketingName` (string, optional, nullable) — The floor plan's marketing name in Fortress

### ScreeningRequestScreeningPayloadApplicantsItemsPreviousScreening

Details of the most recent prior screening for this applicant on the same property and provider. Present only when a prior screening exists for the applicant; `null` otherwise. This can be used as a signal of a prior screening and may help identify possible re-screens or duplicate submissions.

- `id` (string, optional, nullable) — ID of the prior Screening record
- `requestId` (string, optional, nullable) — ID of the prior ScreeningRequest record
- `resultId` (string, optional, nullable) — ID of the prior ScreeningResult record, if one exists
- `status` (enum, optional, nullable) — Result status of the prior screening
  - Allowed values: `APPROVED`, `APPROVED_WITH_CONDITIONS`, `DECLINED`, `REFER`, `PENDING`, `CANCELED`, `CONDITIONAL`, `ERROR`
- `screeningCreatedAt` (datetime, optional, nullable) — When the prior Screening was created
- `resultCreatedAt` (datetime, optional, nullable) — When the prior ScreeningResult was created, if one exists
- `cancellationReasons` (list of string, optional, nullable) — Reserved for future use

## Examples

**Response**

```json
{
  "id": "string",
  "idempotencyId": "string",
  "status": "NOT_STARTED",
  "screening": {
    "householdId": "string",
    "isAffordable": true,
    "screeningAmount": 1.1,
    "purpose": "Application",
    "payload": {
      "unit": {
        "id": "string",
        "number": "string",
        "floorplan": {
          "id": "string",
          "internalName": "string",
          "marketingName": "string"
        }
      },
      "depositAmount": 1.1,
      "leaseTerm": "string",
      "applicants": [
        {
          "customerId": "string",
          "firstName": "string",
          "lastName": "string",
          "emailAddress": "string",
          "phoneNumber": "string",
          "dob": "2023-01-15",
          "address": "string",
          "city": "string",
          "state": "string",
          "zipCode": "string",
          "annualIncome": 1.1,
          "employmentStatus": "string",
          "financiallyResponsible": true,
          "assets": 1.1,
          "middleName": "string",
          "suffix": "string",
          "companyName": "string",
          "currentSalary": 1.1,
          "socialSecurityNumber": "string",
          "leaseSignerType": "Financial Lease Signer",
          "previousScreening": {
            "id": "string",
            "requestId": "string",
            "resultId": "string",
            "status": "APPROVED",
            "screeningCreatedAt": "2024-01-15T09:30:00Z",
            "resultCreatedAt": "2024-01-15T09:30:00Z",
            "cancellationReasons": [
              "string"
            ]
          }
        }
      ]
    },
    "createdById": "string"
  },
  "screeningMethods": [
    {
      "id": "string",
      "method": "credit"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.fortresstech.io/v1/screening-requests/screeningRequestId"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.fortresstech.io/v1/screening-requests/screeningRequestId';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fortresstech.io/v1/screening-requests/screeningRequestId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fortresstech.io/v1/screening-requests/screeningRequestId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.fortresstech.io/v1/screening-requests/screeningRequestId")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.fortresstech.io/v1/screening-requests/screeningRequestId', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.fortresstech.io/v1/screening-requests/screeningRequestId");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fortresstech.io/v1/screening-requests/screeningRequestId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```