Turns a completed check into a dated proof report with your brand name, a share link and, where a PDF renderer is installed, a PDF. The report is dated by the check's completion time. The share link is unlisted: anyone with the address can read it. A live report also carries a record code (record_code): your client can type it at /verify to check that the report is genuine and still stands. That page shows the counts and dates printed on the report, never the page addresses or a link to the report.
- Key
- Bearer key, test or live
- Scope
reports:write- Idempotency
- Header recommended
Headers
- Idempotency-Keystringoptional
Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.
Request body
JSON. A field this endpoint does not know is refused with unknown_parameter.
- check_idstringrequired
A completed check.
- brandobjectoptional
Show child fields
- namestringrequired
1 to 80 characters.
- logo_urlstring or nulloptional
An https address.
- colorstring or nulloptional
A hex color such as #1d47c5.
- verify_linebooleanoptional
Print the record line on the report. Default true. Send false to forward the report as your own: the record and its code still exist.
- project_idstring or nulloptional
Tag the report to one of your client projects. With no brand, the branding of the project and record-line default are used.
Response
201. The report.
- 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
| Code | Status | Meaning |
|---|---|---|
missing_scope | 403 | The API key does not have the scope this endpoint needs. |
body_not_json | 400 | The request body must be a JSON object. |
unknown_parameter | 400 | The request has a parameter this endpoint does not accept. |
parameter_missing | 400 | A required parameter is missing. |
brand_name_invalid | 400 | The brand name must be 1 to 80 characters. |
logo_url_invalid | 400 | The logo address must be an https address. |
brand_color_invalid | 400 | The brand color must be a hex color such as #1d47c5. |
not_found | 404 | No such object. |
check_not_completed | 409 | The check has not completed. |
reports_daily_limit | 429 | The account has made as many reports as it may today (UTC). |
new_account_spend_limit | 429 | A new account may spend a limited number of credits in 24 hours. The limit lifts as the account ages. |
insufficient_balance | 402 | The balance is too low for this request. |
country_blocked | 403 | We cannot serve this country. |
account_not_onboarded | 403 | Finish the account details in the console first. |
live_mode_closed | 403 | Live mode is not open yet. Test keys work now. |
Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.