Create an assessment package

POST/assessment/{connection_id}/package

Parameters

connection_idstring required

ID of the connection

Payload

Used by assessment providers to SUBMIT packages to ATS systems

idstring

Unique identifier for the assessment package

created_atdate

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring read-only

Workspace ID that this package belongs to (reference to KmsSpace)

connection_idstring read-only

Connection ID that this package belongs to

integration_typesstring array

Integration types that support this package

namestring

Name of the assessment package

type enum required

Valid values:

"SKILLS_TEST"

"BEHAVIORAL_ASSESSMENT"

"VIDEO_INTERVIEW"

"BACKGROUND_CHECK"

"REFERENCE_CHECK"

aliasesstring array

Alternative namesidentifiers for this package

tagsstring array

Category tags (e.g., "Assessment", "Background Check")

descriptionstring

Detailed description

parameters array

Questionsinputs needed for this assessment (aligned with verification)

has_redirect_urlboolean

Whether provider redirects user to complete assessment

has_target_urlboolean

Where provider redirects user after completion

needs_ip_addressboolean

Whether IP address is required

max_scorenumber

Maximum possible score if this assessment returns a score

info_urlstring

URL to find additional information about this package

regions array

rawany

Returns

AssessmentPackage

Used by assessment providers to SUBMIT packages to ATS systems

idstring

Unique identifier for the assessment package

created_atdate

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring read-only

Workspace ID that this package belongs to (reference to KmsSpace)

connection_idstring read-only

Connection ID that this package belongs to

integration_typesstring array

Integration types that support this package

namestring

Name of the assessment package

type enum required

Valid values:

"SKILLS_TEST"

"BEHAVIORAL_ASSESSMENT"

"VIDEO_INTERVIEW"

"BACKGROUND_CHECK"

"REFERENCE_CHECK"

aliasesstring array

Alternative namesidentifiers for this package

tagsstring array

Category tags (e.g., "Assessment", "Background Check")

descriptionstring

Detailed description

parameters array

Questionsinputs needed for this assessment (aligned with verification)

has_redirect_urlboolean

Whether provider redirects user to complete assessment

has_target_urlboolean

Where provider redirects user after completion

needs_ip_addressboolean

Whether IP address is required

max_scorenumber

Maximum possible score if this assessment returns a score

info_urlstring

URL to find additional information about this package

regions array

rawany

const options = {
  method: 'POST',
  url: 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/package',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,

};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.assessment.createAssessmentPackage({ connectionId, assessmentPackage: { }, 

 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/package',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,

};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/assessment/5de520f96e439b002043d8dc/package")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/assessment/5de520f96e439b002043d8dc/package

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/assessment/5de520f96e439b002043d8dc/package"

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/assessment/5de520f96e439b002043d8dc/package",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/assessment/5de520f96e439b002043d8dc/package")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request POST \
  --url 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/package' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?