Skip to content

AA API Sandbox

This is a Sandbox implementation of the AA API and can be used for testing the Account Aggregator flows as part of the ecosystem.

Request headers

Below http headers need to be set as part of each request

Key Value
content-Type application/xml
fip_api_key Please email us on info@cookiejar.co.in for obtaining the key

API Request

The API URL to be used is <Root API Endpoint>/<FIP API> as per ReBIT AA API Specs.

Consents

This API is intended for AA Client to request generation of digitally signed consent artefacts.

HTTP METHOD: POST

URL: http://aa.finvu.in/API/V1/Consent

Request Body

{
  "ver": "1.0",
  "timestamp": "2019-05-02T06:49:35.645Z",
  "txnid": "4a4adbbe-29ae-11e8-a8d7-0289437bf331",
  "ConsentDetail": {
    "consentStart": "2019-12-06T11:39:57.153Z",
    "consentExpiry": "2019-12-06T11:39:57.153Z",
    "consentMode": "VIEW",
    "fetchType": "ONETIME",
    "consentTypes": [
      "BALANCE"
    ],
    "fiTypes": [
      "DEPOSIT"
    ],
    "DataConsumer": {
      "id": "fiu-1"
    },
    "Customer": {
      "id": "jay55@finvu.in"
    },
    "Purpose": {
      "code": "101",
      "refUri": "https://api.rebit.org.in/aa/purpose/101.xml",
      "text": "Wealth management service",
      "Category": {
        "type": "string"
      }
    },
    "FIDataRange": {
      "from": "2018-12-06T11:39:57.153Z",
      "to": "2019-12-06T11:39:57.153Z"
    },
    "DataLife": {
      "unit": "MONTH",
      "value": 0
    },
    "Frequency": {
      "unit": "MONTH",
      "value": 0
    },
    "DataFilter": [
      {
        "type": "TRANSACTIONAMOUNT",
        "operator": ">=",
        "value": 20000
      }
    ]
  }
}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-28T12:58:29.654+0000",
    "txnid": "4a4adbbe-29ae-11e8-a8d7-0289437bf331",
    "Customer": {
        "id": "jay55@finvu.in"
    },
    "ConsentHandle": "2d216b9b-a8f3-48c0-b565-e8f35e7c2273"
}

/Consent/handle/{consentHandle}

This API is intended for checking the status of a previously submitted Consent Artefacts creation request

HTTP METHOD: GET

URL: http://aa.finvu.in/API/V1/Consent/handle/{consentHandle}

Request Body

No Request Body expected

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-28T12:58:29.654+0000",
    "txnid": "4a4adbbe-29ae-11e8-a8d7-0289437bf331",
    "ConsentHandle": "2d216b9b-a8f3-48c0-b565-e8f35e7c2273",
    "ConsentStatus": {
        "id": "ce721611-0ed1-4043-b54a-9493b4ad3007",
        "status": "READY"
    }
}

Consents/{id}

This API is intended for fetching the information associated with the specific consent.

HTTP METHOD: GET

URL: http://aa.finvu.in/API/V1/Consent/{id}

Request Body

No Request Body expected

Response Expected:

