Execute An AML Search For A Business And Saves The Results To The Database

Request

A request requires a name, at least one valid dataset, and a threshold. User will be deducted 1 credit for each AML search.

Security

bearerToken

Bodyapplication/jsonrequired

countryCodesArray of strings

List of Two-letter country code ISO-3166-2.

thresholdinteger, (int32)required

Hits with scores below the chosen value will not be shown.
Must be one of 75, 80, 85, 90, 95, or 100

sanctionBodiesArray of integers or null

Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.

namestringrequired

Name of the business to be searched.
Example - Google Inc
Max 200 characters allowed.

datasetsArray of stringsrequired

Specifies which datasets will be searched

PEP - Politically Exposed Persons (All)
PEP-LINKED - Only linked PEPs (PEP by Association)
SAN - Sanctioned (All)
SAN-CURRENT - Only current Sanctions
SAN-FORMER - Only former Sanctions
INS - Insolvency
AM - Adverse Media
POI - Profile of Interest
ENF - Enforcement
SOE - State Owned Enterprises (All)
SOE-CURRENT - Only current SOE
SOE-FORMER - Only former SOE

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/businesses \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "countryCodes": [
      "string"
    ],
    "threshold": 0,
    "sanctionBodies": [
      0
    ],
    "name": "string",
    "datasets": [
      "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

Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high AND 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

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": "string",
  "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,
  "correlationId": "string"
}