FIU API Specification

This API is intended to be used by AA to notify FIU about the change in consent status due to the consent management operations performed by the Customer. For more details about consent notification flow, please refer FAQ section. <br>Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.

post

/Consent/Notification

Authorizations

Header parameters

aa_api_keyanyrequired

aa_api_key is provided to FIU by the AA

x-jws-signatureanyrequired

Detached JWS of the body

x-request-metaanyrequired

It is the Base64 encoded JSON object having the identifier of the receiver (recipient-id) to whom the API call needs to be forwarded. <br/>Ex: x-request-meta: [Base64 of {"recipient-id": "SIMULATOR"}] i.e<br/> x-request-meta: eyJyZWNpcGllbnQtaWQiOiAiU0lNVUxBVE9SIn0K

Body

verstringrequired

API version

timestampstring · date-timerequired

Creation timestamp of the message

txnidstringrequired

The unique transaction identifier used for providing an end to end traceability.

Notifierobjectrequired

Information about the notifier

ConsentStatusNotificationobjectrequired

Contains the Consent ID, Consent Handle and Consent Status details.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sandbox.sahamati.org.in/router/v2/Consent/Notification' \
  --header 'aa_api_key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ver": "2.0.0",
    "timestamp": "2023-06-26T11:39:57.153Z",
    "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
    "Notifier": {
      "type": "AA",
      "id": "AA-1"
    },
    "ConsentStatusNotification": {
      "consentId": "XXXX0-XXXX-XXXX",
      "consentHandle": "XXXX0-XXXX-XXXX",
      "consentStatus": "PAUSED"
    }
  }'

200

400

401

404

409

412

500

501

503

200

{
  "response": "OK",
  "ver": "2.0.0",
  "timestamp": "2023-06-26T06:13:30.967+0000",
  "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
}

OK

This API can be used by AAs to send notifications related to Financial Information (FI) fetch to FIU/AA Client. <br>Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.

post

/FI/Notification

Authorizations

Header parameters

aa_api_keyanyrequired

aa_api_key is provided to FIU by the AA

x-jws-signatureanyrequired

Detached JWS of the body

x-request-metaanyrequired

It is the Base64 encoded JSON object having the identifier of the receiver (recipient-id) to whom the API call needs to be forwarded. <br/>Ex: x-request-meta: [Base64 of {"recipient-id": "SIMULATOR"}] i.e<br/> x-request-meta: eyJyZWNpcGllbnQtaWQiOiAiU0lNVUxBVE9SIn0K

Body

verstringrequired

API version

timestampstring · date-timerequired

Creation timestamp of the message

txnidstringrequired

The unique transaction identifier used for providing an end to end traceability.

Notifierobjectrequired

Information about the notifier

FIStatusNotificationobjectrequired

Contains the financial information fetch session id and session status details.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sandbox.sahamati.org.in/router/v2/FI/Notification' \
  --header 'aa_api_key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ver": "2.0.0",
    "timestamp": "2023-06-26T11:39:57.153Z",
    "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
    "Notifier": {
      "type": "AA",
      "id": "AA-1"
    },
    "FIStatusNotification": {
      "sessionStatus": "ACTIVE",
      "sessionId": "XXXX0-XXXX-XXXX",
      "FIStatusResponse": [
        {
          "fipID": "FIP-1",
          "Accounts": [
            {
              "linkRefNumber": "XXXX-XXXX-XXXX",
              "description": "",
              "FIStatus": "READY"
            }
          ]
        }
      ]
    }
  }'

200

400

401

404

409

412

500

501

503

200

{
  "response": "OK",
  "ver": "2.0.0",
  "timestamp": "2023-06-26T06:13:30.967+0000",
  "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
}

OK