# List all screened business partners.

Endpoint to list all screened business partners with filtering options.

Endpoint: GET /businesspartners
Version: 1
Security: apiKey

## Query parameters:

  - `dataSourceId` (string)
    ID of the business partner storage data source.
    Example: "648824a691d8d2503d65103e"

  - `businessPartnerId` (string)
    ID of the business partner.
    Example: "63e635235c06b7396330fe40"

  - `businessPartnerName` (string)
    Name of the business partner.
    Example: "Apple"

  - `lastDecisionDate` (string)
    Date of the last decision.
    Example: "2025-08-27T14:26:38Z"

  - `fromDate` (string)
    Date from a point in time.
    Example: "2025-08-27T14:26:38Z"

  - `toDate` (string)
    Date to a point in time.
    Example: "2025-08-27T14:26:38Z"

  - `listTypes` (array)
    Types of the compliance list.
    Enum: "SL", "PEP", "WL"

  - `onlyOpenCases` (boolean)
    Flag to filter business partners with open cases.
    Example: true

  - `onlyConfirmedCases` (boolean)
    Flag to filter business partners with confirmed cases (Last decision type is CONFIRMED).
    Example: true

  - `onlyClearedCases` (boolean)
    Flag to filter business partners with cleared cases (Last decision type is CLEARED).
    Example: true

  - `onlyVerifiedCases` (boolean)
    Flag to filter business partners with verified cases (totalVerifiedCases > 0).
    Example: 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:
  * 
  * 
  * 
  * 
  * 
  * 
  * 
  *
    Example: "-lastCheckedAt"

  - `startAfter` (string)
    Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.
    Example: "NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm"

  - `limit` (integer)
    Number of resources to be returned on the page.
    Example: "200"

## Response 200 fields (application/json):

  - `values` (array)

  - `values.dataSourceId` (string)
    Unique identifier for a Data Source of the Storage.
    Example: "648824a691d8d2503d65103e"

  - `values.dataSourceName` (string)
    Name of a data source of a storage.
    Example: "Internal customers"

  - `values.businessPartnerId` (string)
    A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.
    Example: "63e635235c06b7396330fe40"

  - `values.businessPartnerName` (string)
    The actual name.
    Example: "Corporate Data Quality AG"

  - `values.externalId` (string)
    External ID of the business partner.
    Example: "123"

  - `values.country` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.listTypes` (array)
    List of list types.
    Enum: "SL", "PEP", "WL"

  - `values.lastCheckDate` (string)
    Date of the last checking.
    Example: "2025-08-27T14:26:38Z"

  - `values.lastDecisionDate` (string)
    Date of the decision.
    Example: "2025-08-27T14:26:38Z"

  - `values.lastHit` (string)
    Date of last hit found during screening.
    Example: "2025-08-27T14:26:38Z"

  - `values.openCases` (integer)
    Number of open cases.
    Example: 1

  - `values.resolvedCases` (integer)
    Number of resolved cases.
    Example: 2

  - `values.totalCases` (integer)
    Total number of cases.
    Example: 3

  - `values.totalVerifiedSanctions` (integer)
    Total number of verified sanctions.
    Example: 3

  - `values.totalVerifiedPEP` (integer)
    Total number of verified PEPs.
    Example: 3

  - `values.totalVerifiedWatchlists` (integer)
    Total number of verified whitelists.
    Example: 3

  - `values.totalVerifiedCases` (integer)
    Total number of verified cases.
    Example: 9

  - `values.confirmedCases` (integer)
    Total number of cases with last decision type CONFIRMED.
    Example: 3

  - `values.clearedCases` (integer)
    Total number of cases with last decision type CLEARED.
    Example: 3

  - `values.deletionDate` (string)
    Date of the deletion.
    Example: "2025-08-27T14:26:38Z"

  - `startAfter` (string)
    The ID which is used to read the page.
    Example: "5712566172571652"

  - `nextStartAfter` (string)
    Provides a value to be used as a startAfter in next page request.
    Example: "5712566172571652"

  - `limit` (integer)
    Number of items per page.
    Example: "100"

  - `total` (integer)
    Total number of items which can be paged.
    Example: "67"

## Response 400 fields (application/json):

  - `status` (object)
    Details about status or error of a service

  - `status.code` (integer, required)
    RFC 7231 status code for this error.
    Example: "400"

  - `status.technicalKey` (string, required)
    Technical key describing the status or error
    Example: "OK"

  - `status.details` (array, required)

  - `status.details.id` (integer, required)
    9-digit code which is uniquely identifying a message
    Example: 200000004

  - `status.details.message` (string, required)
    Human-readable message which may also be presented in user interface.
    Example: "Business Partner Name is mandatory."

  - `status.details.technicalKey` (string)
    Technical key to uniquely identify a message.
    Example: "JOB_FINISHED"

  - `status.details.jsonPath` (string)
    JSONPath as specified by the IETF standard
    Example: "$.businessPartner.names[0].value"

  - `status.details.jsonRecord` (string)
    Object provided in plain JSON format.
    Example: "{ \"key\" : \"value\"}"

  - `status.path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `status.timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-08-27T14:26:38Z"