Skip to main content

Whitelist monitoring checks

Requirements
  • API key
  • Services enabled on your environment (done by iDenfy's staff)
  • Finances
whitelist monitoring check

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/add-whitelist

Add AML checks to the whitelist for a monitored user or company​

You can add specific AML checks to the whitelist for a monitored user. AML checks in the whitelist won't be counted as suspected upon detection.

The request must contain JSON with whitelist and one of three identifiers: monitoringId, scanRef or name and surname (nationality and dateOfBirth can also be added.)

whitelist| Type: List
Explanation:

List of whitelisted sanction and suspicions. Possible values: SANCTION, INTERPOL, PEPS, OTHER.

type| Type: String
Explanation:

Specifies whether the entity is a company or a person. Possible values: COMPANY, PERSON.

monitoringId| Type: String
Explanation:

A unique string identifying a monitored user.

scanRef| Type: String
Explanation:

A unique string identifying a client verification on iDenfy’s side.

name| Type: String
Explanation:

Name of the monitored user.

surname| Type: String
Explanation:

Surname of the monitored user.

nationality| Type: String
Explanation:

Nationality of the monitored user.

dateOfBirth| Type: String
Explanation:

Monitored user's date of birth.

Request example - monitoringId​

{
  "monitoringId": "OVXVXHLL43",
  "whitelist": { "PEPS": ["ListNumber"], "gb_hmt_sanctions": ["entity_id"] }
}

Request example - scanRef​

{
  "scanRef": "33a5d432-2414-11f0-90d9-46d45f940143",
  "whitelist": { "PEPS": ["ListNumber"], "gb_hmt_sanctions": ["entity_id"] }
}

Request example - data​

{
  "name": "name",
  "surname": "surname",
  "nationality": "LT",
  "dateOfBirth": "1999-12-31",
  "whitelist": { "PEPS": ["ListNumber"], "gb_hmt_sanctions": ["entity_id"] }
}

Request example - company​

{
  "name": "Company's name",
  "whitelist": { "gb_hmt_sanctions": ["entity_id"] }
}
{
  "monitoringId": "monitoringId",
  "whitelist": { "PEPS": ["ListNumber"] }
}

Removing entries from whitelist​

remove checks from whitelist

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/clear-user-whitelist/

To remove whitelists from monitoring you need to simply pass monitoringId. All whitelists will be removed from such monitoring.

Request example​

{
  "monitoringId": "monitoringId"
}

A successful API call returns an HTTP response with status 200.