Update Screening Result

<Badge>Onboarding Required</Badge> Update an existing screening result and/or its individual method details. Use this endpoint when new data comes in incrementally — for example, when one of several pending method results resolves and you want to update that detail and/or the overall result status without re-submitting everything. <Info> Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration. </Info> <Warning> Updates are blocked if a final decision has already been recorded for the associated screening. A `409 Conflict` response will be returned in that case. </Warning>

Onboarding Required

Update an existing screening result and/or its individual method details.

Use this endpoint when new data comes in incrementally — for example, when one of several pending method results resolves and you want to update that detail and/or the overall result status without re-submitting everything.

Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration.

Updates are blocked if a final decision has already been recorded for the associated screening. A 409 Conflict response will be returned in that case.

Request

This endpoint expects an object.

screeningRequestIdstringRequiredformat: "uuid"

The ID of the screening request whose result should be updated

statusenumOptional

The updated overall status of the screening result

notesstringOptional

Updated notes about the overall screening result

reportstringOptional

Updated link to the screening report, if available

screeningMethodslist of objectsOptional

Optional array of individual screening method results to update. Each entry must reference a screeningMethodId that belongs to this screening result. You may provide any number of methods — or omit this field entirely to update only the top-level result fields.

Response

Screening result updated successfully

messagestring

screeningResultIdstringformat: "uuid"

timestampdatetime

Errors

400

Update Screening Result Request Bad Request Error

401

Update Screening Result Request Unauthorized Error

404

Update Screening Result Request Not Found Error

409

Update Screening Result Request Conflict Error

Onboarding Required

Update an existing screening result and/or its individual method details.

Screening endpoints require an additional onboarding process. Please contact our team to begin the onboarding process for screening integration.

Updates are blocked if a final decision has already been recorded for the associated screening. A 409 Conflict response will be returned in that case.

This endpoint expects an object.

The ID of the screening request whose result should be updated

The updated overall status of the screening result

Updated notes about the overall screening result

Updated link to the screening report, if available

Screening result updated successfully

$	curl -X PATCH https://api.fortresstech.io/v1/screening-results \
>	-H "Content-Type: application/json" \
>	-d '{
>	"screeningRequestId": "screeningRequestId"
>	}'

$	curl -X PATCH https://api.fortresstech.io/v1/screening-results \
>	-H "Content-Type: application/json" \
>	-d '{
>	"screeningRequestId": "screeningRequestId"
>	}'

1	{
2	"message": "Screening result updated successfully",
3	"screeningResultId": "screeningResultId",
4	"timestamp": "2024-01-15T09:30:00Z"
5	}