Response

For each DOI in the request, an Entitlement object is included in the response, which establishes the level of entitlement, access type, document type (version of record or alternate), content type and ultimately a link to the actual resource if appropriate.

ℹ️

Each document link provided in the response body should link directly to the full text content of the document, regardless of if the user is entitled.


{
  "entitlements": [
    {
      "doi": "10.10/does.not-exist",
      "statusCode": 404
    },
    {
      "doi": "10.10/1234",
      "statusCode": 200,
      "entitled": "yes",
      "accessType": "paid",
      "source": "service_request",
      "document": "https://link-to-content-on-your-platform.com",
      "org": {
        "ipv4": "1.2.3.4"
      },
      "vor": [
        {
          "contentType": "application/pdf",
          "url": "https://link-to-content-on-your-platform.com"
        }
      ],
      "av": [],
      "updates": []
    }
  ]
}

Entitlement Object

Property	Description
`"doi"`	The document identifier
`"statusCode"`	A “HTTP Status code” like field, that reflects the entitlement response type
`"entitled"`	Possible values: `"yes"`, `"no"`, `"maybe"`
`"accessType"`	Possible values: `"open"`, `"free"`, `"permFree"`, `"paid"`
`"org"`	In the response, the `“org”` object contains the actual org ID(s) used to establish entitlement. If present, the org is known and was used to establish the level of entitlement.
`"vor"`	Version of Record object contains an array of `Documents` (see below)
`"av"`	Alternate Version object contains an array of `Documents` (see below)
`"document"`	The URL for the document’s landing page.

Document Object

In addition to the "document" property in the Entitlement object, the Document object holds additional links to other content types, such as PDF. One or more Document objects can be present in the vor and av arrays.

Property	Description
`"contentType"`	The declared MIME type of the document. Possible values:, `"application/epub+zip"`, `"text/html"`, `"application/pdf"`, `"other"`
`"url"`	A direct URL to the document. Will redirect to an IdP for authentication where appropriate (i.e. a “Smart Link”).