Skip to main content
GET
Poll a client report

Authorizations

x-preuve-key
string
header
required

Your API key (prv_...), sent as-is. It is the only credential the API needs - see the Authentication guide.

Path Parameters

id
string<uuid>
required

Client report id, scoped to the caller's Agency workspace.

Response

Report status.

reportId
string
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
scanType
enum<string>
Available options:
starter,
deep
analysisTier
string
readyForExport
boolean
reportUrl
string<uri>
createdAt
string<date-time>
pollAfterSeconds
integer

Present only while the report is not terminal.

reused
boolean

Present when this clientRunId replayed an existing report.

dispatchPending
boolean

The dispatch outcome is unknown. Retry the same clientRunId and arguments after 60 seconds; recovery reuses the original report and credit. Past 23 hours the recovery text directs you to support instead of risking a duplicate job.

recovery
string

What to do next, present alongside dispatchPending.