NAV Navbar
shell

Assessment API

Overview

The Assessment API allows JazzHR customers to seamlessly integrate Partners's assessments into their JazzHR recruiting workflow.

Workflow

The workflow outlined below mimics the HR Open Standards Pre-hire Assessment use case.

Assessment Workflow

Verify

When a JazzHR customer decides to utilize an Assessment Partner's integration, they must input a bearer token to verify the authentication credential. This bearer token uniquely identifies the customer within the Assessment Partner and is included in the header of all requests. See the Authentication section below for more information.

Partner Credentials Modal

List Catalog

JazzHR customer selects a desired assessment package from the Assessment Partner catalog to incorporate in their recruiting workflow.

List Packages Modal

Order Package

JazzHR customer orders an assessment package for a particular candidate.

Order Package Modal

Retrieve Results

The Assessment Partner notifies JazzHR as the candidate completes the assessment. JazzHR subsequently retrieves and stores the assessment results.

Assessment Results

Authentication

Authorization: Bearer <token>

The bearer token associated with the verified JazzHR customer will be included in the Authorization header of all requests.

This bearer token should uniquely identify the customer within the Assessment Partner system.

Integration

To begin the integration process, please provide JazzHR with the following information:

  1. verifyURL
  2. listCatalogURL
  3. orderPackageURL
  4. retrieveResultsURL
  5. Test bearer token

JazzHR will provide the Assessment Partner the following:

  1. A unique partnerId
  2. Sandbox access

API Details

Detailed information for Assessment API endpoints, requests, and responses can be found here.

Postman

Run in Postman

A Postman collection has been made available to facilitate the Assessment API implementation process. To make use of this resource, please import the collection and provide values for the included collection variables. This collection contains a set of test scripts that can interact with a collection run to help verify your API implementation.