Konsentus Documentation

POST /v1/obie/account_access_consents

Overview

This endpoint creates an account consent resource for a set of scopes so that the authorization process can be initiated.

https://sandbox.konsentus.com/v1/obie/account_access_consents

Request Properties

Headers

Authorization REQUIRED
string
Basic Auth Header
fi_reference_id REQUIRED
string
A string representing the FI authenticating with the system
version REQUIRED
string
A string representing version of the API you are using
ccg_token REQUIRED
string
Client credentials grant token
Content-Type REQUIRED
string
Must be set to: application/json

Further information is available on Authentication Headers, Client Credentials Grant Tokens and Version Header.

Body Parameters

data REQUIRED
object
Open Banking Read Data Consent Response.
permissions REQUIRED
string
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
expiration_date_time REQUIRED
string (ISODateTime)
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.
transaction_from_date_time REQUIRED
string (ISODateTime)
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
transaction_to_date_time REQUIRED
string (ISODateTime)
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.

Request Body Example

{
  "data": {
    "permissions": [
      "ReadAccountsBasic"
    ],
    "expiration_date_time": "2021-07-03T09:33:07.727Z",
    "transaction_from_date_time": "2018-07-03T09:33:07.727Z",
    "transaction_to_date_time": "2018-07-03T09:33:07.727Z"
  }
}

Response Properties

data object
response data
consent_id string
Unique identification as assigned to identify the account access consent resource.
status string
Specifies the status of consent resource in code form.
status_update_date_time string (ISODateTime)
Date and time at which the resource was created.
creation_date_time string (ISODateTime)
Date and time at which the resource was created.
permissions array of strings
The permissions passed in the request. Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
expiration_date_time string (ISODateTime)
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.
transaction_from_date_time string (ISODateTime)
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
transaction_to_date_time string (ISODateTime)
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
errors array<object>

        See error documentation for fields and descriptions

Responses

201

Request received, account resource returned.

{
  "data": {
    "consent_id": string,
    "status": string,
    "status_update_date_time": string
    "creation_date_time": string,
    "expiration_date_time": string,
    "transaction_from_date_time": string,
    "transaction_to_date_time": string,
    "permissions": [ string ]
 },
}

400

Request received missing parameters or malformed.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

401

Unable to authorize.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

403

Forbidden.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

Response Example

201 CREATED

Success:

{
  "data": {
    "consent_id": "urn-examplebank-intent-12345",
    "status": "AwaitingAuthorisation",
    "status_update_date_time": "2018-07-03T09:37:52.179Z",
    "creation_date_time": "2018-07-03T09:37:52.179Z",
    "expiration_date_time": "2018-07-03T09:37:52.179Z",
    "transaction_from_date_time": "2018-07-03T09:37:52.179Z",
    "transaction_to_date_time": "2018-07-03T09:37:52.179Z",
    "permissions": [
      "ReadAccountsBasic"
    ],
  }
}
Last Updated: 8/9/2019, 3:47:34 PM

← GET /v1/obie/account_access_consents/{consent_id}→