Sign in
Suppliers - Sites

Get validation status for a supplier

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

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/validation). If multiple suppliers match, 400 is returned.
  • The response reflects the latest validation request you created for that target.

Status values:

  • PENDING: The validation request has been submitted and is being processed.
  • COMPLETED: The validation was successful. The outcomeTargetId field contains the Prewave target ID of the validated site (may differ from the original if a master record was identified).
  • REJECTED: The validation could not be completed. The rejectionReason and rejectionReasonNotes fields provide details.

Example:

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

Required Permission: ACCESS_PUBLIC_VALIDATION_REQUEST

get/public/v2/suppliers/sites/validation

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

Validation status returned

requestIdstring uuid required

UUID of the validation request

status'PENDING' | 'COMPLETED' | 'REJECTED' | 'PENDING' | 'COMPLETED' | 'REJECTED' required

Current status of the validation request

prewaveTargetIdinteger required

Prewave target ID of the supplier for which validation was requested

outcomeTargetIdinteger nullable

Prewave target ID of the outcome site (set when status is COMPLETED)

rejectionReasonstring nullable

Reason for rejection (set when status is REJECTED)

rejectionReasonNotesstring nullable

Additional notes on the rejection reason (set when status is REJECTED)

createdAtstring date-time nullable

Timestamp when the validation request was created (ISO-8601, no timezone offset)

resolvedAtstring date-time nullable

Timestamp when the validation request was resolved (ISO-8601, no timezone offset; set when status is COMPLETED or REJECTED)

Example response

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  "prewaveTargetId": 102006215,
  "outcomeTargetId": 102006220,
  "rejectionReason": "Address could not be validated",
  "rejectionReasonNotes": "The provided address does not match any known location"
}