Fair Use Specs

Sahamati will implement the following additional APIs that can be used by FIUs & AAs to retrieve data such as Consent Template definitions, FIU profile and Fair Use Policy rules which are required to validate the consent request (i.e. execute the policy rules) and take necessary action.

API Specification

Fair Use Parameters API

API for retrieving the Fairuse Consent parameters master data list. Each Consent purpose (template) defines the usecase, purpose along with consent parameters explaining the upper bound or the limits.

This API authorized using the member or user access token.

POSThttps://api.uat.sahamati.org.in/v1/data/fairuse-params/list

Authorization

bearerAuth

Body

application/json

filters*object

Filter criteria for retrieving consent purposes

Response

200401

List of consent parameters

Body

application/json

verstring

Example: "1.0.0"

timestampstring (date-time)

Example: "2024-07-16T11:33:34.509Z"

txnIdstring

Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"

resultarray of ConsentParams (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.uat.sahamati.org.in/v1/data/fairuse-params/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {}
    }),
});
const data = await response.json();

Response

200401

{
  "ver": "1.0.0",
  "timestamp": "2024-07-16T11:33:34.509Z",
  "txnId": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "result": [
    {
      "id": "dfc571ed-863f-4f90-a249-07d3b2497f57",
      "description": "",
      "usecase": {
        "code": "U001",
        "category": "Underwriting Risk",
        "description": "Underwriting a loan application",
        "publisher": "Sahamati"
      },
      "purposeCode": "103",
      "status": "Active",
      "publisher": "Sahamati",
      "consentParams": {
        "fiTypes": [
          "DEPOSIT",
          "TERM_DEPOSIT"
        ],
        "consentTypes": [
          "PROFILE",
          "SUMMARY"
        ],
        "fetchType": "ONETIME",
        "frequency": {
          "max": {
            "unit": "MONTH",
            "value": 1
          }
        },
        "FIDataRange": {
          "max": {
            "unit": "MONTH",
            "value": 14
          }
        },
        "consentExpiry": {
          "max": {
            "unit": "MONTH",
            "value": 1
          }
        },
        "dataLife": {
          "max": {
            "unit": "MONTH",
            "value": 1
          }
        },
        "consentMode": [
          "STORE",
          "VIEW"
        ],
        "dataFilter": []
      }
    }
  ]
}

Purpose Code List API

API for retrieving the Fairuse Purpose code master data list.

This API authorized using the member or user access token.

POSThttps://api.uat.sahamati.org.in/v1/data/purpose-code/list

Authorization

bearerAuth

Body

application/json

filters*object

Filter criteria for retrieving consent purposes

Response

200401

List of consent purposes codes

Body

application/json

verstring

Example: "1.0.0"

timestampstring (date-time)

Example: "2024-07-16T11:33:34.509Z"

txnIdstring

Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"

resultarray of Purpose (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.uat.sahamati.org.in/v1/data/purpose-code/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {}
    }),
});
const data = await response.json();

Response

200401

{
  "ver": "1.0.0",
  "timestamp": "2024-07-16T11:33:34.509Z",
  "txnId": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "result": [
    {
      "code": "103",
      "category": "Financial Reporting",
      "description": "To process your loan application",
      "publisher": "Sahamati"
    }
  ]
}

Sahamati Network Rules (Policies) API

API for retrieving the Sahamati Network Rules List.

This API authorized using the member or user access token.

POSThttps://api.uat.sahamati.org.in/v1/data/network-rules/list

Authorization

bearerAuth

Body

application/json

filters*object

Filter criteria for retrieving consent purposes

Response

200401

List of consent parameters

Body

application/json

verstring

Example: "1.0.0"

timestampstring (date-time)

Example: "2024-07-16T11:33:34.509Z"

txnIdstring

Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"

resultarray of NetworkRule (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.uat.sahamati.org.in/v1/data/network-rules/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {}
    }),
});
const data = await response.json();

Response

200401

{
  "ver": "1.0.0",
  "timestamp": "2024-07-16T11:33:34.509Z",
  "txnId": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "result": [
    {
      "id": "dfc571ed-863f-4f90-a249-07d3b2497f57",
      "name": "Fairuse Network Rule for Purpose 103",
      "description": "",
      "status": "Active",
      "fairuseParams": "dfc571ed-863f-4f90-a249-07d3b2497f57",
      "category": "Fairuse",
      "policyCode": "https://play.openpolicyagent.org/p/gmgcxyvEZ5",
      "publisher": "Sahamati"
    }
  ]
}

Telemetry Specification

ToDo: The telemetry Specification for the Network Rule Execution will be published soon... The Network Rule Execution should generate the telemetry

LOG - to explain the execution details.

METRIC - to record the output of the execution for the input.