Compliance Lists

Screen Compliance Lists

Use this endpoint to find fuzzy candidate matches when searching in sanctions and watchlist.

By default the endpoint has SHOW_AUDIT_TRAIl feature enabled. Use the featuresOn and featuresOff fields in request to add and remove features.

SecurityapiKey

Request

Request Body schema: application/json

object (ComplianceListsScreeningConfigurationRequest)

Configuration that should be used during screening. If this object and configurationId are not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown. If this object and configurationId are both provided, exception will be also thrown as only on of them is allowed.

configurationId

string (ComplianceListsScreeningConfigurationId)

ID of the configuration that should be used during screening. If not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown.

Example: "64cd0303e1cd5s1e4354a1c6"

Array of objects (ComplianceDataSource)

List of Data Sources.

object (ComplianceEntryRequest)

Compliance entry used for compliance screening checks.

featuresOff

Array of strings (ScreeningFeature)

List of features to be disabled.

Items Enum:	Description
SHOW_AUDIT_TRAIL	Show audit trail in the response.
ACTIVATE_STOP_WORDS	Activate detection of stop words and special calculation for matching score.

Example: ["ACTIVATE_STOP_WORDS","SHOW_AUDIT_TRAIL"]

featuresOn

Array of strings (ScreeningFeature)

List of features to be enabled.

Items Enum:	Description
SHOW_AUDIT_TRAIL	Show audit trail in the response.
ACTIVATE_STOP_WORDS	Activate detection of stop words and special calculation for matching score.

Example: ["ACTIVATE_STOP_WORDS","SHOW_AUDIT_TRAIL"]

limit

integer

Default: 10

Specify the number of returned screen results.

Example: "10"

startAfter

string (StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

Responses

200

400

Bad Request

401

Unauthorized

429

Too Many Requests

post/v2/compliancelists/screen

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"entry": {"names": [{"value": "Klaus"
}
],
"addresses": [{"country": {"shortName": "DE"
}
}
]
},
"dataSources": [{"technicalKey": "SANCTION_LIST"
}
],
"lists": [{"technicalKey": "INFO4C_SL_22"
}
]
}

Response samples

application/json

{"total": "67",
"nextStartAfter": "5712566172571652",
"startAfter": "5712566172571652",
"values": [{"cdqId": "SANCTIONLIST:10120020770",
"entry": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"addresses": [{"version": {"characterSet": {"name": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
},
"externalId": "The ID managed in the customer's SAP systems.",
"country": {"shortName": "CH",
"value": "Switzerland"
},
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
]
}
],
"list": {"technicalKey": "INFO4C_SL_1",
"name": "Notices and Measures",
"issuingBody": {"name": "Amtsgericht Aachen",
"technicalKey": "Amtsgericht Aachen"
}
},
"additionalInformation": [{"key": "KEY",
"value": "1"
}
]
},
"matchingProfile": {"matchingScores": {"overall": {"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]",
"value": "0.9"
}
}
},
"dataSource": {"url": "https://meta.cdq.com/Data_source/BR.RF",
"name": "Receita Federal Brazil",
"technicalKey": "BR_RF"
}
}
],
"auditTrail": {"performedBy": "John Doe",
"screenedNames": [{"value": "Corporate Data Quality AG"
}
],
"screeningDate": "2024-05-20T12:15:56Z",
"screeningSettings": {"listsUsedForCheck": [{"authority": "The Federal Financial Supervisory Authority (BaFin)",
"name": "Notices and Measures",
"type": "WATCHLIST",
"technicalKey": "INFO4C_WL_287"
}
],
"minMatchingScore": "0.8"
}
}
}