{
    "ver": "1.0",
    "txnid": "5d9fce7c-ca84-4107-a670-c3b0837c5ef1",
    "consentId": "ce721611-0ed1-4043-b54a-9493b4ad3007",
    "status": "ACTIVE",
    "createTimestamp": "2019-05-28T11:38:20.380+0000",
    "ConsentDetail": {
        "consentStart": "2019-05-28T11:38:20.380+0000",
        "consentExpiry": "2020-05-28T11:38:20.381+0000",
        "consentMode": "VIEW",
        "fetchType": "ONETIME",
        "consentTypes": [
            "BALANCE",
            "TRANSACTIONS",
            "PROFILE"
        ],
        "fiTypes": [
            "DEPOSIT",
            "TERM-DEPOSIT"
        ],
        "DataConsumer": {
            "id": "cookiejar-aa@finvu.in",
            "type": "AA"
        },
        "DataProvider": {
            "id": "BARB0KIMXXX",
            "type": "FIP"
        },
        "Customer": {
            "id": "jayavants"
        },
        "Accounts": [
            {
                "fiType": "DEPOSIT",
                "fipId": "BARB0KIMXXX",
                "accType": "SAVINGS",
                "linkRefNumber": "UBI485964579",
                "maskedAccNumber": "UBI85217881279"
            },
            {
                "fiType": "DEPOSIT",
                "fipId": "BARB0KIMXXX",
                "accType": "SAVINGS",
                "linkRefNumber": "UBI4859645",
                "maskedAccNumber": "UBI852178812"
            }
        ],
        "Purpose": {
            "code": "101",
            "refUri": "https://api.rebit.org.in/aa/purpose/101.xml",
            "text": "Wealth management service",
            "Category": {
                "type": "purposeCategoryType"
            }
        },
        "FIDataRange": {
            "from": "2019-05-28T11:38:20.383+0000",
            "to": "2020-05-28T11:38:20.381+0000"
        },
        "DataLife": {
            "unit": "MONTH",
            "value": 4
        },
        "Frequency": {
            "unit": "HOUR",
            "value": 4
        },
        "DataFilter": [
            {
                "type": "TRANSACTIONAMOUNT",
                "operator": ">",
                "value": "20000"
            }
        ]
    },
    "consentDetailDigitalSignature": "Signature of AA as defined in W3C standards; Base64 encoded",
    "ConsentUse": {
        "logUri": "consent_use_loguri",
        "count": 2,
        "lastUseDateTime": "2019-05-28T11:38:20.379+0000"
    }
}

/FI/request

The FIU or the User submits the Consent IDs of the consents required for fetching financial information from the FIP(s).

HTTP METHOD: POST

URL: http://aa.finvu.in/API/V1/FI/request

Request Body

{
    "ver": "1.0",
    "timestamp": "2018-12-06T11:39:57.153Z",
    "txnid": "e8cc6822-d4bb-4eb1-9e1b-4996fbff8acb",
    "FIDataRange": {
        "from": "2018-12-06T11:39:57.153Z",
        "to": "2020-12-06T11:39:57.153Z"
    },
    "Consent": {
        "id": "ce721611-0ed1-4043-b54a-9493b4ad3007",
        "digitalSignature": "Digital signature of the consentDetail section in the consent Artefact"
    },
    "KeyMaterial": {
    "cryptoAlg": "ECDHE",
    "curve": "Curve25519",
    "params": "string",
    "DHPublicKey": {
      "expiry": "2019-06-01T09:58:50.505Z",
      "Parameters": "Param 1",
      "KeyValue": "TC/w081h2ps3lfQBymsSPFB+t7vV89RAndZjOlvPJDc="
    },
    "Nonce": "b6f6bcbc-d02a-4c68-8868-da5a3de60b33",
    "Signature": "AA signature"
  }
}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-28T12:35:16.484+0000",
    "txnid": "e8cc6822-d4bb-4eb1-9e1b-4996fbff8acb",
    "consentId": "ce721611-0ed1-4043-b54a-9493b4ad3007",
    "sessionId": "fd1dc34c-da66-4c5d-8101-260c68286836"
}

/FI/fetch/{sessionId}

Once FIU receives the notification from AA, using digitally signed consent request received from AA, this API can be used to fetch the financial information from the AA.

HTTP METHOD: GET

URL: http://aa.finvu.in/API/V1/FI/fetch/{sessionId}

Response Expected:

