Request

The Entitlement API accepts a POST request. The request body is a JSON object that has two properties "dois" and an optional "org":

{
  "org": {
    "ipv4": "1.2.3.4"
  },
  "dois": [
    "10.10/1234",
    "10.10/5678",
    {
      "title": "Effects of Vitamin C",
      "journal": "Journal of Medicine",
      "authors": ["John Doe", "Jane Doe"],
      "year": 2020,
      "uid": "b2d8bfea-050e-4293-af31-725815a1fa8b"
    },
    {
      "title": "Semiconductors in chip manufacturing",
      "preprintDoi": "10.10/1111-preprint",
      "uid": "fb64fcc0-3e5e-479f-a34e-f8af5f8ce2a9"
    }
  ]
}

• "org" is an optional object that contains one or more identifiers for a user. This information is passed to publishers to help determine if the user is entitled to the requested DOI(s).
• "dois" is an array of DOIs to check for entitlements.

DOIs

The dois array can contain DOI strings or DOI objects, which have the following shape:

When a DOI string is supplied in the array, GetFTR will look up entitlement data for that exact DOI. When a DOI object is supplied, GetFTR will try to find the latest published version of the document based on the metadata in the object, and provide entitlement data for that version.

If we can’t find a published version, the response will contain an "unknown" DOI with status code 404 and the "uid", if it was supplied in the request. When the request contains multiple DOI objects, it is highly advised to include "uid" in each of them.

Org Identifiers

Describes a single Organisation and contains all the IDs available to identify it, with a minimum of at least one. Integrators are encouraged to share all known IDs.