Appearance
Download the official receipt PDF of a patent event
GET /api/v2/external/patents/{patentId}/events/{eventId}/documents/official-receiptAuthentication: x-api-key header, with the patents:read scope. See Authentication and limits.
Returns the official receipt PDF for a patent event, identified by the patent UUID and the event UUID. Responds 404 until an official receipt exists.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
eventId | string | Yes | The opaque, stable Renewr UUID of the patent event. |
patentId | string | Yes | The opaque, stable Renewr UUID of the patent. |
Response
200 The official receipt PDF file (attachment, RFC 6266 Content-Disposition).
The response is a binary PDF stream (application/pdf), delivered as an attachment with an RFC 6266 Content-Disposition filename. See Downloading documents.
Errors
Errors use the application/problem+json envelope with stable machine-readable codes. See the Errors guide.
| Status | Description |
|---|---|
| 400 | Validation failed (validation_failed): carries per-field errors[] with RFC 6901 JSON Pointers. |
| 401 | Missing or invalid API key (invalid_api_key), or expired key (api_key_expired). |
| 403 | API key lacks the required scope (insufficient_scope, with requiredScope extension) or the operation is not enabled for this client (forbidden). |
| 404 | The resource does not exist in your portfolio (not_found). |
| 429 | Daily API call limit exceeded (rate_limit_exceeded): the Retry-After header gives the seconds until reset. |
Example request
bash
curl "https://api.renewr.example/api/v2/external/patents/$PATENT_ID/events/$EVENT_ID/documents/official-receipt" \
-H "x-api-key: $RENEWR_API_KEY"