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"]
}

"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.

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.

ℹ️

If a user is associated with multiple organisations, multiple requests must be sent.

Property	Description
`"ipv4"`	IPv4 address of the end user (not the Integrator).
`"ipv6"`	IPv6 address of the end user (not the Integrator).
`"entityID"`	The entityID of the Organisation’s IdP.
`"openAthensOrgID"`	OpenAthens parameter. `entityID` must be present.
`"eduPersonScopedAffiliation"`	Shibboleth parameter. `entityID` must be present.
`"ringgoldID"`	Not currently used. Reserved for future proofing.
`"gridID"`	Not currently used. Reserved for future proofing.
`"rorID"`	Not currently used. Reserved for future proofing.