Request screening for a supplier

Request a history screening for a supplier site. The body has two parts: identifier (how to find the site) and options (screening parameters).

Request body shape (OpenAPI schema: PublicScreeningRequestPayloadV2):

{
  "identifier": {
    "supplierId": null,
    "customerId": null,
    "ownId": null,
    "prewaveId": 102006215,
    "source": null
  },
  "options": {
    "periodInYears": 2
  }
}

identifier: At least one of supplierId, customerId, ownId, or prewaveId must be non-empty / non-null (same semantics as query params on find-by-identifier). Optional source applies to the string IDs only.
options.periodInYears: Required. Must be 2, 5, or 10 (years).

Asynchronous Processing:

Screening is an asynchronous process that may take several hours to complete.
The endpoint returns immediately with 202 Accepted and the created screening request ID(s).
Poll status with the same supplier identifiers you used in identifier, e.g. GET /public/v2/suppliers/sites/screening?prewaveId=... (see get screening status).

Supplier Identification (identifier):

At least one of supplierId, customerId, ownId, or prewaveId must be provided inside identifier.
Exactly one supplier must match (same rules as DELETE /public/v2/suppliers/sites and POST /public/v2/suppliers/sites/identifiers). If your criteria match zero suppliers, 404 is returned; if more than one, 400 with a multiple-suppliers error.
If the matched target is already screened or otherwise ineligible, it may be skipped (reflected by an empty screeningRequestIds list in the response).

Costs:

Screening requests may incur additional costs or consume quota. Ensure your plan supports screening before calling this endpoint.

Required Permission: ACCESS_PUBLIC_SCREENING_REQUEST

post/public/v2/suppliers/sites/screening

Request body

Example request

{
  "identifier": {
    "supplierId": "SAP-12345",
    "customerId": "CRM-67890",
    "ownId": "OWN-SITE-01",
    "prewaveId": 102006215,
    "source": "SAP"
  },
  "options": {
    "periodInYears": 2
  }
}

Response

Screening request accepted for processing

screeningRequestIdsinteger[] required

IDs of the created screening requests. One ID per resolved target. Empty if all targets were already screened or otherwise ineligible.

messagestring required

Human-readable confirmation message.

Example response

{
  "screeningRequestIds": [
    10042,
    10043
  ],
  "message": "Screening request submitted successfully"
}