Get a Personal API Key

Fairways Debt uses OpenID Connect, through Auth0, to manage authorization and authentication.

Within Fairways Debt, the identity is certified and relayed as a JSON Web Token (JWT), which is delivered by the OAuth2 protocol.

However, some systems are incompatible with OAuth2, e.g. Microsoft Excel. API keys can nevertheless resolve this issue.

API_EN.png

 

Prerequisites

 

Navigate to Your Settings
  1. Log in to your Fairways Debt account.
  2. Click your user profile.

Dashboard_Consultant_EN.png

  1. Click API Keys.

Setting_Profile_EN.png

 

Get a Personal API Key
  1. Click Create API Key.

APIKey_EN.png

  1. Authenticate again using the same credentials.

Authenticate_EN.png

  1. Click Copy API Key and save your key safely.

Note: A key is a Universal Unique IDentifier (UUID) with a 36-character length.

  1. Click Close.

Authenticated_EN.png

Your personal key is now active.

APIKey_Created_EN.png

 

Related Documentation
Was this article helpful?
0 out of 0 found this helpful