Return Audit Trail

Request

Returns a list of audits which can be filtered by various categories.

Security

bearerToken

Query

profileIdsArray of strings

Select the profileId's for the filter.

categoriesArray of strings

Available categories for the filter.

Items Enum:"profile""amlSearch""settings""uploads""bulkImport""team"

subcategoriesArray of strings

Available subcategories for the filter.

Items Enum:"profileDetails""keyParty""amlMonitoring""profile""searchHit""preferences""emailPreferences"

actionsArray of strings

Available actions for the filter.

Items Enum:"created""updated""deleted""searchRemoved""searchLinked""attachmentCreated""attachmentUpdated""attachmentDeleted""noteCreated""noteUpdated"

userIdsArray of integers

User Ids for the filter.

startDatestring, (date)

Start date for the filter.

endDatestring, (date)

End date for the filter.

pageinteger

Starting page number.

Default:1

Example:page=1

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Example:pageSize=10

X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/audits?profileIds=string&categories=profile&subcategories=profileDetails&actions=created&userIds=0&startDate=2019-08-24&endDate=2019-08-24&page=1&pageSize=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

Bodyapplication/json

itemsArray of objects

The audit entries on this page.

totalSizeinteger

Total number of audits

correlationIdstring

Correlation Id for the request

Response

{
  "items": [
    { … },
    { … }
  ],
  "totalSize": 141,
  "correlationId": "a080e3d7-fc64-4445-a840-5a740f2276db"
}