{
    "ver": "e8cc6822-d4bb-4eb1-9e1b-4996fbff8acb",
    "timestamp": "2018-12-06T11:39:57.153+0000",
    "txnid": "e8cc6822-d4bb-4eb1-9e1b-4996fbff8acb",
    "FI": [
        {
            "fipID": "80a78190-d2c8-4299-a3f4-13413b77c9f2",
            "data": [
                {
                    "linkRefNumber": "UBI485964579",
                    "maskedAccNumber": "UBI85217881279",
                    "encryptedFI": "AAAAAgAAA7YAAAAMVUJJNDg1OTY0NTc5AAAADlVCSTg1MjE3ODgxMjc5AAADkF80LgtYEh5qq2jS+rkHuD+X9xs9A+TYj8s85ojT2N3SbvVm0HuC2YsnZ4nk7711L8i8hTpY35vxE1CPcTMseV2nCmmuO1g+jiwrmLfGM1jlxfr2YYEbO1rjE33XiiXtNNiomOkDZP7ZwvarNGuPKXLpksHq1J9UMPT3Q9+GCQfEMmcdg7bJEgRyPVy+2oLJPjBGeAXQTziR0bPFMgDipdMaTSSGjIEan0QX5S7d+5LlIZwEuq2MnB4hgN/ZIGnE6k2OQnJWqyZc3GoSwQhbhA3Hd8nJX5FWkskK9lpJpgKQryGUVDph93wxJw4YiY7CAYUVNLfSQ3dtkN0r2HZFv5SO+FvC2KPenLzHAYGh+pnXOt7AGScZGhEMyRZBKPTSpJatZtOoBl+mGwvXfXYGNQh0WDXEuhe7YXvrsbbFHMdwztJNKw0xSAM+YWGQVRPb2B32KN5koGRIRWGfeguOsMuM7U1W4FBGzROAthuJxouIKDTL/KW9BvNZ5zHaWtJ2Zfn7/SCaSvmov4Nr1/5kq/Xv4q3OCyYMQSpeAIMGH427IQpZcHLBC1isd+RPZ1DZ3PZsA/0j+5HDhH2EWsAZUhoCcidWUhB0JJxPCuJHiDb+yOwV7PXDSNVBLd0fGkxoFUKM6mT5nHb29p7ogZvFjyVwAmqg0nwQXOQplW+bMqQey3RHsUSjqr8TW0ywPpDw44xcttdahpqxrHsaN016NiO1SgLTmeVcvuW0wHglsWb/TIjc7pWAYhMu/7XHjBCuiYjXrf6aukEJdgebSPqLX9BiFGLWS6FMQV6zVf7mE0TG7eGFiAfgJiWAg8/riSdeda1VudtL0VH0/z6h+38dphf8NOrPIdufJqC4LuoZuuL4OcXanDeqVLRJ8jAHCnyDk/2aGzaQTrX8cq5pSLohzoAauPOiJPg/DVETTp+Y1zIb5xxvbQWkyVnNOPskQf2MX230f/DOkI7sM9/ahyPaxAXgm2qiy29wd4gShsf+HIPeCO2wM6yTehKlbyctoCUbbg/OraUXMzhZuugPNsSlVE9UnM9iQ0d1I7LCtVrPuk158onXfXel/RcMy9qeNJB/h3YFpovhiQGGUJV08TZUdNOAksnIAH0IwmtkocjUo9puIFerCTt6FzdcKmoBbYId4DQqcBInulgKpPveVmatCScn4siVoeqFbq6RTQ7gRQ0OV8/pBnuPlpdgHrpbdQBOjgAAA7IAAAAKVUJJNDg1OTY0NQAAAAxVQkk4NTIxNzg4MTIAAAOQXzQuC1gSHmqraNL6uQe4P5f3Gz0D5NiPyzzmiNPY3dJu9WbQe4LZiydnieTvvXUvyLyFOljfm/ETUI9xMyx5XacKaa47WD6OLCuYt8YzWOXF+vZhgRs7WuMTfdeKJe002KiY6QNk/tnC9qs0a48pcumSwerUn1Qw9PdD34YJB8QyZx2DtskSBHI9XL7agsk+MEZ4BdBPOJHRs8UyAOKl0xpNJIaMgRqfRBflLt37kuUhnAS6rYycHiGA39kgacTqTY5CclarJlzcahLBCFuEDcd3yclfkVaSyQr2WkmmApCvIZRUOmH3fDEnDhiJjsIBhRU0t9JDd22Q3SvYdkW/lEoLFm/7dDbOfhEC+pvAelu9NefbIcqpyq92PWaUHw6POoL1iJ+5e4OUk4rS5EnU5/vl1Wb9TmHWOIdmufI27NJB6o2MBt3v8TQdUzDwGe67ZIuiRUJGm8DqHfSKesHZBzOACdMphvmcTb0h/VjIrR5v/Tt6rkEKWZhqlpwAH969yDJ+Xg6eEE+bQDWAH4a1lEex49VQ67y2FT9oIwdPk8lyW9Z91ZNiyLUTmRXfE1KuUJZUVeSJhbQGGge1LUUiq7vOH42mgMVHEaplzlxFnfWAWyXkgFBZIOkjolyxupgqWKWigSIRPoQc2fttgLWcVCG6gfTSkMDmvUswXWpEPiB3HVi7OWZ3tH262Udv8i9F/KDYLeuYD8vx7qxm/FKKfgD0G1/gSuDs/LCwDqed+qJtPLewWVqVMwL+Iz5ZEw59+esnTIk26GDdKvjZXSeIA2Z3Xu00SMVYrBeF9vpdpwAfjRsTDCKWBEFwQyyKrRhP8BEzfIDbuEZhGlehPguG+ymrTvgkMZvBO5ACofuUwILXr+JERMpIT0q/Y3fD1WYOg+/1ctNC8041eWdHkD34NFyMsj4RTnQmnx0HkLM0ZiU0jMMkOSFi1ly603ClLUFxF8QFkKCn7YhvLZFNcUnDD1vjQKX70W6SlGg2DAOfjXbfefuzle23l3EktC4N1VMgMnH71NBuQEVk0Gm7fjK1u3hGaSruIfTyAH+OpkCzV5jW908vQ5I4Eynb5e9PpOP5T689thYeZYl3AQgDswnK6gsGruce7t0iKhIMrSAePu7frTi2uuDdriOnj+IPsWrDl77NAQs3Xc37GURz5A9aPE+/zwC5mWIVPG7JoOtz658WdcWdTZ90PM9Qi31tA6dd"
                },
                {
                    "linkRefNumber": "UBI4859645",
                    "maskedAccNumber": "UBI852178812",
                    "encryptedFI": "AAAAAgAAA7YAAAAMVUJJNDg1OTY0NTc5AAAADlVCSTg1MjE3ODgxMjc5AAADkF80LgtYEh5qq2jS+rkHuD+X9xs9A+TYj8s85ojT2N3SbvVm0HuC2YsnZ4nk7711L8i8hTpY35vxE1CPcTMseV2nCmmuO1g+jiwrmLfGM1jlxfr2YYEbO1rjE33XiiXtNNiomOkDZP7ZwvarNGuPKXLpksHq1J9UMPT3Q9+GCQfEMmcdg7bJEgRyPVy+2oLJPjBGeAXQTziR0bPFMgDipdMaTSSGjIEan0QX5S7d+5LlIZwEuq2MnB4hgN/ZIGnE6k2OQnJWqyZc3GoSwQhbhA3Hd8nJX5FWkskK9lpJpgKQryGUVDph93wxJw4YiY7CAYUVNLfSQ3dtkN0r2HZFv5SO+FvC2KPenLzHAYGh+pnXOt7AGScZGhEMyRZBKPTSpJatZtOoBl+mGwvXfXYGNQh0WDXEuhe7YXvrsbbFHMdwztJNKw0xSAM+YWGQVRPb2B32KN5koGRIRWGfeguOsMuM7U1W4FBGzROAthuJxouIKDTL/KW9BvNZ5zHaWtJ2Zfn7/SCaSvmov4Nr1/5kq/Xv4q3OCyYMQSpeAIMGH427IQpZcHLBC1isd+RPZ1DZ3PZsA/0j+5HDhH2EWsAZUhoCcidWUhB0JJxPCuJHiDb+yOwV7PXDSNVBLd0fGkxoFUKM6mT5nHb29p7ogZvFjyVwAmqg0nwQXOQplW+bMqQey3RHsUSjqr8TW0ywPpDw44xcttdahpqxrHsaN016NiO1SgLTmeVcvuW0wHglsWb/TIjc7pWAYhMu/7XHjBCuiYjXrf6aukEJdgebSPqLX9BiFGLWS6FMQV6zVf7mE0TG7eGFiAfgJiWAg8/riSdeda1VudtL0VH0/z6h+38dphf8NOrPIdufJqC4LuoZuuL4OcXanDeqVLRJ8jAHCnyDk/2aGzaQTrX8cq5pSLohzoAauPOiJPg/DVETTp+Y1zIb5xxvbQWkyVnNOPskQf2MX230f/DOkI7sM9/ahyPaxAXgm2qiy29wd4gShsf+HIPeCO2wM6yTehKlbyctoCUbbg/OraUXMzhZuugPNsSlVE9UnM9iQ0d1I7LCtVrPuk158onXfXel/RcMy9qeNJB/h3YFpovhiQGGUJV08TZUdNOAksnIAH0IwmtkocjUo9puIFerCTt6FzdcKmoBbYId4DQqcBInulgKpPveVmatCScn4siVoeqFbq6RTQ7gRQ0OV8/pBnuPlpdgHrpbdQBOjgAAA7IAAAAKVUJJNDg1OTY0NQAAAAxVQkk4NTIxNzg4MTIAAAOQXzQuC1gSHmqraNL6uQe4P5f3Gz0D5NiPyzzmiNPY3dJu9WbQe4LZiydnieTvvXUvyLyFOljfm/ETUI9xMyx5XacKaa47WD6OLCuYt8YzWOXF+vZhgRs7WuMTfdeKJe002KiY6QNk/tnC9qs0a48pcumSwerUn1Qw9PdD34YJB8QyZx2DtskSBHI9XL7agsk+MEZ4BdBPOJHRs8UyAOKl0xpNJIaMgRqfRBflLt37kuUhnAS6rYycHiGA39kgacTqTY5CclarJlzcahLBCFuEDcd3yclfkVaSyQr2WkmmApCvIZRUOmH3fDEnDhiJjsIBhRU0t9JDd22Q3SvYdkW/lEoLFm/7dDbOfhEC+pvAelu9NefbIcqpyq92PWaUHw6POoL1iJ+5e4OUk4rS5EnU5/vl1Wb9TmHWOIdmufI27NJB6o2MBt3v8TQdUzDwGe67ZIuiRUJGm8DqHfSKesHZBzOACdMphvmcTb0h/VjIrR5v/Tt6rkEKWZhqlpwAH969yDJ+Xg6eEE+bQDWAH4a1lEex49VQ67y2FT9oIwdPk8lyW9Z91ZNiyLUTmRXfE1KuUJZUVeSJhbQGGge1LUUiq7vOH42mgMVHEaplzlxFnfWAWyXkgFBZIOkjolyxupgqWKWigSIRPoQc2fttgLWcVCG6gfTSkMDmvUswXWpEPiB3HVi7OWZ3tH262Udv8i9F/KDYLeuYD8vx7qxm/FKKfgD0G1/gSuDs/LCwDqed+qJtPLewWVqVMwL+Iz5ZEw59+esnTIk26GDdKvjZXSeIA2Z3Xu00SMVYrBeF9vpdpwAfjRsTDCKWBEFwQyyKrRhP8BEzfIDbuEZhGlehPguG+ymrTvgkMZvBO5ACofuUwILXr+JERMpIT0q/Y3fD1WYOg+/1ctNC8041eWdHkD34NFyMsj4RTnQmnx0HkLM0ZiU0jMMkOSFi1ly603ClLUFxF8QFkKCn7YhvLZFNcUnDD1vjQKX70W6SlGg2DAOfjXbfefuzle23l3EktC4N1VMgMnH71NBuQEVk0Gm7fjK1u3hGaSruIfTyAH+OpkCzV5jW908vQ5I4Eynb5e9PpOP5T689thYeZYl3AQgDswnK6gsGruce7t0iKhIMrSAePu7frTi2uuDdriOnj+IPsWrDl77NAQs3Xc37GURz5A9aPE+/zwC5mWIVPG7JoOtz658WdcWdTZ90PM9Qi31tA6dd"
                }
            ],
            "KeyMaterial": {
                "cryptoAlg": "ECDHE",
                "curve": "Curve25519",
                "params": "None",
                "DHPublicKey": {
                    "expiry": "2019-05-29T00:00:00.000+0000",
                    "Parameters": "BBD6p/fEXFHZa8hTPq3q+MT6",
                    "KeyValue": "rw+gvnzMZucx7LNEA1NJdsHzvpp47hgAa7ENRqLhVjo="
                },
                "Nonce": "77e4b597-ea3a-476e-bcd6-278c037b73ed",
                "Signature": "Signature of AA"
            }
        }
    ]
}

