# Return Audit Trail

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

Endpoint: GET /compliance/kyc-protect/audits
Version: 1.10.9
Security: bearerToken

## Query parameters:

  - `profileIds` (array)
    Select the profileId's for the filter.

  - `categories` (array)
    Available categories for the filter.
    Enum: "profile", "amlSearch"

  - `subcategories` (array)
    Available subcategories for the filter.
    Enum: "profileDetails", "keyParty", "amlMonitoring"

  - `actions` (array)
    Available actions for the filter.
    Enum: "created", "updated", "deleted", "searchRemoved", "searchLinked", "attachmentCreated", "attachmentUpdated", "attachmentDeleted", "noteCreated", "noteUpdated", "noteDeleted", "noteArchived", "noteUnarchived", "addressCreated", "addressUpdated", "addressDeleted", "kycStatusUpdated", "addedToAmlMonitoring", "updatedInAmlMonitoring", "removedFromAmlMonitoring"

  - `userIds` (array)
    User Ids for the filter.

  - `startDate` (string)
    Start date for the filter.

  - `endDate` (string)
    End date for the filter.

  - `page` (integer)
    Starting page number.

  - `pageSize` (integer)
    Number of items to return per Page.

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    Id of the Audit

  - `items.description` (string)
    Description of the Audit

  - `items.category` (string)
    Category of the audit
    Enum: "profile", "amlSearch"

  - `items.subcategory` (string,null)
    Subcategory of the audit
    Enum: "profileDetails", "keyParty", "amlMonitoring"

  - `items.action` (string)
    Action of the audit
    Enum: "created", "updated", "deleted", "searchRemoved", "searchLinked", "attachmentCreated", "attachmentUpdated", "attachmentDeleted", "noteCreated", "noteUpdated", "noteDeleted", "noteArchived", "noteUnarchived", "addressCreated", "addressUpdated", "addressDeleted", "kycStatusUpdated", "addedToAmlMonitoring", "updatedInAmlMonitoring", "removedFromAmlMonitoring"

  - `items.createdAt` (string)
    Audit created date and time

  - `items.createdById` (integer)
    Id of the user who created the audit

  - `items.createdBy` (string)
    Name of the user who created the audit

  - `items.payload` (object)
    The  property represents the state of involved entities at the time of action taking place. This property contains dynamic data that varies depending on the request parameters and the context of the request. The response and can differ even with the same parameters under different conditions or contexts. This means the content of this property is not fixed and can include various data types such as GUIDs, strings, integers, and complex objects. Due to its dynamic nature, the  can include any of the following potential structures, but is not limited to these examples   A single key-value pair where thecvalue is a string or number.   A nested object containing detailed data structures.   An array of objects each with different attributes.  Consumers of this API should handle the  dynamically and be prepared to encounter different data types and structures. Detailed processing logic based on the specific application needs and context checks is recommended when utilising this field.
    Example: {"companyId":"GB-0-0123456789","profileId":"12345f68-1234-1234-1a2b-1a12bb4c578","safeNumber":"UK0122345678","profileName":"Example Profile"}

  - `totalSize` (integer)

  - `correlationId` (string)

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected