# Return Compliance Kyc Protect Searches Results

Returns a list of all performed searches, including details such as ID, name, type, risk rating, datasets, creation and assignment information, and PEP tier. Supports filters such as search type, keyword, dataset, threshold, PEP tier, and scheduled status.

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

## Query parameters:

  - `IsScheduled` (boolean)
    Filter searches by scheduled status. Defaults to false if not specified.

  - `SearchType` (string)
    Filter searches by type (e.g., Individual, Business)
    Enum: "individual", "business"

  - `SearchTerm` (string)
    Filter searches by search term

  - `Datasets` (array)
    Filter searches by specific datasets

  - `Thresholds` (array)
    Filter searches by specific thresholds

  - `PepTiers` (array)
    Filter searches by PEP tiers
    Enum: "pepTier1", "pepTier2", "pepTier3", "byAssociation"

  - `page` (integer, required)
    The page number to fetch. Should be a positive integer.

  - `pageSize` (integer, required)
    Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

## Response 200 fields (application/json):

  - `totalSize` (integer)

  - `items` (array)

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

  - `items.name` (string,null)
    Name provided for the search. Length must not exceed 200 characters

  - `items.countryCodes` (array,null)
    Countries provided to the search

  - `items.threshold` (integer)
    Hits with scores below this value will not be shown.

  - `items.type` (string)
    Indicates whether search type is individual or business. Available values are individual, business.

  - `items.datasets` (array)
    Provided datasets for the search

  - `items.sanctionBodies` (array,null)
    Provided sanctionBodies for the search

  - `items.status` (string)
    Status of the search. Available values are new, approved, declined, pending, cancelled, referred, closed.

  - `items.riskRating` (string)
    Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high, veryHigh.

  - `items.assignedToUserId` (integer,null)
    Id of the user assigned to the search

  - `items.assignedUser` (string,null)
    Name of the user assigned to the search

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

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

  - `items.createdAt` (string)
    Search created date time

  - `items.modifiedById` (integer)
    Id of the user who modified the search

  - `items.modifiedBy` (string)
    Name of the user who modified the search

  - `items.modifiedAt` (string)
    Search modified date time

  - `items.note` (string,null)
    Note associated with the search

  - `items.scheduleId` (string,null)
    Schedule Id linked to the search

  - `items.totalHitCount` (integer)
    Total number of hits in the search

  - `items.truePositiveHitsCount` (integer)
    The number of true-positive hits in the search

  - `items.falsePositiveHitsCount` (integer)
    The number of false-positive hits in the search

  - `items.undecidedHitsCount` (integer)
    The number of undecided hits in the search

  - `items.firstName` (string,null)
    First name of individual provided in the search.
The combination of first name, middle name, and last name must not exceed 200 characters

  - `items.middleName` (string,null)
    Middle name of individual provided in the search.
The combination of first name, middle name, and last name must not exceed 200 characters

  - `items.lastName` (string,null)
    Last name of individual provided in the search.
The combination of first name, middle name, and last name must not exceed 200 characters

  - `items.gender` (string,null)
    Gender of individual provided in the search. Available values are male, female.

  - `items.dateOfBirth` (string,null)
    DOB of individual provided in the search

  - `items.pepTiers` (array,null)
    Pep Tiers provided in the search of individual. Available values are pepTier1, pepTier2, pepTier3, byAssociation

  - `items.isDobRequired` (boolean,null)
    Indicates whether date of birth is required for the individual search.

## 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"