Update A Business AML Search By Search Id

Request

Updates a business AML search.

Security

bearerToken

Path

searchIdstringrequired

Id of the search

Bodyapplication/json

assignedToUserIdinteger, (int32)

Id of the User to assign to the Search

statusstring

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

riskRatingstring

Risk rating of the Search. Available values are 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/businesses/{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. Available values are new, approved, declined, pending, cancelled, referred and closed.

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

scheduleIdstring, (uuid)

Schedule Id linked to 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

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",
  "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  "totalHitCount": 0,
  "truePositiveHitsCount": 0,
  "falsePositiveHitsCount": 0,
  "undecidedHitsCount": 0
}