Read Screening Request

GET

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

GET

/v1/screening-requests/:screeningRequestId

curl https://api.fortresstech.io/v1/screening-requests/screeningRequestId \
     -H "x-api-key: <apiKey>"

200Retrieved

{
  "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"
    }
  ]
}

Onboarding Required

Retrieve 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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

screeningRequestIdstringRequired

The ID of the screening request to retrieve.

Response

Expected response to a valid request

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

statusenumOptional

Allowed values:

screeningobjectOptional

screeningMethodslist of objectsOptional

List of screening methods configured for the request