Linking with 'institutionId'


All Credo URLs support the use of the institutionId parameter, which uses a unique account ID number to facilitate remote authentication. Any link that includes this parameter will redirect remote users to a log-in page specific to your account and prompt them to log in via your preferred remote authentication method. After authentication, the user will land directly on the page they were trying to access. If your account shares a proxy server or IP ranges with any other accounts, using the institutionId parameter will also ensure that your users reach the correct account.

The Preferred Remote Authentication method must be designated in your Credo Admin account. The options are proxy, library card, username and password, Shibboleth, or OpenAthens. The proxy set-up is self-service; other methods must be set up with the help of Credo support (

An example entry link with the account parameter looks like this:****

With an example Id number in place of the ****, this might look like:

Note that the institutionId parameter is case-sensitive. It must be used with exactly this capitalization to work correctly.

How to find your institutionId

There are a few ways to find your account’s Credo Id.

  1. Ask Credo support - Simply email, and we’ll be happy to provide you with the correct Id number.
  2. Check your Credo permalinks - The institutionId parameter is now included in your Credo permalinks. To find it, click the chain link icon on any Credo page and look for ‘?institutionId=’ in the URL. If it does not appear, please email - you may not have a remote access method configured for your account.
  3. Check your MARC records in Admin - All Credo MARC records have the institutionId parameter in the 856 field URL.
  4. Your Credo API Key - If you already know your Credo API key, you know your institutionId - it is the same value! The API Key is also used in the Credo EDS Widget, so you may have already requested it if you use this integration.

How to use

Recently, we began including this parameter in Credo permalinks, MARC records, citations, etc. If you would like to update any existing Credo links on your library website, LibGuides, catalog, etc., simply add ?institutionId=**** to the end of the Credo URL. (A few link types, such as the search results page or the Find a Book page with subject filters applied, use “&” instead of “?”, ie &institutionId=****. Please contact if you’d like help constructing the links).

In particular, we recommend the institutionId option if you do not use a proxy for access, or if you share a proxy server with other institutions, since it will help students log in to the correct account.

0 out of 0 found this helpful