Browse endpoints

Retrieve Company Risk Report

GET /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 200 with the full JSON report plus the company_risk_show api_reference for auditing.
  • Append ?pdf=true to stream a formatted PDF copy of the same report. When pdf=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 202 response. Continue polling with the same api_reference.
  • A report can only be retrieved for 24 hours after the original POST /company_risk request. Once that window has passed the endpoint responds with HTTP 410 and 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

FieldDescription
api_referencerequired string (uuid)

The audit reference returned when the report was queued via POST /company_risk.

Example: fe4291ca-d831-4760-96df-c9cb03b3cd95

Query parameters

FieldDescription
pdf boolean

When set to true, returns the report as a PDF document instead of JSON. Omit (or send false) to receive the JSON payload.

Default: false

Responses

200

Report is ready. Returns JSON by default or a PDF when pdf=true.

application/json application/pdf
FieldDescription
message string

Always Ok when the report payload is returned.

Example: Ok

function string

Name of the API function that handled the request.

Example: company_risk_show

api_reference string (uuid)

Audit reference for this retrieval call (not the original queue reference).

Example: 7cbb094c-0f27-42f4-9f36-9cf0b2f6d5ff

report object (dynamic)

Full company risk report payload.

Also available as a PDF (application/pdf)

202

Report is still being prepared (returned when no data is available after the 30‑second polling window).

application/json
FieldDescription
message string

Status message indicating the report is not ready yet.

Example: Report is still being processed. Please try again later.

404

No report was found for the provided api_reference, or it belongs to another account/environment.

application/json
FieldDescription
message string

Error message describing that the record could not be located.

Example: Not Found.

410

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
FieldDescription
message string

Error message describing that the report has expired.

Example: This report has expired. Please request a new one

Standard error responses: 400 401 402 403 429 5XX See common error responses