Audit Logs

Track all important actions using our rich audit logs.

An audit log object provides information about the action and user that initiated the changes and the old and new values, where applicable.

The API allows you to retrieve audit logs for a given client, action, resource, or trigger.

The Audit Log object

Attributes

Attribute	Type	Description
id	string	The unique identifier for an audit log.
memberId	string	The team member whose actions triggered the audit log creation.
resourceType	string	The type of audited resource. Valid values include: client address document check
resourceId	string	The id of the audited resource.
clientId	string	The id of the client associated with the audited resource.
trigger	string	The event that triggered the audit log creation, e.g. updateClient.
action	string	The type of action. Possible values are: create update delete
diff	array[object]	The diff between the old and new values of the audited resource. Also, see the diff object below.
createdAt	string	The date and time when the audit log was created.

Sample Object

{
    "id": "5f2acdcebbddb422f9b60e7b",
    "memberId": "VNARgK33nMASdJKdi",
    "resourceType": "client",
    "resourceId": "5f2aca5fbbddb422f9b60e79",
    "clientId": "5f2aca5fbbddb422f9b60e79",
    "trigger": "updateClient",
    "action": "update",
    "diff": [
        {
            "action": "update",
            "path": [
                "personDetails",
                "firstName"
            ],
            "old": "Joe",
            "new": "John"
        },
        {
            "action": "new",
            "path": [
                "personDetails",
                "dob"
            ],
            "new": "1969-09-23"
        },
        {
            "action": "new",
            "path": [
                "personDetails",
                "nationality"
            ],
            "new": "US"
        },
        {
            "action": "update",
            "path": [
                "updatedAt"
            ],
            "old": "2020-01-01T15:03:59.913Z",
            "new": "2020-01-01T15:18:38.273Z"
        },
        {
            "action": "new",
            "path": [
                "lastActionBy"
            ],
            "new": "VNARgK33nMASdJKdi"
        }
    ],
    "createdAt": "2020-01-01T15:18:38.347Z"
}

The diff object

Attribute	Type	Description
action	string	Indicates the kind of change. Possible values are: new - indicates a newly added attribute/element. delete - indicates an attribute/element was deleted. update - indicates an attribute/element was updated. add - indicates a change occurred within an array.
path	array[string]	The left-to-right path of the attribute in the audited resource e.g. ['personDetails', 'firstName'] indicates that firstName within the personDetails object is the attribute affected by the action.
old	string	The old value of the audited attribute.
new	string	The new value of the audited attribute. When action is new, the type of new is object rather than string