# Data Compliance API

This API provides services to search and read compliance information

Version: 2

## Servers

Production
```
https://api.cdq.com/data-compliance/rest
```

## Security

### apiKey

Type: apiKey
In: header
Name: X-API-KEY

## Download OpenAPI description

[Data Compliance API](https://developer.cdq.com/_bundle/apis/data-compliance-api/@data-compliance-api-v2/api-v2.yaml)

## Examples

Example requests for various endpoints

### Get Compliance Lists Screen Examples

 - [GET /v2/compliancelists/screen/examples](https://developer.cdq.com/apis/data-compliance-api/api-v2/examples/paths/~1v2~1compliancelists~1screen~1examples/get.md): Get examples of how to use the compliance lists screen endpoint.

## Compliance Lists

Facilitate the screening of Business Partners against various compliance lists such as sanction lists, watch lists and PEP lists.

### Screen Compliance Lists

 - [POST /v2/compliancelists/screen](https://developer.cdq.com/apis/data-compliance-api/api-v2/compliance-lists/paths/~1v2~1compliancelists~1screen/post.md): 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.

## Configuration Profiles

Manage the retrieval of predefined configuration profiles. These profiles are essential for setting up and managing compliance list screening processes.

### List Configurations Profiles

 - [GET /configurations/compliancelistsscreeningprofiles](https://developer.cdq.com/apis/data-compliance-api/api-v2/configuration-profiles/paths/~1configurations~1compliancelistsscreeningprofiles/get.md): List all predefined configuration profiles.

## Configurations

Manage configurations for compliance list screening. These endpoints allow for the listing, creation, reading, updating, and deletion of configurations. The configurations are essential for defining the parameters of the screening process.

### List Configurations

 - [GET /configurations/compliancelistsscreening](https://developer.cdq.com/apis/data-compliance-api/api-v2/configurations/paths/~1configurations~1compliancelistsscreening/get.md): List all existing configurations for compliance list screening.

### Create a Configuration

 - [POST /configurations/compliancelistsscreening](https://developer.cdq.com/apis/data-compliance-api/api-v2/configurations/paths/~1configurations~1compliancelistsscreening/post.md): Create a new configuration for compliance list screening.

### Read Configuration

 - [GET /configurations/compliancelistsscreening/{configurationId}](https://developer.cdq.com/apis/data-compliance-api/api-v2/configurations/paths/~1configurations~1compliancelistsscreening~1%7Bconfigurationid%7D/get.md): Read existing configuration for compliance list screening by id.

### Update Configuration

 - [PUT /configurations/compliancelistsscreening/{configurationId}](https://developer.cdq.com/apis/data-compliance-api/api-v2/configurations/paths/~1configurations~1compliancelistsscreening~1%7Bconfigurationid%7D/put.md): Update existing configuration for compliance list screening by id.

### Delete Configuration

 - [DELETE /configurations/compliancelistsscreening/{configurationId}](https://developer.cdq.com/apis/data-compliance-api/api-v2/configurations/paths/~1configurations~1compliancelistsscreening~1%7Bconfigurationid%7D/delete.md): Delete existing configuration for compliance list screening by id.

### Read Compliance List Screening Configuration Version

 - [GET /configurations/compliancelistsscreening/{configurationId}/versions/{version}](https://developer.cdq.com/apis/data-compliance-api/api-v2/configurations/paths/~1configurations~1compliancelistsscreening~1%7Bconfigurationid%7D~1versions~1%7Bversion%7D/get.md): Read a specific version of a compliance list screening configuration by id and version number.

## Processing Logs

### List Processing Log Results

 - [GET /v2/screeninglogs/{storageId}/results](https://developer.cdq.com/apis/data-compliance-api/api-v2/processing-logs/paths/~1v2~1screeninglogs~1%7Bstorageid%7D~1results/get.md): Retrieves latest screening results persisted in the Processing Log.

Data is populated only when Data Monitor with type "SCREENING" is configured for provided storage.