Request a PDF report

Use this when you hold an establishment.id: it starts a job to build a PDF report of an establishment's data, and returns a request_id. Use it when you do not want to hold a connection open. To build the report in one call, use Get a PDF report with no request_id. For an account, use Request an account PDF report.

Lifecycle: POST returns 201 and a request_id. Poll the GET route with that request_id: 425 means not ready, and 200 returns pdf_report_url. If you send callback_url, Coris posts the result when it is done, as Handle async requests explains.

sequenceDiagram
  accTitle: Request a PDF report sequence diagram
  accDescr: Request a PDF report. You send POST .../merchant_profiler_pdf_report/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 no data yet. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST .../merchant_profiler_pdf_report/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 no data yet
  You->>Coris: GET ?request_id=...
  Coris-->>You: 200 complete
  Coris->>You: POST callback_url, if sent
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The Coris ID of the establishment, from establishment.id in a search or profile.

Query Params
uuid

The ID of a business search. Coris uses that search for the report.

Body Params

PDF Report Request

uri

A public HTTPS URL where Coris posts the result, if you want to skip polling.

integer

The minimum delay before the callback, in seconds, up to a recommended 3600. Use it if the callback could arrive before you have stored request_id.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Callback
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html