get https://api.sumsub.com/resources/auditTrailEvents/
Returns audit trail events.
Overview
Use this method to get raw audit trail events for your employees.
Attention
The Audit trail events feature comes at an additional cost. To enable this feature, contact us.
Note
- Events are always sorted by
tsin a descending order.- The maximum number of events per request is 20000.
Response explained
The HTTP status 200 in the response confirms the availability of our API:
| Name | Type | Optional | Description |
|---|---|---|---|
ts | String | No | Date/time. |
clientId | String | No | Key. |
activity | String | No | Event type. |
subjectName | String | No | The subject that executed the action. |
ip | String | No | IP from which the event was detected. |
userAgent | String | Yes | userAgent from which the event was detected. |
xClientId | String | Yes | API / dashboard / SDK. |
correlationId | String | No | Internal ID for investigating requests. |
applicantId | String | Yes | An unique applicant identifier. |
externalUserId | String | Yes | An unique applicant identifier on the client side. |
imageId | String | Yes | A unique document identifier. |
description | String | Yes | Additional information. |
Event types
| Name | Description |
|---|---|
subject:loggedIn:dashboard:success | User successfully logged in to the Dashboard. |
subject:loggedIn:dashboard:failure | User failed to log in to the Dashboard. |
subject:loggedOut:dashboard | User logged out of the Dashboard. |
subject:changed:applicant | User changed the applicant. Event duplicates Activity.USER_CHANGED_APPLICANT. |
subject:loaded:applicant | User loaded an applicant page in the Dashboard. |
subject:loaded:applicantList | User loaded a page with a list of applicants in the Dashboard. Also can be an applicant page if cnt=1. |
subject:exported:applicantCsvList | User exported an applicant list under filters as CSV. |
subject:downloaded:docImage | User downloaded an image on an applicant page (only by manually clicking the download button). There are other ways to download the image without triggering this event. Event duplicates {@link TrackingActivityType.SUBJECT_DOWNLOADED_DOC_IMAGE}. |
subject:changed:applicantLevel | User changed applicant level settings. E.g. created a new one, or deleted the existing one, changed the steps, and so on. |
subject:changed:questionnaire | User changed questionnaire settings. E.g. added a new question or deleted the existing one. |
subject:changed:globalSettings | User changed global settings. E.g. recognition settings or allowed duplicates. |
subject:changed:flow | User changed flow settings. E.g. added, updated, or deleted any flow in the UI in: Integrations -> Customizations. |
subject:changed:licenseKey | User changed license key. E.g. created, updated, or deleted the license key in the UI in: Integrations -> Global Settings -> Source Keys. |
subject:changed:poaStepSettings | User changed PoA step settings. E.g. created, updated, or deleted settings in the UI in: Integrations -> Global Settings -> User verification -> Proof of Address. |
subject:changed:dictionary | User changed one of the dictionaries (MobileSDK, WebSDK, Common etc.). E.g. created or updated dictionary in the UI in: Integrations -> SDK Translations. |
subject:changed:paymentMethodDefinitions | User changed payment methods settings. E.g. created, updated, or deleted one of the payment method definitions in the UI in: Integrations -> Payment methods. |
subject:modified:workflowRevision | User changed workflow revision. E.g. changed workflow in the UI in: Integrations -> Applicant workflows. Event duplicates {@link TrackingActivityType#SUBJECT_MODIFIED_WORKFLOW_REVISION}. |
subject:published:workflowRevision | User published workflow revision. E.g. published workflow in the UI in: Integrations -> Applicant workflows. Event duplicates {@link TrackingActivityType#SUBJECT_PUBLISHED_WORKFLOW_REVISION}. |
subject:archived:workflowRevision | User archived workflow revision. E.g. archived workflow in the UI in: Integrations -> Applicant workflows. Event duplicates {@link TrackingActivityType#SUBJECT_ARCHIVED_WORKFLOW_REVISION}. |
subject:changed:autoCheck | User changed auto check settings. E.g. created, updated, or deleted auto check in the UI in: Admin Area -> Auto-checks. |
subject:created:appToken | User created an app token in the UI in: Dev space -> App tokens. |
subject:deleted:appToken | User deleted app token in the UI in: Dev space -> App tokens. |
subject:modified:user | Modify parameters for the user. |
subject:deleted:user | Delete user. |
subject:reset:password | Password has been reset via the Dashboard or link. |
subject:modified:2fa | Modify 2-factor authentication key into the system. |