Skip to navigation
API ReferenceScreenings

Update Screening Result

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.

Authentication

x-api-keystring
API Key authentication via header

Request

The fields to update on the screening result
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
messagestringOptional
screeningResultIdstringOptionalformat: "uuid"
timestampdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error