Scopes
Police checks
The following scopes are available for the Consumer API:
police.create
— Create new police checkspolice.read
— List and read details of existing police checkspolice.results
— Download police check results and metadatapolice.email
— Trigger sending of email reminders or email results to candidatespolice.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 checksrtw.read
— List and read details of existing rtw checksrtw.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 checksidentity.read
— List and read details of existing identity checksidentity.results
— Download identity check resultsidentity.delete
— Delete (cancel) identity checkidentityrulesets.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 siteswhitelabelsites.billingcodes.read
— List and read co-branded billing codeswhitelabelsites.billingcodes.write
— Create/modify co-branded billing codeswebhooks.read
— List and read details of webhook registrationswebhooks.create
— Create new webhook registrationswebhooks.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