Public API Changelog
This document contains the release notes for the Prewave Public API for May 2026. This update focuses on documentation and integration guidance for asynchronous screening and validation workflows.
🚀 Key Updates
The May release provides expanded examples, error semantics, and identifier rules for endpoints that shipped in April 2026.
Screening (v2): Documented asynchronous history screening with status polling.
Validation (v2): Documented asynchronous discovery validation with status polling.
Create Supplier (v2): Added guidance for optional
screeningPeriodInYearsandrequestValidationOnCreatefields.Shared Identifier Rules: Clarified uniqueness requirements for supplier identifiers across v2 endpoints.
🔎 Screening and Validation (v2)
Base path: /public/v2/suppliers/sites
Screening
Request history screening for an existing supplier and poll for the results.
Request Screening:
POST /public/v2/suppliers/sites/screening.Requires an identifier and an options.periodInYears value of 2, 5, or 10.
Returns 202 Accepted with
screeningRequestIds.
Poll Status:
GET /public/v2/suppliers/sites/screening.Returns status such as
New,Finished,NoFindings, orAborted.Returns 404 if no screening request exists for that supplier for your user.
Validation
Request discovery validation for an existing supplier to confirm its status.
Request Validation:
POST /public/v2/suppliers/sites/validation.Returns 202 Accepted with a UUID
requestId.Failures (e.g., conflicting pending requests) surface as 4xx errors.
Poll Status:
GET /public/v2/suppliers/sites/validation.Returns
PENDING,COMPLETED, orREJECTEDwith optional outcome details.
🏭 Optional Screening & Validation on Create
When using POST /public/v2/suppliers/sites, you can now schedule automated post-onboarding actions.
Field | Effect |
| Schedules history screening (2, 5, or 10 years) after onboarding completes. |
| If true, schedules a discovery validation request after onboarding completes. |
[!NOTE]
Using these optional flags requires the matching entitlements for your API user.
🔗 Shared Identifier Rules
For all v2 supplier endpoints, you must provide at least one of the following identifiers: supplierId, customerId, ownId, or prewaveId.
Uniqueness: Exactly one supplier site must match the identifier.
Errors: If zero suppliers match, the API returns 404; if multiple suppliers match, it returns 400.
Disambiguation: Use the optional
sourcefield to clarify string-based IDs.
💬 Support
For questions or high-volume screening requests:
Email: [email protected]
Knowledge Base: help.prewave.com
CSM: Contact your Customer Success Manager