Updates the status and results of an existing background check in a candidate's timeline. This tool is designed for background check providers to push status updates (pending, consented, completed, declined, expired) and results back to Workable after initiating a background che…
checkobjectStructured results for a completed background check.
statusRequiredstringNew status of the background check. Options: 'pending' (initial status), 'consented' (candidate agreed to the check), 'completed' (check finished with results), 'declined' (candidate rejected the check), 'expired' (request timed out). When status is 'completed', both results_url…
attachmentsarrayOptional list of additional attachments (typically PDF reports) related to the background check results. Each attachment includes a description and publicly accessible URL.
results_urlstringPublic URL link to the full background check report on the provider's website. REQUIRED when status is 'completed', optional otherwise.
background_check_idRequiredstringThe unique identifier of an existing background check request in Workable. This ID is provided when the background check was initially created through the background check provider integration.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.