API Reference
Become a partner

Update background check status

patch
https://api.hibob.com/v1/hiring/background-checks/

Report status, result, PDF report, and per-step check progress back to Bob.

Reports status changes and optional results for an existing
background check. The check ID is always in the path —
backgroundCheckRequestId is not accepted in the body.

status is required. result, report, and checks are optional.

This PATCH is the target contract; the temporary
POST /background-checks/webhook alias remains only for migration. After a
backgroundCheck.cancelled webhook, partners stop processing and do not
send further updates unless product guidance says otherwise.

When report is present, Bob fetches the PDF from report.url at PATCH
time and stores it as a candidate file. Size limits and malware scanning
follow platform file-service defaults.

OAuth scope: hiring.integrations:write

Path Params
string
required

Numeric Bob background-check ID as a string.

Body Params

Status update payload. status is required; result, report, and
checks are optional.

string
enum
required

Overall check status shown in Bob. Required on every update.

Allowed:
string | null

Optional human-readable result summary (for example "Pass").

report

Optional PDF report reference. Bob downloads the file at PATCH time.

checks
array of objects | null

Optional per-step breakdown of individual checks within the package.

checks
Responses
204

No content

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Bearer
OAuth 2.0
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?