get https://api.sumsub.com/resources/auditTrailEvents/
Overview
Use this method to get audit logs that allow you to monitor and alert suspicious activity of your employees.
Attention
This feature is available at an additional cost. Contact us to learn more.
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 | Client 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 | A user agent from which the event was detected. |
xClientId | String | Yes | API / Dashboard / SDK. |
correlationId | String | No | Internal ID for investigating requests. |
applicantId | String | Yes | A unique applicant identifier. |
externalUserId | String | Yes | A 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 profile. |
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 the applicant list under filters as CSV. |
subject:downloaded:docImage | User downloaded the image on the applicant page (by manually clicking the Download button only). There are other ways to download the image without triggering this event. |
subject:changed:applicantLevel | User changed the applicant level settings. E.g. created a new level, or deleted the existing one, changed the steps, and so on. |
subject:changed:questionnaire | User changed the questionnaire settings. E.g. added a new question or deleted the existing one. |
subject:changed:globalSettings | User changed the global settings. E.g. recognition settings or allowed duplicates. |
subject:changed:flow | User changed the 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 the 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 the workflow revision in the UI in: Integrations -> Applicant workflows. |
subject:published:workflowRevision | User published the workflow revision in the UI in: Integrations -> Applicant workflows. |
subject:archived:workflowRevision | User archived the workflow revision in the UI in: Integrations -> Applicant workflows. |
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. |