Overview
A unified Screening API overcomes typical integration challenges by standardizing inconsistent data models, normalizing varied terminology, and creating a consistent entity structure where candidate screening data, background checks, assessments, and results exist predictably regardless of which screening provider your customer uses.
Benefits of StackOne Screening API
Here are some benefits of using our Screening API that simplifies and enhances candidate screening processes:
Key Features
The table below shows key features of the Screening API that make candidate screening easier, from background checks to skills assessments:
| Feature | Description |
|---|---|
| Background Check Management | Easily initiate, track, and retrieve results for various types of background checks. |
| Assessment Integration | Manage candidate assessments, from technical skills tests to personality evaluations. |
| Real-Time Webhooks | Receive instant notifications for screening status updates and completed results. |
Entity Model and Relationships
The following diagram illustrates the key entities within the Screening API:
The following table outlines key entities within the Screening system and provides a brief description of each.
| Entity | Description |
|---|---|
| Candidate | Contains essential candidate information required for screening, including first name, last name, and email. |
| ScreeningOrder | Represents a screening request for a candidate using a specific package, including any custom fields or provider-specific data. |
| ScreeningPackage | Defines available screening services, including name, description, and provider-specific configuration. |
| ScreeningResult | Contains the outcome of a screening order, including status, summary, scoring, and access to detailed results. |
| ResultScore | Represents the scoring details of a screening result, with label, value, and score range. |
| Provider | Represents the screening service providers integrated with the system. |
| WebhookEvent | Defines the structure of webhook notifications for screening status updates and results. |
The API supports the following screening result statuses:
-
pending: Initial state when the screening is requested -
in_progress: Screening is currently being processed -
completed: Screening has been successfully completed -
failed: Screening process encountered an error -
cancelled: Screening was cancelled before completion
Webhook events are triggered for the following scenarios:
-
screening.result.created: New screening result created -
screening.result.updated: Existing result updated -
screening.result.completed: Screening process completed -
screening.result.failed: Screening process failed -
screening.result.cancelled: Screening was cancelled
Use cases
Automated Background Checks
Streamline your hiring process by automatically initiating background checks when candidates reach specific stages.
Assessment Integration
Seamlessly incorporate skills assessments and personality tests into your hiring workflow.
Was this page helpful?