AML Screening

GetAMLSearchByID

GET https://api.icomplykyc.com/api/v2/aml/:id

Get AML screen search result by entity ID

Authentication Type: Api Key

Sample Query: https://api.icomplykyc.com/api/v2/aml/1234567e-fcff-4c10-9dd3-da74422e1c30

Path Parameters

Name	Type	Description
id	String	Entity ID of the Legal Entity

200: OK

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "id": 591,
        "ongoing": false,
        "screenDate": "2020-12-04",
        "nextReview": "2022-12-04",
        "searchTerm": "John Doe",
        "searchTypes": [
            "person"
        ],
        "searchFuzziness": 40,
        "searchCoverage": [
            "Warning",
            "Pep Class 1"
        ],
        "pending": 17,
        "accepted": 0,
        "unknown": 0,
        "sanctions": 0,
        "politicalExposure": 0,
        "adverseMedia": 0,
        "linkedEntityIds": [
            "04831052-235e-4de5-be35-eb9c4ddb33e4",
            "07675e44-c422-44da-b2a1-177c37293c4e"
        ]
    }
}

404: Not Found

{
    "code": 404,
    "status": "failure",
    "message": "there is no aml search with given id",
    "data": null
}

Add AML Search

Sample Request Body

To create a new AML search, initiate a POST request to https://api.icomplykyc.com/api/v2/aml with the following JSON payload.

{
    "ongoing": false,
    "searchTerm": {
        "name": "John Doe",
        "yearOfBirth": 1969,
        "countries": ["US"]
    },
    "searchType": "person",
    "searchFuzziness": 40,
    "searchCoverage": ["sanctions", "warning", "pep-class-1"],
    "linkedEntityIds": ["04831052-235e-4de5-be35-eb9c4ddb33e4", "07675e44-c422-44da-b2a1-177c37293c4e"]
}

AddAMLSearch

POST https://api.icomplykyc.com/api/v2/aml

Start a new AML screening search based on the specified parameters.

Authentication Type: Api Key

Sample Query: https://api.icomplykyc.com/api/v2/aml

Request Body

Name	Type	Description
Raw*	JSON	See sample payload above

200: OK

{
    "code": 201,
    "status": "success",
    "message": "",
    "data": {
        "id": "591"
    },
    "errors": []
}

400: Bad Request

{
    "code": 400,
    "status": "failure",
    "messsage": "you need to provide 'name' (string) under AML search term object",
    "data": null
}