Skip to main content

Screening packages

Define the checks a role requires once, then apply that same set every time you screen someone for it.

Who it's for: Compliance admins and recruiters who screen for the same roles repeatedly

Availability: Available

What you get​

  • One named, reusable bundle per role, instead of re-listing requirements each time you screen
  • AND/OR logic and nested groups, for roles where one of several credentials will satisfy a requirement
  • Per-credential settings — whether an attachment is required, or whether a credential can be skipped
  • Guiding text shown to the person against a specific credential, so they send the right document
  • A staged/retired lifecycle: build a package before it goes live, and take it out of use without losing its history

Turn it on​

→ Create a screening package — name the package, add the credentials the role requires, and set it active when you're ready to use it.

How it works​

A screening package is the compliance half of a job description: the role says what the checks are, and the package holds them together so everyone screened for that role is asked for exactly the same thing. Each package carries a short code you choose, unique within your account, and is either active — selectable when you send a screening — or inactive.

→ Screening Packages — what a package represents, and the full set of options → Credentials — the credential types a package can require → Exemptions — how a worker excused from a requirement is handled

For developers

Create and activate packages over the REST API, or send the same grammar inline as a requirements block — including operator, nested groups, and a credentialSettings map for per-credential attachmentRequired and skippable.

→ Screening an applicant → API Reference — the Screening Packages endpoints

Good to know​

  • Packages apply when you screen someone — see Recruitment check requests.
  • A fetch request to an existing worker takes a plain list of credential types in the app; the structured requirements grammar is available over the API.
  • Where several credentials are interchangeable, an equivalence set defined under compliance rules is the other way to express it.
  • A package is identified by its code, and the code is what your own systems should reference rather than the display name.