Register background check packages

post

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

Replace the partner package catalog for the installing company.

Registers or replaces the partner's package catalog for the
installing company. The call is idempotent — safe to retry to refresh names
or descriptions.

Catalog replace semantics:

id and name are required and non-blank; description is optional.
Duplicate package IDs in the same request return 400.
Packages omitted from the POST are permanently deleted and cannot be selected for new checks.
An empty packages array permanently deletes the full catalog for that company/app.
In-flight checks keep their stored packageId; GET and PATCH on existing checks remain allowed.
Validation is all-or-nothing — no partial accept.

There is no hard maximum package count in v1.

OAuth scope: hiring.integrations:write

Responses

204

No content

400Bad request — the request body failed validation (for example an unsupported status, blank package id/name, or duplicate package IDs in the same catalog push).

401Unauthorized — the OAuth 2.0 access token is missing, invalid, or expired.

403Forbidden — the authenticated partner app does not have the hiring.integrations:write scope, or the background-check integration is not enabled for the installing company.

429Too many requests — rate limit exceeded. Retry after the delay indicated by the platform partner API / API gateway defaults.

500Internal server error — an unexpected error occurred. Retry with exponential backoff; if the error persists, contact HiBob support with the requestId from the response body.