List all screened business partners.

Endpoint to list all screened business partners with filtering options.

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
fromDate
string

Date from a point in time.

Example: fromDate=2025-03-31T14:03:01Z
lastDecisionDate
string

Date of the last decision.

Example: lastDecisionDate=2025-03-31T14:03:01Z
limit
integer <int32> >= 1
Default: 500

Number of resources to be returned on the page.

Example: limit=200
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
onlyVerifiedCases
boolean

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

Example: onlyVerifiedCases=true
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:

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

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

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
toDate
string

Date to a point in time.

Example: toDate=2025-03-31T14:03:01Z
Responses
200

OK

400

Bad Request

get/businesspartners
Request samples 
Response samples 
application/json
{
  • "values": [
    ],
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67"
}