Skip to content

Sending a Submission

Checklist

  1. Know your Client Platform
  2. Know the Site ID
  3. Configure your API and set up the domain for sending files
  4. Optionally configure your API and set up the domain and secrets for callbacks
  5. Get an API Token

To send a Submission

1: POST a submission

Use the POST /submissions/ endpoint to send a Submission. You will recieve a Submission ID.

2: Poll the Queue

Use the GET /submissions/queue endpoint to query for Submissions. It will show the most recent 1000 submissions that match your query. The queue returns the Submission ID so you can then retrieve the report.

3: Query the Submission endpoint

Use the GET /submission/{submission_id} to retrieve information for a specific Submission.

If there is a result available, it will be shown here.

You will see a heading and message in the response (some parts removed):

{
  "submission": {
    "id": "6e08d088-1684-49ac-8620-cb3eea5dac54",
    ...
  },
  "check": {
    ...
    "app_report_link": "http://example.com/submissions/6e08d088-1684-49ac-8620-cb3eea5dac54"
  },
  "report": {
    "id": "1234",
    "alert_level": "red",
    "bookkeeping": {
      ...
      "submitted": "2025-01-15T11:51:40.651273",
      "processed": "2025-09-09T10:19:04.633000Z"
    },
    "user_heading": "RED ALERT. Significant findings",
    "user_message": "There are a number of findings available on Oversight which may relate to the scientific integrity of this paper. We recommend briefly checking the article against your suitability criteria and we recommend seeking expert advice. "
  },
  "errors": []
}

4. Wait for callbacks

If you set a callback URL, you should receive callbacks when the status changes.

The app_report_link field has a URL. You should direct your user to this URL so they can read the submission.

The user must have access granted by an Org Manager in order to view the report.