Authentication

Authentication is available via API Key Auth in the form of a subscription key value which is passed in the header of each request.

Request Header: Ocp-Apim-Subscription-Key

Required Header

You must pass a subscription key with every request via a request header of 'Ocp-Apim-Subscription-Key'. You can find this value on your User Profile.

User Profile page screenshot

User Profile

Your user profile is the place to access subscription keys which grant access per B2B connection. These keys are paired in primary and secondary to support regular cycling and can be regenerated via this self-service menu to support your own security policies.

For example, if you, the integration partner, is connecting to our customer, Customer A, you will be assigned a subscription granting access to communicate with that customer. It would show under your subscription details as an individual subscription.