Compliance Lists

Screen Compliance Lists

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

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.
	Array of objects (ComplianceDataSource)
	object (ComplianceEntryRequest)
limit	integer Default: 10 Specify the number of returned screen results
startAfter	string (StartAfter) The ID which is used to read the page.
withAuditTrail	boolean Default: true Specifies if audit trail is supposed to be generated in a response
withStopWords	boolean Default: true Specifies if stop words are supposed to be detected and special calculation is supposed to be used for matching score

Responses

200

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": "string",
"entry": {"externalId": "string",
"names": [{"shortName": "string",
"type": {"url": "string",
"name": "string",
"technicalKey": "string"
},
"value": "string",
"language": {"name": "string",
"technicalKey": "string"
}
}
],
"addresses": [{"version": {"characterSet": {"name": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
},
"externalId": "string",
"country": {"shortName": "string",
"value": "string"
},
"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": "string",
"name": "string",
"issuingBody": {"name": "string",
"technicalKey": "string"
}
},
"additionalInformation": [{"key": "string",
"value": "string"
}
]
},
"matchingProfile": {"matchingScores": {"overall": {"explanation": "string",
"value": 0
}
}
},
"dataSource": {"url": "https://meta.cdq.com/Data_source/BR.RF",
"name": "Receita Federal Brazil",
"technicalKey": "BR_RF"
}
}
],
"auditTrail": {"performedBy": "string",
"screenedNames": [{"value": "Corporate Data Quality AG"
}
],
"screeningDate": "string",
"screeningSettings": {"listsUsedForCheck": [{"authority": "string",
"name": "string",
"type": "string",
"technicalKey": "string"
}
],
"minMatchingScore": 0
}
}
}