Skip to main content

Offsite Integration

In the offsite verification process Shufti Pro’s merchants are solely responsible for managing data collection and providing it to Shufti Pro to facilitate AML checks.

Parameters and Description

ParametersDescription
business_nameRequired: Yes
Type: string
Max: 255 Characters
This parameter receives the business name to run it against the AML list.
Example: Shufti Pro Ltd
business_incorporation_dateRequired: No
Type: string
Format: yyyy-mm-dd
This parameter receives the incorporation date of the business to run it against the AML list.
Example: 2016-01-01
ongoingRequired: No
Accepted values: 0, 1
Default: 0
This Parameter is used for Ongoing AML Screening, and is allowed only on Production Accounts. If Shufti Pro detects a change in AML statuses, then we will send you a webhook with event verification.status.changed. The new AML status can be checked using get status endpoint, or from the back-office.
filtersRequired: No
Type: Array
Default: ["sanction", "warning", "fitness-probity", "pep", "pep-class-1", "pep-class-2", "pep-class-3", "pep-class-4", "adverse-media-financial-crime", "adverse-media-violent-crime", "adverse-media-sexual-crime", "adverse-media-terrorism", "adverse-media-narcotics", "adverse-media"]

This key includes specific filter types, namely, alert or warning, that are linked to the AML search. Use these filters within the search to refine and narrow down the results.
match_scoreRequired: No
Type: String
match_score indicates the extent to which a search should accommodate variances between the search term and the terms being matched. A value of 0 signifies a loose match, while 100 indicates an exact match.
Note: It ranges from 0-100. By default value is 100.
Example: "100".
countriesRequired: No
Type: Array
Array of countries based on which you want to filters reports. See Countries.
Note: ISO 3166-1 alpha-2 country codes are supported.
Example: ['CA','IN']
alias_searchRequired: No
Type: Boolean
Alias search is used to specify whether user want to perform search within aliases or not.
Note: The default value of alias_search is '0'.
Example: "0".
rca_searchRequired: No
Type: Boolean
RCA search is used to specify whether user want to perform search within rca or not.
Note: The default value of rca_search is '0'.
Example: "0".

Request Payloads

Run in Postman


AML-for-businesses-service-sample-object

//POST / HTTP/1.1 basic auth
//Host: api.shuftipro.com
//Content-Type: application/json
//Authorization: Basic NmI4NmIyNzNmZjM0ZmNlMTlkNmI4WJRTUxINTJHUw==

{
"aml_for_businesses": {
"business_name": "ShuftiPro",
"business_incorporation_date": "2016-01-01",
"ongoing": "0",
"alias_search": "0",
"rca_search": "0",
"match_score": "100",
"countries": [ "gb", "cy"],
"filters": ["sanction", "warning", "fitness-probity", "pep", "pep-class-1", "pep-class-2", "pep-class-3", "pep-class-4"]
}
}