Skip to Content

User Guide

Business Portal Login

Test Checks

Test mode keys is the safest method for testing and is suggested during development.

Records created using a test mode api key do not appear in the normal parts of the integration dashboard.

These records are stored in a separate partition of the database and are not visible in the main tools of the integration dashboard, nor are they visible to the support or verification staff.

There are only two areas where test mode records can be managed:

  • Using a test mode API key.
  • Using the Test Checks function within the Api Keys section of the integration dashboard.

 

Managing test records

There are a set of tools in the integration dashboard for managing test records.

To access the test mode tools:

  1. Log into your integration dashboard
  2. Navigate to the Api Keys section using the left-side menu
  3. Navigate to the Test Checks tab using the sub-menu
  4. Click on a test check to see it's details and execute the various test mode tools

There are a number of test mode tools available, including tools to change the verification status of checks, tools to generate fake results for services, and a tool to execute the dispatch process for checks.

Click on the Test Checks tab and then choose the check which you want to manage.

Only some of the tools will be available, depending on the status of the check. Click the buttons to change the check status which will also fire the appropriate webhooks.

Caveats when using test mode

There are a few caveats to be aware of when using test mode.

a. Continue URLs do not point to the candidate experience, instead to direct the user to a holding page. The candidate experience is outsode of the scope of test mode, and the test mode tools should be used instead.

b. Result URLs do not point to a meaningful url. These urls are designed to be sent directly to candidates, so the testing is limited to the successful generation of the url. Result PDFs can be fetched via the api endpoints.

More guides in this topic