Consents

Create

post

Authorizations

Header parameters

fiu_entity_idstringRequired

aa_entity_idstringRequired

Body

redirect_paramsall ofOptional

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v2/consents/request HTTP/1.1
Host: localhost:8080
Authorization: Basic username:password
fiu_entity_id: text
aa_entity_id: text
Content-Type: application/json
Accept: */*
Content-Length: 765

{
  "consents": [
    {
      "consent_start": "2019-12-06T11:39:57.153Z",
      "consent_expiry": "2019-12-06T11:39:57.153Z",
      "consent_mode": "VIEW",
      "fetch_type": "ONETIME",
      "consent_types": [
        "PROFILE"
      ],
      "fi_types": [
        "DEPOSIT"
      ],
      "customer": {
        "id": "customer_identifier@AA_identifier",
        "identifiers": [
          {
            "type": "MOBILE",
            "value": 9867123456
          }
        ]
      },
      "purpose": {
        "code": "101",
        "text": "Wealth management service"
      },
      "fi_data_range": {
        "from": "2023-07-06T11:39:57.153Z",
        "to": "2019-12-06T11:39:57.153Z"
      },
      "data_life": {
        "unit": "MONTH",
        "value": 1
      },
      "frequency": {
        "unit": "HOUR",
        "value": 1
      },
      "data_filter": [
        {
          "type": "TRANSACTIONAMOUNT",
          "operator": ">=",
          "value": 20000
        }
      ]
    }
  ],
  "redirect_params": {
    "email": "text",
    "pan": "text",
    "dob": "text",
    "callback_url": "https://bootstack.xyz",
    "session_id": "text",
    "fip_ids": [
      "text"
    ],
    "language_code": "en-IN"
  }
}

200

OK

{
  "consents": [
    {
      "handle": "478edfdf-e3ab-4f42-b69f-36a0c45e9fd2",
      "status": "PENDING"
    }
  ],
  "redirect_url": "https://aa/webview?ecreq=dD7Tq0IYcZRqavmq9DaqJ1ECxjbyLVTQ8mP_mfriG0RwyjjjKNt7yd3B481BQ4ECNtlRXZxUR4IQroi9mxIEqKN7excdKKfYjXfuDZN9JGKHYhQyk-a8yNmgGCBSg3OiD_O7TyeGW9D7QDshj-7uQcBSdwFTE3VawFq6Cpat6nQkWQj_KaNuJAMn63E0ixlFEHqlvb-pLRvIdkF5kngJBk_a4aBnfNBNZrmqUfOGiBWRaLI1FlyuVPBnzaxGkBktmwjFtr-4IxwIfn5GqW3Qi_6KMuCw6wr5Tl5m5kwJzqCtC34TybMWnCksakfe1ZBwGOvaaiOCTyQKDRAVqRJL7w%3D%3D&fi=XFtWWEZYXUFLHEFYRA%3D%3D&reqdate=021020241149000"
}

Fetch

post

Authorizations

Body

objectOptionalExample: {"handle":"{{consent_handle}}"}

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v2/consents/fetch HTTP/1.1
Host: localhost:8080
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "handle": "{{consent_handle}}"
}

200

OK

{
  "consents": [
    {
      "handle": "079043cc-1516-430e-b814-f50eff54ffef",
      "status": "PAUSED"
    }
  ]
}