Background checks
Register background check packages
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:
<ul> <li>`id` and `name` are required and non-blank; `description` is optional.</li> <li>Duplicate package IDs in the same request return `400`.</li> <li>Packages omitted from the POST are permanently deleted and cannot be selected for new checks.</li> <li>An empty `packages` array permanently deletes the full catalog for that company/app.</li> <li>In-flight checks keep their stored `packageId`; GET and PATCH on existing checks remain allowed.</li> <li>Validation is all-or-nothing — no partial accept.</li> </ul>There is no hard maximum package count in v1.
OAuth scope: hiring.integrations:write
Rate limit: 60 calls per minute
post/hiring/background-checks/packages
Request
- Base URLhttps://api.hibob.com/v1
- URLhttps://api.hibob.com/v1/hiring/background-checks/packages
- AuthHTTP bearer
Request body
Response
No content
Changes
No recorded changes to this operation across all 1 revision of this API.