Get applicant data with Custom CSV Export
Get applicant data for in-depth analytics, auditors and regulators, additional quality control checks, and many more.
Custom CSV Export allows you to get large volumes of data about applicants who pass identity verification.
How Custom CSV Export works
The process of generation of a custom CSV export includes the following steps:
- A Sumsub client opens the Individual applicants page and ensures that they have access to the Custom CSV Export feature.
- If there is appropriate permission granted to the profile, they click the Custom CSV Export button and select the profiles and data to export.
- Once done, Sumsub starts the report generation and redirects the client to the report page.
- The client reviews the report details and status.
- The client receives a notification of the readiness and downloads the report.
Benefits
The Custom CSV Export brings the following advantages:
- Ability to export a broad range of applicant information.
- Option to choose which data to export.
- Flexible permission system that allows you to restrict sensitive data exports.
- Support for exporting large volumes of data.
- Export history is maintained for up to 30 days.
Use cases
Exporting applicant data might be helpful within many business processes, such as:
- Performing analytics and statistics, gaining a more in-depth understanding of applicants, and segmenting data.
- Creating reports and calculations for marketing purposes.
- Preparing data and reports for auditors and regulators.
- Importing data into your system to automate internal processes.
- Conducting additional quality control checks on your side.
Applicant Data available for Custom CSV export
All data is divided into two groups — sensitive and non-sensitive. This separation allows us to manage access to particular information using different permissions.
| Data | Group |
|---|---|
|
General |
|
|
applicantId |
Not sensitive |
|
applicantPlatform |
Not sensitive |
|
applicantStatus |
Not sensitive |
|
clientId |
Not sensitive |
|
createdAt |
Not sensitive |
|
deactivated |
Not sensitive |
|
externalUserId |
Not sensitive |
|
inspectionDate |
Not sensitive |
|
inspectionResetDate |
Not sensitive |
|
language |
Not sensitive |
|
levelName |
Not sensitive |
|
questionnaires |
Not sensitive |
|
requiredIdDocSetTypes |
Not sensitive |
|
sourceKey |
Not sensitive |
|
tags |
Not sensitive |
|
type |
Not sensitive |
|
Applicant personal info |
|
|
addressState |
Sensitive |
|
age |
Sensitive |
|
ageAtVerification |
Sensitive |
|
country |
Sensitive |
|
countryOfBirth |
Sensitive |
|
dateOfBirth |
Sensitive |
|
|
Sensitive |
|
firstName |
Sensitive |
|
firstNameEn |
Sensitive |
|
ipCountry |
Sensitive |
|
gender |
Sensitive |
|
lastName |
Sensitive |
|
lastNameEn |
Sensitive |
|
middleName |
Sensitive |
|
middleNameEn |
Sensitive |
|
nationality |
Sensitive |
|
phone |
Sensitive |
|
placeOfBirth |
Sensitive |
|
stateOfBirth |
Sensitive |
|
tin |
Sensitive |
|
Review info |
|
|
reviewStatus |
Not sensitive |
|
reviewAnswer |
Not sensitive |
|
reviewRejectType |
Not sensitive |
|
rejectLabels |
Not sensitive |
|
buttonIds |
Not sensitive |
|
reviewCreateDate |
Not sensitive |
|
reviewDate |
Not sensitive |
|
ID doc info |
|
|
idDocTypes |
Not sensitive |
|
idDocCountries |
Not sensitive |
|
lastPoiCountry |
Not sensitive |
|
lastPoiDate |
Sensitive |
|
lastPoiId |
Not sensitive |
|
lastPoiIdDocType |
Not sensitive |
|
lastPoiImageId |
Not sensitive |
|
PoA doc info |
|
|
lastPoaCountry |
Not sensitive |
|
lastPoaDate |
Sensitive |
|
lastPoaId |
Not sensitive |
|
lastPoaIdDocType |
Not sensitive |
|
lastPoaImageId |
Not sensitive |
|
Risk labels |
|
|
riskLabelsAml |
Not sensitive |
|
riskLabelsCrossCheck |
Not sensitive |
|
riskLabelsDevice |
Not sensitive |
|
riskLabelsEmail |
Not sensitive |
|
riskLabelsPerson |
Not sensitive |
|
riskLabelsPhone |
Not sensitive |
|
riskLabelsSelfie |
Not sensitive |
Technical limitations of Custom CSV Export feature
Custom CSV Export has some specific technical characteristics regarding the data retention period and filters that should be considered while using the feature.
Mismatch between filtered and exported entries
The number of exported applicant profiles may differ from the number of filtered entries in the Dashboard. This discrepancy is usually caused by the following reasons:
- Applying a specific period of time. The Period filter operates differently in the Dashboard and Custom CSV Export. In the Dashboard, your local time zone is generally used, while the export feature uses the UTC time zone (UTC+0). Therefore, the applicant lists may vary.
- Using unsupported filters. Some filters are not supported in Custom CSV Export, so applicants intended to be removed might be mistakenly included in the export.
Data retention period
All reports are stored for 30 days and are available for download during this time. The availability period of a report can be found on its page. After this period, reports are permanently deleted, and access to them is completely lost.
Search unavailability
You cannot use the search bar to find applicant profiles while using the Custom CSV Export feature. Instead, use the applicant filters located under the search bar.
Limitations of filters
Before you create a custom CSV export, you sort applicants via filters that are available on the Applicants page.
The feature supports almost all filters listed on the page. However, there are minor inconsistencies in how the filters operate when you use them for creating a CSV report.
|
Filter Name |
Description |
|---|---|
|
Period |
On the applicant list page, the Period filter is based on the When the period is set in the Dashboard, the list of applicants is displayed according to the user’s local time zone. In contrast, the Custom CSV Export feature uses the UTC time zone (UTC+0) to ensure consistency across all exports. As a result, the number of entries shown in the Dashboard and the number of entries in the exported file may differ for a specific user. |
|
Tags |
The Dashboard filter allows filtering applicants by their Tags or by the value of The export filter operates in the same manner. |
|
Risk labels |
This filter is not supported by the Custom CSV Export feature. Some entries might be mistakenly included in the export. |
|
Reuse scope |
This filter is not supported by the Custom CSV Export feature. Some entries might be mistakenly included in the export. |
|
Linked to company |
This filter is not supported by the Custom CSV Export feature. Some entries might be mistakenly included in the export. |
Enable Custom CSV Export notifications
Each account in the Sumsub Dashboard has its notification settings, which determine the information the account can receive.
You can enable the Custom CSV Export notifications by doing the following:
- Open the Dashboard and click the Profile icon in the upper-right corner.
- Select Profile settings.
- Navigate to the Notifications tab.
- Find Custom CSV export notifications and set up how you want to receive the alerts.
The Custom CSV Export notifications are sent when the report is ready and contain a link to the report page.
Configure Custom CSV Export permissions
To allow your team to create custom CSV exports via the Dashboard, you should grant them access using the following permissions:
- Custom CSV export (Lower sensitive data) (downloadAnonymousApplicantReport)
Allows to export data that is not classified as sensitive. - Custom CSV export (Higher sensitive data) (downloadSensitiveApplicantReport)
Allows to export of all types of data, including sensitive ones.
These are the steps to be taken to manage the roles and give access to the feature:
- In the Dashboard, go to Settings and select Team.
- Navigate to Roles.
- Select a role or create a new one.
- Choose one of the permissions listed above. If you do not have these permissions in the list, contact the admin of your key, so they can set it up for you.
- Besides the mentioned permissions, include two permissions that give access to the list of applicants and their personal data:
- See list of applicants
- See applicant’s personal data
Note
We recommend granting permission to export sensitive data only to a very limited group of individuals.
Who has access to Custom CSV reports
Access to the report is granted exclusively to the account that requested it. The report will not be accessible via a direct link, even if the users are on the same key and possess the full set of necessary permissions.
Restrict creating Custom CSV exports
There are additional settings that can be applied to the Dashboard profiles to impose limits on using the Custom CSV Export feature:
- The See only sandbox environment data access limitation. The access limitations are set in Roles.
- The See only those applicants that are created by this account, or via a link that this account generated account limitation.
- Available source key values based on the specified restrictions in Source Key Restrictions.
- The Hide approved applicants for this account access limitation.
Export applicant data
To create a custom CSV export:
- In the Dashboard, navigate to the list of applicants and find the Custom CSV Export button in the upper-right corner of the page. If you can see the button, it means that you have been granted appropriate permissions.
- Sort applicants using the filters on the page. Note that some filters may work differently when you create a CSV report.
- When filtered, select which profiles to export:
- To export specific profiles from the filtered list, check the box to the left of the applicant’s name.
- To export all profiles, no action is required.
- Click the Custom CSV Export button to Initiate the process of creating the report. You will be asked to select the data to be exported. The set of fields can be modified and the system will remember selection on your device.
- (Only applicable to users with 2FA enabled) Complete two-factor authentication by entering the code.
- Review information on the report and its status. Once you have selected the data for export, Sumsub starts the report generation and redirects you to the page where you can find all the details regarding your report:
- Report Name. The name of your report.
- Current Status. The status of your report. The possible statuses are: Requested, Completed, Failed.
- Availability Period. Information on how many days the report will remain available for download.
- Download Button. This button is available once your report is ready.
- Report Information. Information on the author (user who requests a report), generation date, report type, file size, and number of entries.
- Filters Used. The filters that have been applied to generate the report.
- Report Columns. The columns that are included in the report.
- Delete report Button. The button for deleting reports.
- When you receive a notification of the readiness, download the report—follow the link and download an archive containing the report (CSV) and the separate file with its settings.
View available reports
You can find all the reports you have access to (including those generated by you within the last 30 days) on the dedicated Reports page. On this page, you can view and download reports from the list.
Updated 3 days ago