Use this API to screen users against predefined lists and search criteria as mentioned in the Integration steps.
AML Backend API Documentation
1.0.0
Email:
support@digio.in
This is the API documentation for the project. The naming convention is snake_case.
API SERVER
SELECTED: https://enterprise.digio.in/digio-aml/case-manager
AUTHENTICATION
No API key applied
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
client-api-controller
Screening API
post
{BASE_URL}/client/v1/user/screen
Screen users against predefined lists and search criteria as mentioned in Integration steps.
Requires
Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
REQUEST BODY *
application/json
{
"screening_mode": "CREATE",
"screening_settings": {
"lists": [
"string"
],
"risk_thresholds": "HIGH",
"enable_monitoring": false,
"screening_type": "SCREEN_ONLY_RESPONSE",
"expiry_date": "string",
"monitoring_frequency": 0,
"response_mode": "COMPACT",
"cut_off_threshold": 0
},
"user_details": {
"property1": "string",
"property2": "string"
},
"rules": [
"string"
],
"screeningtype": "SCREEN_ONLY_RESPONSE"
}
object
Single line description
Field
Type
Description
screening_mode
enum
➔
Allowed: CREATE┃UPDATE┃DELETE┃SCREENING┃MONITORING┃TRADE_SURVEILLANCE┃EXTERNAL_ALERT┃REVERSE_MONITORING┃POST_ONBOARDING_CHECK
-
screening_settings
object
lists
[string]
risk_thresholds
enum
➔
Allowed: HIGH┃MEDIUM┃LOW
enable_monitoring
boolean
screening_type
enum
➔ Type of screening
Allowed: SCREEN_ONLY_RESPONSE┃SCREEN_AND_RAISE_ALERT┃SCREEN_RAISE_ALERT_AND_MONITOR
expiry_date
string
The date until which the customer needs to be monitored (format - 'YYYY-MM-DD')
monitoring_frequency
integer
response_mode
enum
➔ COMPACT or DETAILED response type
Allowed: COMPACT┃DETAILED
cut_off_threshold
integer
Minimum threshold value required to raise alerts (default: 0)
-
user_details
object
[any-key]
string
rules
[string]
list of Rule Ids
⮕ [ list of Rule Ids ]
screeningtype
enum
➔
Allowed: SCREEN_ONLY_RESPONSE┃SCREEN_AND_RAISE_ALERT┃SCREEN_RAISE_ALERT_AND_MONITOR
API Server
https://enterprise.digio.in/digio-aml/case-manager
Authentication
Required (None Applied)
curl -X POST "https://enterprise.digio.in/digio-aml/case-manager/client/v1/user/screen" \
-H 'accept: */*'
RESPONSE
200
OK
*/*
object
Single line description
Field
Type
Description
risk_level
enum
➔ LOW/MEDIUM/HIGH denotes the risk of this customer
Allowed: HIGH┃MEDIUM┃LOW
top_match_score
number
is_alert_generated
boolean
True if alert generated to dashboard else false
found
boolean
True if match found else false
case_reference
string
total_alerts
integer
Count of total number of matches found
low_severity_alerts
integer
Count of low severity alerts found
high_severity_alerts
integer
Count of high severity alerts found
medium_severity_alerts
integer
Count of medium severity alerts found
internal_client_id
string
-
low_alert_details
array of object
severity
enum
➔
Allowed: HIGH┃MEDIUM┃LOW
name
string
summary
string
alias
string
low_quality_alias
string
date_of_birth
string
place_of_birth
string
gender
enum
➔
Allowed: MALE┃FEMALE┃OTHERS
nationality
string
detailed_information
string
source_url
string
fuzzy_match_score
number
source_unique_id
string
source_name
string
-
high_alert_details
array of object
severity
enum
➔
Allowed: HIGH┃MEDIUM┃LOW
name
string
summary
string
alias
string
low_quality_alias
string
date_of_birth
string
place_of_birth
string
gender
enum
➔
Allowed: MALE┃FEMALE┃OTHERS
nationality
string
detailed_information
string
source_url
string
fuzzy_match_score
number
source_unique_id
string
source_name
string
-
medium_alert_details
array of object
severity
enum
➔
Allowed: HIGH┃MEDIUM┃LOW
name
string
summary
string
alias
string
low_quality_alias
string
date_of_birth
string
place_of_birth
string
gender
enum
➔
Allowed: MALE┃FEMALE┃OTHERS
nationality
string
detailed_information
string
source_url
string
fuzzy_match_score
number
source_unique_id
string
source_name
string