Revoke a report's share link

POST

/api/v1/reports/{id}/revoke

Docs menu

Withdraws the share link. The share page and its PDF answer 404 from then on, and the report reads status revoked with no share_url. The charge does not change. A second call returns the revoked report. We also revoke an account's links when the account is frozen or a top-up is charged back. Revoking a link does not withdraw the report's record code: the report is still genuine.

Key
Bearer key, test or live
Scope
reports:write
Idempotency
Header recommended

Parameters

idstringrequired

The id of the report.

Headers

Idempotency-Keystringoptional

Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.

Response

200. The report, revoked.

idstring

rep_...

objectstring

report

livemodeboolean
check_idstring
datedstring

The check's completed_at.

brandobject
Show child fields
namestring
logo_urlstring or null
colorstring or null
statusstring

readyrevoked

share_urlstring or null
pdfobject
Show child fields
statusstring

pendingreadyunavailablefailed

urlstring or null
codestring or null
sampleboolean

True for every test-mode report: a marked sample, not a proof report.

record_codestring or null

The record code printed on a live report, like PP-7K3M-9QX2-4T8F. Anyone holding it can check the report is genuine at /verify. Null in test mode.

record_urlstring or null

The public page that checks the record code: /verify/<record_code>. Null when record_code is null.

verify_lineboolean

Whether the printed report carries the line "Record <code> · Check it is genuine at pressprove.com/verify · Fingerprint". When false the report names nothing of PressProve; the record still exists and record_code still checks.

credits_chargedinteger
created_atstring
project_idstring or null

The client project it is tagged to, in the same workspace; null when none.

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
not_found404No such object.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode

Revoke a report's share link (POST /reports/{id}/revoke) · Docs · PressProve