Skip to Content

User Guide

Business Portal Login

Scopes

Police checks

The following scopes are available for the Consumer API:

  • police.create — Create new police checks
  • police.read — List and read details of existing police checks
  • police.results — Download police check results and metadata
  • police.email — Trigger sending of email reminders or email results to candidates
  • police.accept — Accept existing police checks; only applies if using the acceptance system

 

Right-to-work standalone

The following scopes are available for the Right-To-Work API:

  • rtw.create — Create new right to work checks
  • rtw.read — List and read details of existing rtw checks
  • rtw.results — Download rtw check results

 

Identity checks

The following scopes are available for the InstaID Plus API. Note that these scopes are only needed for standalone identity checks (InstaID Plus) and are not required for identity verifications which occur as a part of police/rtw checks.

  • identity.create — Create new identity checks
  • identity.read — List and read details of existing identity checks
  • identity.results — Download identity check results
  • identity.delete — Delete (cancel) identity check
  • identityrulesets.read — List and read details of identity rulesets

 

REST Data Access API

These scopes are available for the REST Data Access API:

  • whitelabelsites.read — List and read co-branded sites
  • whitelabelsites.billingcodes.read — List and read co-branded billing codes
  • whitelabelsites.billingcodes.write — Create/modify co-branded billing codes
  • webhooks.read — List and read details of webhook registrations
  • webhooks.create — Create new webhook registrations
  • webhooks.delete — Delete existing webhooks

 

General usage

The following scopes are available for general usage across all APIs:

  • offline_access — Allows non-interactive API access using refresh tokens