Retrieve Company Risk Report
/api/v2/company_risk/{api_reference}
operationId: company_risk_show
Live: https://gdapi.globaldata.net.au/api/v2/company_risk/{api_reference} · Sandbox: https://sandbox-gdapi.globaldata.net.au/api/v2/company_risk/{api_reference}
Polls the status of a company risk report that was queued via POST /company_risk. Provide the api_reference
returned from the original request to determine whether the report is ready, download the JSON payload, or stream a
PDF copy. This retrieval call is not billable and can be repeated until the report is ready.
- While the report is still compiling the API responds with HTTP
202. Keep polling with an exponential backoff. - Once ready, the endpoint returns HTTP
200with the full JSON report plus thecompany_risk_showapi_referencefor auditing. - Append
?pdf=trueto stream a formatted PDF copy of the same report. Whenpdf=true, the response body is a PDF (application/pdf) instead of JSON. - The service polls upstream data for up to 30 seconds; if no report is available at that point you will receive a
202response. Continue polling with the sameapi_reference. - A report can only be retrieved for 24 hours after the original
POST /company_riskrequest. Once that window has passed the endpoint responds with HTTP410and you need to submit a new report request.
Sandbox usage
Use the sandbox company identifiers listed under POST /company_risk to create a request, then poll this endpoint
with the returned api_reference. Marble Kookaburra Interiors Pty Ltd (ABN 84655375652, ACN 655375652) is
configured to return a 202 on the first poll so you can test retry logic.
Path parameters
| Field | Description |
|---|---|
api_referencerequired |
string (uuid) The audit reference returned when the report was queued via |
Query parameters
| Field | Description |
|---|---|
pdf |
boolean When set to |
Responses
Report is ready. Returns JSON by default or a PDF when pdf=true.
application/json
application/pdf
| Field | Description |
|---|---|
message |
string Always |
function |
string Name of the API function that handled the request. |
api_reference |
string (uuid) Audit reference for this retrieval call (not the original queue reference). |
report |
object (dynamic) Full company risk report payload. |
Also available as a PDF (application/pdf)
Report is still being prepared (returned when no data is available after the 30‑second polling window).
application/json
| Field | Description |
|---|---|
message |
string Status message indicating the report is not ready yet. |
No report was found for the provided api_reference, or it belongs to another account/environment.
application/json
| Field | Description |
|---|---|
message |
string Error message describing that the record could not be located. |
The report can no longer be retrieved. Reports are only available for retrieval for 24 hours after the original
POST /company_risk request. Submit a new report request to obtain a current report.
application/json
| Field | Description |
|---|---|
message |
string Error message describing that the report has expired. |