Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.24 KB

Release Note.md

File metadata and controls

44 lines (31 loc) · 2.24 KB

FIP Health API V1.0.0

Introduction

FIUs/TSPs want to access SAANS Data during their user journeys. This allows them to manage the user expectations and Lending FIUgate the user through the AA flow depending upon the health status of the APIs. This could lead to a higher success percentage by only raising a consent request when the likelihood of the success of the consent is much higher.

Target Users

  • FIUs
  • AA Client apps
  • FIP Health monitoring systems
  • TSPs
  • Real-time alert systems - both central and FIP specific

How the solution works

The solution requires a system that can identify FIUs that have subscribed to the service. These FIUs will expose a endpoints that receives data from the API on a 30 min frequency. This data will be calculated based on the performance of FIP over the last 3 hours. The data will be pushed to the exposed endpoint.

How to access the SAANS API

  1. Create a public endpoint: Set up an endpoint to receive notifications from the SAANS Health API service as per the specs mentioned below.

  2. Whitelist IPs on your Firewall: Whitelist the following IP addresses on your Firewall:

    • "20.204.209.246"
    • "13.71.48.89"

  3. Authenticate the Request: To further authenticate the request from the SAANS health API:

    • The API sends an Authorization header in the request with a bearer token.
    • Validate the token with the Sahamati token service’s public certificate. The validation works same way as the signing of the API request body in the AA Specs
    • Refer to this guide for instructions on validating JWT with a public key.

  4. Fill in the Form: Complete the information in the following form: Form Link

  5. Deploy on your endpoint: You will start receiving notifications on your configured endpoint on a T+1 basis.

API Broad Specs

API Specs: View Specs

Sample JSON: View Sample

SLAs: View SLAs