Skip to content

Case Management API (1)

This API provides services to manage screening history, cases and decisions.

Download OpenAPI description
api-v1.json
api-v1.yaml
Languages
Servers
Production

https://api.cdq.com/case-management/rest/

Case Management

Endpoints to manage screening history, cases and decisions.

Operations

Get all business partner cases.

Request

Endpoint to get all business partner cases.

Security
apiKey
Query
caseIdstring

ID of the case.

Example: caseId=123
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

ID of the business partner storage data source.

Example: dataSourceId=648824a691d8d2503d65103e
businessPartnerIdstring(BusinessPartnerId)

ID of the business partner.

Example: businessPartnerId=63e635235c06b7396330fe40
businessPartnerNamestring

Performs a full-text search on business partner names. This enables tokenized word matching with relevance scoring, and supports matching on whole words or stemmed variants (e.g., "Porsche" matches "Porsche Holding"). Unlike regex substring search, $text search does not support partial matches or wildcards (e.g., "Pors" will not match "Porsche"). The search is case-insensitive and language-aware (English stemmer by default). Note: Exact matches are prioritized over partial matches. Note: This is not a fuzzy search — typos or approximate matches are not supported.

Example: businessPartnerName=Apple
screeningScorenumber

Screening score.

Example: screeningScore=0.8
fromDatestring

Date from a point in time.

Example: fromDate=2025-10-07T05:40:21Z
toDatestring

Date to a point in time.

Example: toDate=2025-10-07T05:40:21Z
listTypesArray of strings(ListTypes)

Types of the compliance list.

Items Enum"SL""PEP""WL"
Example: listTypes=PEP&listTypes=SL&listTypes=WL
listAuthoritystring

Authority of the list.

Example: listAuthority=United States Department of the Treasury
listNamestring

Name of the list.

Example: listName=OFAC
statusstring(AMLCaseStatus)

Status of the case.

Enum"OPEN""CLOSED""OUTDATED"
Example: status=OPEN
systemStatusstring(AMLCaseSystemStatus)

System status of the case.

Enum"VALID""OUTDATED""DELETED"
Example: systemStatus=VALID
decisionTypestring(AMLDecisionType)

Type of the decision.

Enum"CREATE""CONFIRMED""CLEARED""REOPEN""DELETED""OUTDATED""REVALIDATED"
Example: decisionType=CONFIRMED
onlyOpenCasesboolean

Flag to filter business partners with open cases.

Example: onlyOpenCases=true
sortstring

Defines the attributes to sort by. The result is sorted in ascending order. To use descending order use prefix -. Sorting is available only for a single attribute. Available options:

  • caseId
  • screeningScore
  • issuedAt
  • businessPartnerId
  • businessPartnerName
  • country
  • listType
  • lastCheckedAt
  • listAuthority
  • listName
  • lastDecisionAt
  • lastDecisionType
Example: sort=-lastCheckedAt
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
limitinteger(int32)>= 1

Number of resources to be returned on the page.

Default 500
Example: limit=200
curl -i -X GET \
  https://api.cdq.com/case-management/rest/cases \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
valuesArray of objects(AMLCase)
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
Response
application/json
{
  "values": [
    { … }
  ],
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "total": "67"
}

List all screened business partners.

Request

Endpoint to list all screened business partners with filtering options.

Security
apiKey
Query
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

ID of the business partner storage data source.

Example: dataSourceId=648824a691d8d2503d65103e
businessPartnerIdstring(BusinessPartnerId)

ID of the business partner.

Example: businessPartnerId=63e635235c06b7396330fe40
businessPartnerNamestring

Performs a full-text search on business partner names. This enables tokenized word matching with relevance scoring, and supports matching on whole words or stemmed variants (e.g., "Porsche" matches "Porsche Holding"). Unlike regex substring search, $text search does not support partial matches or wildcards (e.g., "Pors" will not match "Porsche"). The search is case-insensitive and language-aware (English stemmer by default). Note: Exact matches are prioritized over partial matches. Note: This is not a fuzzy search — typos or approximate matches are not supported.

Example: businessPartnerName=Apple
lastDecisionDatestring

Date of the last decision.

Example: lastDecisionDate=2025-10-07T05:40:21Z
fromDatestring

Date from a point in time.

Example: fromDate=2025-10-07T05:40:21Z
toDatestring

Date to a point in time.

Example: toDate=2025-10-07T05:40:21Z
listTypesArray of strings(ListTypes)

Types of the compliance list.

Items Enum"SL""PEP""WL"
Example: listTypes=PEP&listTypes=SL&listTypes=WL
onlyOpenCasesboolean

Flag to filter business partners with open cases.

Example: onlyOpenCases=true
onlyConfirmedCasesboolean

Flag to filter business partners with confirmed cases (Last decision type is CONFIRMED).

Example: onlyConfirmedCases=true
onlyClearedCasesboolean

Flag to filter business partners with cleared cases (Last decision type is CLEARED).

Example: onlyClearedCases=true
onlyVerifiedCasesboolean

Flag to filter business partners with verified cases (totalVerifiedCases > 0).

Example: onlyVerifiedCases=true
sortstring

Defines the attributes to sort by. The result is sorted in ascending order. To use descending order use prefix -. Sorting is available only for a single attribute. Available options:

  • businessPartnerId
  • businessPartnerName
  • country
  • lastCheckedAt
  • lastHitAt
  • totalCases
  • openCases
  • closedCases
Example: sort=-lastCheckedAt
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
limitinteger(int32)>= 1

Number of resources to be returned on the page.

Default 500
Example: limit=200
curl -i -X GET \
  https://api.cdq.com/case-management/rest/businesspartners \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
valuesArray of objects(AMLBusinessPartner)
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
Response
application/json
{
  "values": [
    { … }
  ],
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "total": "67"
}