# Background Checks Configuration Module {{}} The Background Checks Configuration Module is an interface that allows you to configure global settings for all checks in your account and manage custom check types per country. This module gives you full autonomy to customize your background checks configurations without needing to contact support or use the API. This module provides a user-friendly interface for configurations that can also be done programmatically via API. For API-based configuration, see [Configure Background Checks Parameters (API)](/guides/checks_setting/) and [Create a Custom Type (API)](/guides/background_check_custom_type/). Before using this module, we recommend understanding the basic concepts of [Background Checks](/guides/understading_background_checks/), [Datasets, Scores and Types](/guides/datasets_scores_types/), and how scores are calculated. ## Accessing the Configuration Module 1. Log into the [Truora Dashboard](/guides/dashboard/). 2. Navigate to the **Background Checks** product from the products view. This will redirect you to the Background Checks dashboard. 3. In the Background Checks dashboard, access the Configuration Module through the sidebar or navigation menu. 4. The Configuration Module is organized into two main tabs: - **Global Settings:** Configure settings that affect all checks in your account - **Custom Types:** Create and manage custom check types per country {{accessing checks configuration module from dashboard}} ## Global Settings The Global Settings tab allows you to configure parameters that apply to **all** background checks performed in your account. These settings help you to control checks behavior. > **Important:** Changes to Global Settings affect **ALL** checks in your account, regardless of check type or country. ### Configuration Options {{}} | Setting | Description | Options/Range | |---------|-------------|---------------| | **Retries** | Enables automatic retry of database queries when they fail | Toggle on/off | | **Name Matching Type** | Defines how strict name comparisons are when matching records | Flexible/Exact | | **Max Duration** | Maximum time a check can take to complete | 2 minutes - 168 hours (7 days) | {{
}} ### Retries When **Retries** is enabled, the system will automatically retry database queries that return an error (for example, when a data source is temporarily unavailable). The system will continue retrying until it successfully receives a response or until the **Max Duration** time expires. **Key points:** - While retries are running, the check status will appear as *"delayed"* in the dashboard - Enabling retries provides more complete results but may increase check response time - Retries are configured per account, meaning all countries and databases under the same account share the same retries configuration - For more information about check statuses and lifecycle, see [Checks Lifecycle: Deep Dive](/guides/checks_lifecycle_deep_dive/) **To configure Retries:** 1. In the Global Settings tab, locate the **Retries** toggle 2. Toggle it **on** to enable automatic retries, or **off** to disable 3. The **Save** button will appear when you make changes {{configuring retries setting}} ### Name Matching Type The **Name Matching Type** parameter defines how strictly names are compared when matching records from identity databases with records from government databases (criminal, legal, and international records). **Options:** - **Flexible (soft):** Allows names that are similar enough to be recognized as the same person. For example, "Maria Alejandra Gomez" would match "Alejandra Gomez" - **Exact (default):** Requires perfect name matches. Only instances where names are identical will be considered. For example, "Maria Alejandra Gomez" would only match "Maria Alejandra Gomez". This helps reduce the risk of homonyms > For more information about how name matching affects scores and homonyms, see the [Scores and Homonyms](/guides/datasets_scores_types/#scores-and-homonyms) section in the Datasets, Scores and Types guide. **To configure Name Matching Type:** 1. In the Global Settings tab, locate the **Name Matching Type** dropdown 2. Select either **Flexible** or **Exact** 3. The **Save** button will appear when you make changes {{configuring name matching type}} ### Max Duration The **Max Duration** parameter sets the maximum amount of time a background check can take to fetch responses. This is represented in the format **Xunits** where **X** is a number and **units** can be either *minutes* (m) or *hours* (h). For example, *25m* indicates 25 minutes, and *2h* indicates 2 hours. **Key points:** - **Max Duration** can range from 2 minutes to 7 days (168 hours) - If **Retries** is enabled, the default **Max Duration** is 48 hours - If **Retries** is disabled, the default **Max Duration** varies by country: - 3 hours for Colombia, Mexico, Peru, and Brazil - 48 hours for Chile and international searches - 72 hours for Costa Rica > For detailed timing information and country-specific defaults, see the [Configure Background Checks Parameters (API)](/guides/checks_setting/) guide. **To configure Max Duration:** 1. In the Global Settings tab, locate the **Max Duration** input field 2. Enter a value in the format **Xm** (minutes) or **Xh** (hours), where X is a number 3. Ensure the value is between 2 minutes and 168 hours (7 days) 4. If the value is invalid, an information card will appear below the input with guidance 5. The **Save** button will appear when you make changes {{configuring max duration with validation info card}} ### Saving Global Settings After making changes to any Global Settings: 1. Review your changes 2. Click the **Save** button that appears when modifications are detected 3. A confirmation message will appear once the settings are successfully saved 4. The changes will immediately apply to all new checks created in your account > **Note:** Changes to Global Settings do not affect checks that have already been completed. Only new checks will use the updated configuration. {{saving global settings}} ## Custom Types Management The Custom Types tab allows you to create, view, edit, and delete custom check types. Custom check types let you define which datasets are queried and how much each dataset contributes to the final score calculation. ### Key Concepts Before creating custom types, it's important to understand these concepts: - **Custom Types:** User-defined check configurations that determine which datasets are queried and their weight in the final score. For the API equivalent, see [Create a Custom Type (API)](/guides/background_check_custom_type/) - **Datasets:** Categories of information used to group related data sources. For a complete list of available datasets and their descriptions, see [Datasets, Scores and Types](/guides/datasets_scores_types/) - **Weights:** The percentage contribution of each dataset to the overall risk score. The total weights of all selected datasets must equal 100%. For more information on how weights affect score calculation, see the [Scores](/guides/datasets_scores_types/#scores) section - **Reserved Types:** The system includes three default check types that cannot be edited or deleted: - `person` - See [Check Type Person](/guides/check_type_person_guide/) - `company` - See [Check Type Company](/guides/check_type_company_guide/) - `vehicle` - See [Check Type Vehicle](/guides/check_type_vehicle_guide/) ### Viewing Custom Types Custom types are organized by country in collapsible cards: 1. In the Custom Types tab, you'll see country cards with flags and country names 2. Each card can be expanded to show the list of custom types for that country 3. Click on a country card to expand or collapse it 4. Custom types are listed within each country card {{viewing custom types grouped by country}} ### Viewing Custom Type Details To see the details of a custom type, including which datasets it uses and their weights: 1. Click on a custom type name in the list 2. A details panel will appear showing: - The type name - The country it applies to - A list of all datasets included in the type - The weight (percentage) assigned to each dataset {{viewing custom type details with datasets and weights}} ### Creating a Custom Type You can create custom types in two modes: **Simple Mode** (for quick setup) or **Advanced Mode** (for precise control). #### Simple Mode In Simple Mode, you select which datasets to include, and the system automatically distributes weights equally among them. 1. Click the **Create New Type** button 2. Select **Simple Mode** in the modal 3. Enter a name for your custom type (reserved names `person`, `company`, and `vehicle` are not allowed) 4. Select the country where this custom type will be available 5. Check the boxes for the datasets you want to include 6. The system will automatically calculate equal weights for all selected datasets 7. Review the configuration and click **Create** {{creating custom type in simple mode}} #### Advanced Mode In Advanced Mode, you manually set the percentage weight for each dataset. 1. Click the **Create New Type** button 2. Select **Advanced Mode** in the modal 3. Enter a name for your custom type (reserved names `person`, `company`, and `vehicle` are not allowed) 4. Select the country where this custom type will be available 5. For each dataset you want to include: - Enter a percentage value (0-100) in the weight field 6. Ensure the total of all weights equals exactly 100% 7. If the total doesn't equal 100%, a validation message will appear 8. Review the configuration and click **Create** {{creating custom type in advanced mode with manual weight assignment}} > **Note:** Available datasets vary by country. For a complete list of datasets and their availability, see [Create a Custom Type (API)](/guides/background_check_custom_type/). ### Editing a Custom Type You can edit the weights of existing custom types, but the name and country cannot be changed. 1. Select the custom type you want to edit from the list 2. Click the **Edit** button 3. The edit modal opens in **Advanced Mode** (only weights can be modified) 4. Adjust the percentage weights for each dataset 5. Ensure the total of all weights equals exactly 100% 6. Click **Save** to apply changes {{editing custom type weights}} ### Deleting a Custom Type You can delete custom types that you've created. Reserved types (`person`, `company`, `vehicle`) cannot be deleted. 1. Select the custom type you want to delete from the list 2. Click the **Delete** button 3. A confirmation modal will appear warning that this action is irreversible 4. Review the warning and confirm deletion, or cancel to keep the custom type {{deleting custom type with confirmation modal}} ### Use Case Example Here's a real-world example of how custom types can be used: **Scenario:** A ridesharing company in Mexico needs to screen drivers with a focus on safety. **Custom Type:** "Conductor Seguro MX" **Configuration:** - **Criminal Record:** 50% (Critical - highest priority for driver safety) - **Traffic Fines:** 30% (High - important for driving history) - **Credit History:** 20% (Lower - less critical but still relevant) This configuration ensures that if a candidate has criminal records, their score will drop significantly, while credit issues will have a smaller impact on the overall assessment. ### Using Custom Types in Checks Once you've created a custom type, it becomes available for use when creating background checks: - **Via Dashboard:** Custom types appear in the type dropdown when creating checks through the dashboard. See [Creating a Background Check via dashboard](/guides/checks/) for details - **Via API:** When creating checks programmatically, use the custom type name as the value for the `type` parameter. See [Creating a Background Check (API)](/guides/creating_a_background_check/) for API usage > **Note:** Custom types are country-specific. Make sure to select the appropriate country when creating a check that uses a custom type. ## Important Notes > **Warning:** Global Settings affect **ALL** checks in your account. Changes to these settings will impact every new check created after the change is saved. - **Custom types are country-specific:** Each custom type is created for a specific country and can only be used for checks in that country - **Changes don't affect completed checks:** Modifications to settings or custom types only apply to new checks. Already completed checks remain unchanged - **Reserved type names:** The names `person`, `company`, and `vehicle` are reserved for default types and cannot be used for custom types - **Dataset availability:** Not all datasets are available in all countries. Refer to [Create a Custom Type (API)](/guides/background_check_custom_type/) for the complete list of available datasets per country ## Related Documentation ### Dashboard Guides - [How to use the Dashboard](/guides/dashboard/) - General dashboard navigation - [Background Checks via dashboard](/guides/checks/) - Creating checks using custom types ### API Guides (for programmatic configuration) - [Configure Background Checks Parameters (API)](/guides/checks_setting/) - API equivalent for Global Settings - [Create a Custom Type (API)](/guides/background_check_custom_type/) - API equivalent for Custom Types ### Foundational Concepts - [Understanding Background Checks](/guides/understading_background_checks/) - Background checks basics - [Datasets, Scores and Types](/guides/datasets_scores_types/) - Understanding datasets, weights, and score calculation ### Default Check Types - [Check Type Person](/guides/check_type_person_guide/) - Person check details and usage - [Check Type Company](/guides/check_type_company_guide/) - Company check details and usage - [Check Type Vehicle](/guides/check_type_vehicle_guide/) - Vehicle check details and usage ### Creating and Using Checks - [Creating a Background Check (API)](/guides/creating_a_background_check/) - How to create checks programmatically using custom types