Return Individual AML Search By Search Id

Connect API Catalog/

Return Individual AML Search By Search Id

Request

Returns a single AML Search based on searchId.

Security

bearerToken

Path

searchIdstring, (uuid)required

search id to fetch

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals/{searchId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstring, (uuid)

Id of the search

namestring or null

Name provided for the search. Length must not exceed 200 characters

countryCodesArray of strings or null

Countries provided to the search

thresholdinteger, (int32)

Hits with scores below this value will not be shown.

typestring

Indicates whether search type is individual or business

datasetsArray of strings

Provided datasets for the search

sanctionBodiesArray of integers or null

Provided sanctionBodies for the search

statusstring

Status of the search

riskRatingstring

The risk rating being assigned to the profile

Enum:"notApplicable""veryLow""low""medium""high""veryHigh"

assignedToUserIdinteger or null, (int32)

Id of the user assigned to the search

assignedUserstring or null

Name of the user assigned to the search

createdByIdinteger, (int32)

Id of the user who created the search

createdBystring

Name of the user who created the search

createdAtstring, (date-time)

Search created date time

modifiedByIdinteger, (int32)

Id of the user who modified the search

modifiedBystring

Name of the user who modified the search

modifiedAtstring, (date-time)

Search modified date time

notestring or null

Note associated with the search

totalHitCountinteger, (int32)

Total number of hits in the search

truePositiveHitsCountinteger, (int32)

The number of true-positive hits in the search

falsePositiveHitsCountinteger, (int32)

The number of false-positive hits in the search

undecidedHitsCountinteger, (int32)

The number of undecided hits in the search

firstNamestring or null

First name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters

middleNamestring or null

Middle name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters

lastNamestring or null

Last name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters

genderstring or null

Gender provided in the search

dateOfBirthstring or null, (date)

DOB provided in the search

pepTiersArray of strings or null

Pep Tiers provided in the search

scheduleIdstring or null

Schedule Id linked to the search

isDobRequiredboolean or null

Indicates whether date of birth is required for the individual search.

Default:true

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "countryCodes": [
    "string"
  ],
  "threshold": 0,
  "type": "string",
  "datasets": [
    "string"
  ],
  "sanctionBodies": [
    0
  ],
  "status": "string",
  "riskRating": "notApplicable",
  "assignedToUserId": 0,
  "assignedUser": "string",
  "createdById": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "note": "string",
  "totalHitCount": 0,
  "truePositiveHitsCount": 0,
  "falsePositiveHitsCount": 0,
  "undecidedHitsCount": 0,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "dateOfBirth": "2019-08-24",
  "pepTiers": [
    "string"
  ],
  "scheduleId": "string",
  "isDobRequired": true
}