Skip to content

Submission IDs

A Submission is assigned an ID when it is created. This ID is used to check status and retrieve the report URL.

External IDs

Manuscript Tracking Platforms have their own internal ID. This should be supplied as the external_id for the submission.

A Submission's External ID must be unique within its Client Platform.

The External ID is shown to the user in Oversight, and they may use it to search for submissions.

Display External IDs

Some Manuscript Tracking Platforms display an ID to the user that is not the same as unique submission ID. We call this the Display External ID. If you submit this using the display_external_id field, we will show it to the user instead. This ID is not required to be unique.

Note

If you do intend to use the display_external_id please contact us to discuss, as it's considered an edge case. There may be a better way to solve your problem.

Versions and Resubmission

Some Platforms will create a new External ID for a resubmission, e.g. the original submission ID being ABC-123, and a resubmission being ABC-123.R2. If this is the case, use the new submission ID when you send the resubmission.

Note

We have the ability to link together resubmissions using new version numbers. If you do this, please let us know and we will enable the feature for you.

Some platforms re-use the same Submission ID for resubmissions. This is supported, and when you re-send a Submission we will create a new Check with the updated metadata. This Check will replace the previous one in Oversight.