Package data model
Used by assessment providers to SUBMIT packages to ATS systems
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the assessment package |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
workspace_id | string | No | Workspace ID that this package belongs to (reference to KmsSpace) (read-only) |
connection_id | string | No | Connection ID that this package belongs to (read-only) |
integration_types | string[] | No | Integration types that support this package |
name | string | No | Name of the assessment package |
type | enum | Yes | Values: SKILLS_TEST, BEHAVIORAL_ASSESSMENT, VIDEO_INTERVIEW, BACKGROUND_CHECK, REFERENCE_CHECK, OTHER |
aliases | string[] | No | Alternative namesidentifiers for this package |
tags | string[] | No | Category tags (e.g., "Assessment", "Background Check") |
description | string | No | Detailed description |
parameters | AssessmentParameter[] | No | Questionsinputs needed for this assessment (aligned with verification) |
parameters[].id | string | No | |
parameters[].name | string | No | |
parameters[].public_question | string | No | Question to ask the candidateuser |
parameters[].type | enum | No | Values: TEXT, NUMBER, MULTIPLE_CHOICE, MULTIPLE_SELECT, DATE, FILE |
parameters[].options | string[] | No | Options for MULTIPLE_CHOICE and MULTIPLE_SELECT |
parameters[].file_types | string[] | No | Valid file MIME types for FILE type |
parameters[].valid_regions | string[] | No | Regions where this parameter is valid ({country}-{state} or {country}) |
parameters[].is_required | boolean | No | |
has_redirect_url | boolean | No | Whether provider redirects user to complete assessment |
has_target_url | boolean | No | Where provider redirects user after completion |
needs_ip_address | boolean | No | Whether IP address is required |
max_score | number | No | Maximum possible score if this assessment returns a score |
info_url | string | No | URL to find additional information about this package |
regions | AssessmentPackageRegion[] | No | |
regions[].regions | string[] | No | Countryregion codes where this package is available ({country}-{state} or {country}) |
regions[].cost_amount | number | No | |
regions[].currency | string | No | ISO 4217 format |
regions[].processing_time | number | No | Processing time in milliseconds |
Are we missing anything? Let us know