AML Monitoring

Create AML check for users and companies

You can create AML monitoring for users and companies. They will be searched periodically until it reaches the expiration date, which is one year after entry creation. When the information about that user or company is matched with entries from AML databases, a webhook and/or email will be sent to the partner.

Sending request

To add a user to AML monitoring, send a HTTP POST request to: https://ivs.markid.eu/api/v2/add-aml-user

The request must contain basic auth headers where username is API key and password is API secret.

To add a user to AML monitoring, the request must contain JSON with scanRef of client’s verification that needs to be monitored or manually typed data, where name and surname, type set as ‘PERSON’ are required fields and nationality, dateOfBirth, monitoringId are optional.

To add a company to AML monitoring, the request must contain JSON with name, country and type set as ‘COMPANY’ monitoringId is optional.

If you’ll pass a scanRef in your request the type will automatically be counted as ‘PERSON’ regardless of the value provided in the request.

Example request with scanRef:

{
    "scanRef": "scanRef"
}

Example request with specified data:

{
    "name": "name",
    "surname": "surname",
    "dateOfBirth": "1990-01-01",
    "nationality": "LTU",
    "type": "PERSON"
}

Example request to add a company:

{
    "name": "Company's name",
    "type": "COMPANY"
}

Example responses:

A successful API call returns a JSON response with monitoringId.

An example response with all fields provided:

{
   "monitoringId": "123456789"
}

Get monitoring webhook

To receive webhook data, send a HTTP POST request to: https://ivs.markid.eu/api/v2/get-monitoring-callback With monitoring ID in the request body.

Monitoring user table

Results table

Example request:

{
   "monitoringId": "123456789"
}

Example response:

{
    "monitoringId": "123456789",
    "name": "Carl",
    "surname": "Smith",
    "nationality": "",
    "dob": null,
    "isActive": true,
    "expiration": "2022-02-02",
    "scanRefList": "[]",
    "alert_status": "DECLINED",
    "results": [
        {
            "status": {
                "serviceSuspected": true,
                "serviceUsed": true,
                "serviceFound": true,
                "checkSuccessful": true,
                "overallStatus": "SUSPECTED"
            },
            "serviceName": "PilotApiAmlV2NameCheck",
            "serviceGroupType": "AML",
            "uid": "RHO3XRYH32W4C4OAWEWHGH1TS",
            "errorMessage": null,
            "data": [
                {
                    "reason": "",
                    "listNumber": "000000",
                    "suspicion": "PEPS",
                    "isActive": true,
                    "checkDate": "2021-02-02 20:02:02",
                    "isPerson": true,
                    "score": 100,
                    "nationality": "",
                    "surname": "SURNAME",
                    "dob": "1956",
                    "lastUpdate": "2018-10-24",
                    "name": "NAME",
                    "listName": "PEPS",
                    "whitelisted": false
                }
            ]
        }
    ]
}  

companyId, beneficiaryId, comments, pepsStatus,status_set_by, status_set_at, adverseMediaStatus, and sanctionsStatus also appear in the results if the user has a company assigned to him.

Viewing entries in AML monitoring

To view a list of entries, send a HTTP GET request to: https://ivs.markid.eu/api/v2/get-aml-users

Example response:

{
    "users": [
        {
            "created": "2021-07-27 04:02:02",
            "monitoring_id": "12345678",
            "type": "PERSON",
            "name": "NAME SURNAME",
            "date_of_birth": "1956",
            "nationality": "LITHUANIA",
            "last_check_date": "2021-07-30",
            "is_active": true,
            "expiration_time": "2021-07-20",
            "alert_status": "ACCEPTED",
            "is_suspected": false,
            "whitelisted": false
        },
    ]
}

If the alert_status has “DECLINED” value, that user is not monitored anymore and the data won’t be updated further.

Deleting an entry

To delete an entry from monitoring list, send a HTTP POST request to: https://ivs.markid.eu/api/v2/delete-monitoring-user/ with monitoring ID in the request body.

Example request:

{  
   "monitoringId": "12345678"
}

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

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.

Sending request

Send a HTTP POST request to: https://ivs.markid.eu/api/v2/add-whitelist

The request must contain basic auth headers where username is API key and password is API secret.

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.)

Example request with monitoringId:

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

Example request with scanRef:

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

Example request with additional data:

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

Example requests with a company:

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

{
    "monitoringId": "monitoringId",
    "whitelist": {"PEPS": ["ListNumber"]}
}

Removing entries from whitelist

To remove an entry from whitelist, send a HTTP POST request to: https://ivs.markid.eu/api/v2/clear-user-whitelist/ with monitoring ID in the request body.

Example request:

{  
   "monitoringId": "12345678"
}

Example responses:

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

Generate AML monitoring report

You can retrieve a report in PDF format about the monitoring entry.

The report contains the following information about the entry:

• Monitoring ID

• Personal information, such as: name, surname, full name, nationality, date of birth.

• Type (person or company)

• Entry date

• Last check date

• Expiration date

• Suspicion type and reason of suspicion

• Checked service name

• Indicators (probability score, active or not).

Sending request

Send a HTTP POST request to: https://ivs.markid.eu/api/v2/generate-pdf-aml

The request must contain basic auth headers where username is API key and password is API secret. The request must contain JSON with parameter:

Response

After a successful API call, you will receive a PDF file in Base64 format and a response with a positive 200 status.

Only one entry is accepted per request.

Examples

Example request

{
    "monitoringId": ""
}