Every Identities check needs a configuration. A configuration defines the requirements for an Identity Verification or Face Authentication journey, and you create and manage configurations in the Dashboard.
After you create an Identity Verification configuration, use its configuration ID, prefixed with usj_, when you create a check through the API.
How it works
- Create an Identity Verification configuration.
- Create a Face Authentication configuration.
- View your configurations.
- Update or archive a configuration.
- Manage your themes.
Before you begin
Note
Ensure that you have the Admin role, the Identities manager role, or a custom role with the Process identities checks and manage configurations permission. To view configurations without changing them, a custom role with the View identities checks and data permission is enough.
Decide the following before you start:
- The entity you're creating the configuration for.
- The processing type you want to use.
- The ID documents, identity fields, translations, and theme details you want to apply.
Create an Identity Verification configuration
You can create an Identity Verification configuration in the Dashboard:
- Sign in to the Dashboard.
- Go to Identities > Configurations.
- Select Create configuration.
- Select Identity Verification.
- On the Configuration details page:
- Select the relevant entity.
- Enter a name for the configuration.
- Select the processing type: Fast or Expert.
- Select Continue.
- On the Accepted documents page, select the ID documents you want to accept for each region, and then select Continue.
- On the Extracted information page, select the fields you want to capture from ID documents, and then select Continue. The available fields are listed below.
- On the Translations page, keep the default translations, or select Edit to add custom translations.
- On the Themes page, keep the default theme, or create and apply a custom theme.
- Review the configuration, and then select Create configuration.
Fields you can extract from ID documents
The Extracted information page groups the fields you can capture into three sections:
- Identity – required fields include date of birth, first name, full name, and tax identification number. Optional fields include gender, nationality, and place of birth.
- Document – optional fields include expiry date, issue date, issuing country, machine-readable zone, number, and type.
- Permit – optional fields include expiry date, obtaining date, remarks, and type.
Note
Some document fields are always required, so you cannot deselect them.
Success state
The configuration appears on the Configurations page. Record the configuration ID if you plan to create checks through the API.
Create a Face Authentication configuration
A Face Authentication configuration uses the same flow, without the accepted documents and extracted information steps:
- Sign in to the Dashboard.
- Go to Identities > Configurations.
- Select Create configuration.
- Select Face Authentication.
- On the Configuration details page:
- Select the relevant entity.
- Enter a name for the configuration.
- Select the processing type: Auto or Expert.
- Select Continue.
- Complete the Translations and Themes pages in the same way as an Identity Verification configuration.
- Select Create configuration.
Success state
The Face Authentication configuration appears on the Configurations page.
View your configurations
You can search and filter every configuration you have access to in the Dashboard:
- Sign in to the Dashboard.
- Go to Identities > Configurations.
- Search or filter the configurations by:
- Configuration name.
- Entity.
- Configuration status.
- Configuration ID.
- Check type.
- Processing type.
- Created date.
- Last updated date.
Success state
The Configurations page lists the configurations that match your search or filters.
Update or archive a configuration
To update or archive a configuration, you need the Process identities checks and manage configurations permission:
- Sign in to the Dashboard.
- Go to Identities > Configurations.
- Search for the configuration you want to change.
- Select the overflow menu, and then select Edit.
- Make your changes, and then select Save and exit.
To archive a configuration instead, select Archive from the overflow menu. To review a configuration's edit history, select View change log from the overflow menu.
Success state
Your changes are saved, the configuration is archived, or the change log is displayed, depending on the action you selected.
Manage your themes
A theme controls how your Identity Verification and Face Authentication journeys look. You can edit or archive a theme in the Dashboard:
- Sign in to the Dashboard.
- Go to Identities > Themes.
- Search for the theme you want to change.
- Select the overflow menu, and then select Edit.
- Make your changes, and then select Save and exit.
To archive a theme instead, select Archive from the overflow menu. To review a theme's edit history, select View change log from the overflow menu.
Success state
Your changes are saved, or the theme is archived.
Where to go next
To understand how configurations fit into an Identity Verification journey, see Verify identities.
For Face Authentication, see Authenticate with biometrics.
If you cannot see the Configurations page, or a configuration does not behave as you expect, contact your account manager or request support. If you are still testing in Sandbox, contact your solution engineer instead.