Sign in
latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Suppliers - Sites

Get screening status for a supplier

Retrieve the status of the most recent screening request for a supplier site, using the same identifier query parameters as GET /public/v2/suppliers/sites/find-by-identifier.

This applies to screening started via POST /public/v2/suppliers/sites/screening and, once the target exists, to screening that was scheduled with screeningPeriodInYears on POST /public/v2/suppliers/sites (batch post-init screening is still attributed to your user when it runs).

Resolution:

  • At least one of supplierId, customerId, ownId, or prewaveId must be provided.
  • Exactly one supplier must match (same rules as DELETE /public/v2/suppliers/sites and POST /public/v2/suppliers/sites/screening). If multiple suppliers match, 400 is returned.
  • The response reflects the latest screening request you created for that target (by request id). Use the same identifiers as in POST /public/v2/suppliers/sites/screening to track that request.

Status values:

  • New — The request is still in progress.
  • Finished — Screening completed; findings were found.
  • NoFindings — Screening completed; no findings were found.
  • Aborted — The request was rejected or an error occurred.

Example:

GET /public/v2/suppliers/sites/screening?prewaveId=102006215

Required Permission: ACCESS_PUBLIC_SCREENING_REQUEST

get/public/v2/suppliers/sites/screening

Query parameters

supplierIdstring

Supplier ID to search for. Can be combined with customerId, ownId, and/or prewaveId.

customerIdstring

Customer ID to search for. Can be combined with supplierId, ownId, and/or prewaveId.

ownIdstring

Own site ID to search for. Can be combined with supplierId, customerId, and/or prewaveId.

prewaveIdinteger

Prewave ID to search for. Can be combined with supplierId, customerId, and/or ownId.

sourcestring

Optional source system to filter by. If not provided, matches IDs with any source or without a source. Applies to all provided ID parameters.

Response

Screening status returned

idinteger required

The screening request ID.

status'New' | 'Finished' | 'NoFindings' | 'Aborted' required

Current status of the screening request: New (in progress), Finished (findings found), NoFindings (no findings), Aborted (failed or rejected).

periodInYearsinteger required

Screening window length in years (as requested).

Example response

{
  "id": 10042,
  "status": "Finished",
  "periodInYears": 2
}