API ReferenceScreenings

Create Screening Result

<Badge>Onboarding Required</Badge> Create a screening result <Info> Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration. </Info>

Request

This endpoint expects an object.
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"
providerIdentifierstring
Unique identifier for the screening result
screeningMethodslist of objects
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.
screeningRequestIdstringformat: "uuid"
statusenum
The status of the screening result
adverseFactorslist of strings or null
Array of adverse factors for the screening result
applicationRecommendationstring or null
Similar to the providerStatus field but more details provided for the overall application.
createdAtdatetime or null
deletedAtdatetime or null
fortressStatusenum or null
The status of the screening result as determined by and used inside of Fortress
idstring or nullformat: "uuid"
notesstring or null
General notes about the screening result
providerStatusstring or null
A code that maps to a specific description from the screening provider
reportstring or null
Link to a report for the screening result, if available
transactionIdstring or null
Transaction ID associated with the screening result
updatedAtdatetime or null