Authentication

Two headers are required as part of the authentication process: the authorization header and the FI reference ID.

1. Authorization Header (Basic Auth)

The Konsentus APIs use Basic Auth, this document details how to authenticate to the APIs using this method.

The HTTP Authorization request header contains the credentials to authenticate a user agent with the Konsentus server. These credentials are provided as part of the onboarding process. If credentials are invalid or not sent the server will respond with a 401Unauthorized status.

Syntax

Authorization: <type> <credentials>
Field Description
type Authentication type - this must be set to Basic
credentials The Client ID and Client Secret combined with a colon and base64encoded (see example below).

Stub Authorization Data

Stub Authorization Header Values

Field Value Explanation
type Basic Always set to Basic
credentials YXBpLWNvbnN1bWVyLWlkOnBhc3N3b3Jk client-id:client-secret as abase64encoded string

Example

Authorization: Basic YXBpLWNvbnN1bWVyLWlkOnBhc3N3b3Jk

References

MDN Basic Auth Documentation

2. FI Reference ID Header

This header is a reference to the FI that is requesting the data. We expect this to be the registered ID of the Financial Institution.

If you are consuming the Konsentus APIs as a financial institution directly, then this value will be constant and established at the time of your on-boarding. If you are consuming the Konsentus APIs on behalf of a financial institution, then this value should be provided to you by the institution.

Syntax

fi_reference_id: <id>

Validation requirements

  • characters allowed: any
  • minimum length: 6
  • maximum length: 128
Field Description
fi_reference_id A string representing the FI referenced within the system

Stub Authorization Data

Stub Authorization Header Values

Field Value Explanation
fi_reference_id testFI This must be sent consistently so that it is the same every time the APIs are being used for a particular FI.

Example

fi_reference_id: testFI
Last Updated: 6/13/2019, 11:05:51 AM