Create Screening Result

curl -X POST https://api.fortresstech.io/v1/screening-results \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "idempotencyId": "string",
  "screeningRequestId": "string",
  "providerIdentifier": "string",
  "status": "APPROVED",
  "screeningMethods": [
    {
      "screeningMethodId": "string",
      "status": "APPROVED"
    }
  ]
}'

{
  "idempotencyId": "string",
  "screeningRequestId": "string",
  "providerIdentifier": "string",
  "status": "APPROVED",
  "screeningMethods": [
    {
      "screeningMethodId": "string",
      "status": "APPROVED",
      "notes": "string"
    }
  ],
  "id": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "transactionId": "string",
  "adverseFactors": [
    "string"
  ],
  "providerStatus": "string",
  "applicationRecommendation": "string",
  "notes": "string",
  "report": "string",
  "fortressStatus": "Accept"
}

Onboarding Required

Create a screening result

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

Request

The result to create

idempotencyIdstringRequiredformat: "uuid"

screeningRequestIdstringRequiredformat: "uuid"

providerIdentifierstringRequired

Unique identifier for the screening result

statusenumRequired

The status of the screening result

screeningMethodslist of objectsRequired

Array of screening method details. Must include one entry for each screening method configured for the property. The number of methods provided must match the number of methods associated with the screening request.

transactionIdstringOptional

Transaction ID associated with the screening result

adverseFactorslist of stringsOptional

Array of adverse factors for the screening result

providerStatusstringOptional

A code that maps to a specific description from the screening provider

applicationRecommendationstringOptional

Similar to the providerStatus field but more details provided for the overall application.

notesstringOptional

General notes about the screening result

reportstringOptional

Link to a report for the screening result, if available

fortressStatusenumOptional

The status of the screening result as determined by and used inside of Fortress

Response

Expected response to a valid request

idempotencyIdstringformat: "uuid"

screeningRequestIdstringformat: "uuid"

providerIdentifierstring