This API is intended for AA Client to request generation of digitally signed consent artefacts. The customer has to use the AA application to select accounts and approve consent generation. Once the customer approves the consent request on the AA application, AA generates the digitally signed consent artefacts.

Note - This API extends the ReBIT specs by adding an additional VDRProvider field in the request body.

API URL: /consent

Method: POST


Headers

Authorization: API Key


Body

The request body will be in JSON. Here's a sample:

{
  "ver": "1.1.3",
  "timestamp": "{{current_timestamp}}",
  "txnid": "4a4adbbe-29ae-11e8-a8d7-0289437bf331",
  "ConsentDetail": {
    "consentStart": "{{current_timestamp}}",
    "consentExpiry": "2020-12-30T11:39:57.153Z",
    "consentMode": "VIEW",
    "fetchType": "ONETIME",
    "consentTypes": [
      "TRANSACTIONS",
      "PROFILE",
      "SUMMARY"
    ],
    "fiTypes": [
      "DEPOSIT"
    ],
    "DataConsumer": {
      "id": "finprobank"
    },
    "Customer": {
      "id": "1999999999@onemoney"
    },
    "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": "2020-07-03T14:25:33.440Z"
    },
    "DataLife": {
      "unit": "MONTH",
      "value": 1
    },
    "Frequency": {
      "unit": "MONTH",
      "value": 1
    },
    "DataFilter": [
      {
        "type": "TRANSACTIONAMOUNT",
        "operator": ">=",
        "value": 20000
      }
    ],
    "VDRProvider": {
        "vdrpid": "VDR-1",
	"fiuid": "FIU-1"
    }
  }
}

Output

The response will be in JSON: Here's a sample response:

{
  "ver": "1.0",
  "timestamp": "2018-12-06T11:39:57.153Z",
  "txnid": "4a4adbbe-29ae-11e8-a8d7-0289437bf331",
  "Customer": {
    "id": "customer_identifier@AA_identifier"
  },
  "ConsentHandle": "39e108fe-9243-11e8-b9f2-0256d88baae8"
}