Submission Metadata

The data that you send for a Submission is used for analysis. The more detailed data you send, the better the quality of the analysis.

See the Submission Swagger Schema for a detailed specification.

Files vs JSON

You should ideally send as much metadata as possible, and also include the PDF. We will combine data from these. If you have the data, it's always better to provide it rather than rely on PDF extraction.

Schema

The Submission POST body has the following fields:

Field	Description
callback_url	URL for callback notifications.
file_url	URL to retrieve PDF
metadata	See below.
submission	See below.

Submission object

Field	Description
client_platform	ID of the Client Platform
doi	DOI you expect to publish. Optional.
external_id	ID within your system.
site_id	The Site ID.
display_external_id	Display ID within your system. Leave null unless absolutely needed.
initial_date_submitted	Date that this submission was first sent to your platform.
issn_l	Linking ISSN

Metadata object:

Field	Description	Extracted from PDF
abstract	Abstract text	Yes
authors	List of authors, their affiliations using ROR ids, email, name and ORCID ID.	No
orcids	If you only have ORCID IDs you can put them here. You do not need to duplicate these from `authors`.	No
reference_dois	List of DOIs in the reference.	Yes
submission_date	Date that this submission (or resubmission) was sent.	No
title	Title text	Yes

Example

Here is a full example of a Submission POST:

{
  "callback_url": "https://example.com/callbacks/clear-skies-callback",
  "file_url": "https://example.com/pdfs/1.pdf",
  "metadata": {
    "abstract": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "authors": [
      {
        "affiliation_rors": ["https://ror.org/05gq02987"],
        "email_addresses": ["test@example.com"],
        "first_name": "Josiah",
        "last_name": "Carberry",
        "orcids": ["0000-0002-1825-0097"]
      }
    ],
    "orcids": ["0000-0002-1825-0097"],
    "reference_dois": ["10.5555/12345678", "10.5555/12345679"],
    "submission_date": "2025-01-01",
    "title": "Lorem Ipsum Dolor Sit Amet"
  },
  "submission": {
    "client_platform": "ExamplePlatform",
    "doi": "10.5555/12345678",
    "external_id": "12345678",
    "site_id": "1cb21ffc-3f39-43f2-97ce-e2cf5cd312fb",
    "initial_date_submitted": "2024-04-01T00:00:00Z",
    "issn_l": "1748-7188"
  }
}