Skip to content
Connect API Catalog/
/
/
Update An Individual AML...

Update An Individual AML Search By SearchID

Request

Updates an Individual AML Search by Search Id.

Security
bearerToken
Path
searchIdstring, (uuid)required

search id to update

Bodyapplication/json
assignedToUserIdinteger, (int32)

Id of the User to assign to the Search

statusstringrequired

Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed.

riskRatingstringrequired

Risk rating of the Search and allowed values notApplicable,veryLow,low,medium,high and veryHigh

notestring

Note associated with the search

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals/{searchId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignedToUserId": 0,
    "status": "string",
    "riskRating": "string",
    "note": "string"
  }'

Responses

Success

Bodyapplication/json
idstring, (uuid)

Id of the search

namestring

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

countryCodesArray of strings

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

statusstring

Status of the search

riskRatingstring

The risk rating being assigned to the profile

Enum:"notApplicable""veryLow""low""medium""high""veryHigh"
assignedToUserIdinteger, (int32)

Id of the user assigned to the search

assignedUserstring

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

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

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

middleNamestring

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

lastNamestring

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

genderstring

Gender provided in the search

dateOfBirthstring, (date)

DOB provided in the search

pepTiersArray of strings

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
correlationIdstring

A unique ID assigned to this request.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "countryCodes": [
    "string"
  ],
  "threshold": 0,
  "type": "string",
  "datasets": [
    "string"
  ],
  "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,
  "correlationId": "string"
}