API handles the notifications corresponding to the events generated during consent flow and data flow.

HTTP METHOD: POST

URL: http://aa.finvu.in/API/V1/Consent/Notification

Request Body

{
  "ver": "1.0",
  "timestamp": "2018-12-06T11:39:57.153Z",
  "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
  "Notifier": {
    "type": "FIP",
    "id": "BARB0KIMXXX"
  },
  "ConsentStatusNotification": {
    "consentId": "ce721611-0ed1-4043-b54a-9493b4ad3007",
    "ConsentStatus": "REJECTED"
  }
}

Response Expected:

200 OK

FI Notification

API handles the notifications corresponding to the events generated during consent flow and data flow.

HTTP METHOD: POST

URL: http://aa.finvu.in/API/V1/FI/Notification

Request Body

{
  "ver": "1.0",
  "timestamp": "2019-07-07T10:23:57.153Z",
  "txnid": "ac373c6b-342b-4b36-b516-ac3a3c96fd9e",
  "Notifier": {
    "type": "FIP",
    "id": "BARB0KIMXXX"
  },
  "FIStatusNotification": {
    "sessionId": "XXXX0-XXXX-XXXX",
    "sessionStatus": "ACTIVE",
    "FIStatusResponse": [
      {
        "fipID": "BARB0KIMXXX",
        "Accounts": [
          {
            "linkRefNumber": "BOBREF7779100",
            "FIStatus": "READY",
            "description": "ACTIVE"
          }
        ]
      }
    ]
  }
}

Response Expected:

200 OK

API handles the notifications corresponding to the events generated during consent flow and data flow.

HTTP METHOD: POST

URL: http://aa.finvu.in/API/V1/Account/link/Notification

Request Body

{
  "ver": "1.0",
  "timestamp": "2018-12-06T11:39:57.153Z",
  "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
  "Notifier": {
    "type": "FIP",
    "id": "SBIN"
  },
  "AccountLinkStatusNotification": {
    "maskedAccNumber": "XXXXXXXX6001",
    "customerAddress": "test9",
    "linkRefNumber": "2a6fd402-1894-4533-b9d3-be55d562130a",
    "linkStatus": "DELINKED"
  }
}

Response Expected:

200 OK

Heartbeat

This API is used by FIUs to check availability of AAs.

HTTP METHOD: GET

URL: http://aa.finvu.in/API/V1/Heartbeat

Request Body

No Request Body expected

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2018-06-25T17:28:01.000+0000",
    "Status": "UP",
    "Error": {
        "code": 0,
        "msg": "OK",
        "detail": "Service is activated on network"
    }
}