Get all business partner cases.

Endpoint to get all business partner cases.

SecurityapiKey

Request

query Parameters

businessPartnerId	string (BusinessPartnerId) ID of the business partner. Example: businessPartnerId=63e635235c06b7396330fe40
businessPartnerName	string Name of the business partner. Example: businessPartnerName=Apple
caseId	string ID of the case. Example: caseId=123
decisionType	string (AMLDecisionType) Type of the decision. Enum: "CREATE" "CONFIRMED" "CLEARED" "REOPEN" Example: decisionType=CONFIRMED
fromDate	string Date from a point in time. Example: fromDate=2025-03-31T14:03:01Z
limit	integer <int32> >= 1 Default: 500 Number of resources to be returned on the page. Example: limit=200
listAuthority	string Authority of the list. Example: listAuthority=United States Department of the Treasury
listName	string Name of the list. Example: listName=OFAC
listTypes	Array of strings (ListTypes) Types of the compliance list. Items Enum: "SL" "PEP" "WL" Example: listTypes=PEP&listTypes=SL&listTypes=WL
onlyOpenCases	boolean Flag to filter business partners with open cases. Example: onlyOpenCases=true
screeningScore	number Screening score. Example: screeningScore=0.8
sort	string 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
startAfter	string Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response. Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
status	string (AMLCaseStatus) Status of the case. Enum: "OPEN" "CLOSED" "OUTDATED" Example: status=OPEN
toDate	string Date to a point in time. Example: toDate=2025-03-31T14:03:01Z

Responses

200

400

Bad Request

get/cases

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"values": [{"id": "123",
"version": "1",
"info4cId": "123",
"dataMirrorId": "123",
"screeningScore": 0.8,
"issuingDate": "2025-03-31T14:03:01Z",
"modificationDate": "2025-03-31T14:03:01Z",
"businessPartnerId": "63e635235c06b7396330fe40",
"businessPartnerName": "Apple",
"businessPartnerAddress": "Polna 12/28, 00-390 Warszawa",
"businessPartnerLegalForm": "CZ_8911(Společnost s ručením omezeným)",
"businessPartnerIdentifiers": ["Polna 12/28, 00-390 Warszawa"
],
"country": "CH",
"listType": "PEP",
"screeningDate": "2025-03-31T14:03:01Z",
"listAuthority": "United States Department of the Treasury",
"listName": "OFAC",
"decisionDate": "2025-03-31T14:03:01Z",
"complianceDataSource": "AML",
"decisions": [{"reviewerId": "johndoe",
"createdAt": "2025-03-31T14:03:01Z",
"type": "CONFIRMED",
"comment": "My decision",
"reason": "CONFIRMED_MATCH",
"caseStatus": "OPEN",
"amlCaseHistoryId": "6735c38c8fedd67d354791ad"
}
],
"configurationId": {"id": "123",
"revision": 1
},
"status": "OPEN"
}
],
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"limit": "100",
"total": "67"
}