Institution Universal ID
What is “Institution Universal ID”?
An Institution Universal Id (InstUID) is a value in the form of a GUID that represents a customer definition or configuration and provides a way to identify the route to a Product API regardless of how granular the definition of the customer environment/configuration. This InstUID will be used in JX REST APIs (v2) and replace the currently used ‘Institution’ and ‘Environment’. This will both reduce the complexity of the URL and improve the granularity available to Jack Henry Products to define the customer’s configurations.
V1 and V2 Comparison
Currently, the API (v1) design pattern for routing is as follows: /v1/institutions/{InstitutionRoutingId}/environments/{InstitutionEnvironment}/products/{ProductId}/…product resource info… InstitutionRoutingId = ABA, InstitutionEnvironment=[Prod, Beta, Test, …], ProductId = ‘jha-prodname’
The use of Institution Universal ID will change the API design pattern for routing to (v2): /v2/ {InstitutionUniversalId}/{ProductId}/…product resource info… InstitutionUniversalId = Commonly defined Universal Identity as a GUID, ProductId = ‘jha-prodname’
By using an Institution Universal ID, instead of ABA + Environment, this allows Jack Henry Products to create a unique ID for any combination or requirement of a complex customer configuration. The definition of the Universal ID can be as detailed as needed in supporting the varying customer configurations by adding metadata (brand, bank-number, bank-id, etc.) describing the uniqueness. Once a customer configuration is registered and an Institution Universal ID is assigned, it is expected that all other Jack Henry Products that have the same customer configuration WILL support the same InstUID to provide a customer configuration commonality among Products for use in API access.
Obtaining the Institution Universal ID
You will receive the InstUID value when you receive your client id, but this can also be found in the decoded JWT access token in the “instuid” property. If you do not receive the “instuid” property in your access token, it means you have a V1 client and will need to be issued a new V2 client in order to utilize the V2 URL structure.