v0.0.9
OpenAPI 3.1.1

Consents - API definition

Consents - API definition

Server:https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents
Client Libraries
Shell Curl

PSD2 - CONSENTS (Collapsed)

​
PSD2 - CONSENTS Operations

Get list of consents

​

Get a list of consents for the PSU doing this call (indicated by the JWT token).

Query Parameters

  • active
    Type: boolean
    required

    If true then the response will contain the active consents.

  • historical
    Type: boolean
    required

    If true then the response will contain the historical consents.

  • open
    Type: boolean
    required

    If true then the response will contain the open (initiated) consents.

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/?active=true&historical=true&open=true' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "consentId": "f3cb5c80-6520-4bf7-b02b-593db8d1ad5a",
      "consentedServices": [
        "BALANCES",
        "TRANSACTIONS",
        "DETAILS"
      ],
      "lastUpdated": "2020-03-04T10:04:52.179Z",
      "providerConsentId": "c9c473d9-5bae-42a5-8493-0ec60c8ba304",
      "validUntil": "2020-06-02T00:00:00.000Z",
      "created": "2020-03-04T09:59:04.450Z",
      "frequencyPerDay": 4,
      "consentedAt": "2020-03-04T09:59:22.000Z",
      "aisStatus": "RISK_OK",
      "recurringIndicator": true,
      "consentStatus": "VALID",
      "nearlyExpired": true,
      "userId": "14dd3422-fbd1-4254-8a68-d4bbf59f24dd",
      "provider": "RABO",
      "options": {
        "transactions": {
          "dateFrom": "2013-03-04T09:59:22.927Z",
          "dateTo": "2020-03-04T00:00:00.000Z",
          "dateFormat": "YYYY-MM-DDTHH:mm:ss.SSSZ"
        },
        "access": {
          "ais.transactions.read-90days": [
            {
              "currency": "EUR",
              "iban": "NLXXRABO03500XXXXX"
            }
          ],
          "ais.transactions.read-history": [
            {
              "currency": "EUR",
              "iban": "NLXXRABO03500XXXXX"
            }
          ],
          "ais.balances.read": [
            {
              "currency": "EUR",
              "iban": "NLXXRABO03500XXXXX"
            }
          ]
        }
      },
      "region": "NL",
      "type": "AIS",
      "providerUrl": "https://api.rabobank.nl/openapi/oauth2/authorize?client_id=f68c877b-7f34-4433-ab37-55f66356713e&redirect_uri=cashws%3A%2F%2Fauth_token&response_type=code&scope=ais.balances.read%20ais.transactions.read-90days%20ais.transactions.read-history%20oauth2.consents.read"
    }
  ],
  "pagination": {
    "index0": {
      "pagination": {
        "next": {},
        "prev": {}
      }
    },
    "index1": {
      "pagination": {
        "next": {},
        "prev": {}
      }
    },
    "index2": {
      "pagination": {
        "next": {},
        "prev": {}
      }
    }
  }
}

OK

Create Consent

​

Create Consent

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Body·

required
application/json
  • provider
    Type:
    required

    Identifies bank provider:

    • 'INGB': ING Bank,
    • 'ABNA': ABN AMRO,
    • 'RABO': Rabobank,
    • 'RETB': Revolut,
    • 'SNSB': SNS Bank,
    • 'ASNB': ASN Bank,
    • 'RBRB': Regiobank,
    • 'TRIO': Triodos,
    • 'BUNQ': Bunq,
    • 'KNAB': KNAB,
    • 'BNPF': BNP Paribas Fortis Easybank,
    • 'HELO': BNP Paribas Fortis Hellobank,
    • 'FINT': BNP Paribas Fortis Fintro,
    • 'GKCC': Belfius,
    • 'DP...': Mock Data Provider starts with DP, e.g. 'DP-INTEGRATION' or 'DP-TESTBANK'.
  • region
    Type: string
    required

    Region in which consent is provided

  • type
    Type: enum
    required

    PSU consent type:

    • 'AIS': The account information service consent type,
    • 'PIS': The payment initiation service consent type,
    • 'CAF': The confirmation of available funds consent type,
    values
    AISPISCAF
  • redirectUrl
    Type: string

    Optional redirect url

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/
curl https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/ \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "provider": "ABNA",
  "region": "NL",
  "type": "AIS",
  "redirectUrl": "https://sandbox.api.bittiq.cloud/consents-ui/created"
}'

{
  "id": "1234-hello-5678",
  "providerUrl": "https://api-sandbox.rabobank.nl/openapi/sandbox/oauth2/authorize?client_id=d43a6138-5402-4e25-9edc-ec6653f784f0&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2FauthToken&response_type=code&scope=ais.balances.read%20ais.transactions.read-90days%20ais.transactions.read-history"
}

OK - Consent Created

Get Consent

​

Returns the consent resource matching the given consent id

Path Parameters

  • consentId
    Type: string
    required

    Resource identification of the generated consent resource.

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/{consentId}
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/{consentId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "consentId": "f3cb5c80-6520-4bf7-b02b-593db8d1ad5a",
  "consentedServices": [
    "BALANCES",
    "TRANSACTIONS",
    "DETAILS"
  ],
  "lastUpdated": "2020-03-04T10:04:52.179Z",
  "providerConsentId": "c9c473d9-5bae-42a5-8493-0ec60c8ba304",
  "validUntil": "2020-06-02T00:00:00.000Z",
  "created": "2020-03-04T09:59:04.450Z",
  "frequencyPerDay": 4,
  "consentedAt": "2020-03-04T09:59:22.000Z",
  "aisStatus": "RISK_OK",
  "recurringIndicator": true,
  "consentStatus": "VALID",
  "nearlyExpired": true,
  "userId": "14dd3422-fbd1-4254-8a68-d4bbf59f24dd",
  "provider": "RABO",
  "options": {
    "transactions": {
      "dateFrom": "2013-03-04T09:59:22.927Z",
      "dateTo": "2020-03-04T00:00:00.000Z",
      "dateFormat": "YYYY-MM-DDTHH:mm:ss.SSSZ"
    },
    "access": {
      "ais.transactions.read-90days": [
        {
          "currency": "EUR",
          "iban": "NLXXRABO03500XXXXX"
        }
      ],
      "ais.transactions.read-history": [
        {
          "currency": "EUR",
          "iban": "NLXXRABO03500XXXXX"
        }
      ],
      "ais.balances.read": [
        {
          "currency": "EUR",
          "iban": "NLXXRABO03500XXXXX"
        }
      ]
    }
  },
  "region": "NL",
  "type": "AIS",
  "providerUrl": "https://api.rabobank.nl/openapi/oauth2/authorize?client_id=f68c877b-7f34-4433-ab37-55f66356713e&redirect_uri=cashws%3A%2F%2Fauth_token&response_type=code&scope=ais.balances.read%20ais.transactions.read-90days%20ais.transactions.read-history%20oauth2.consents.read"
}

OK

Terminate Consent

​

Terminate Consent - this revokes a valid consent at the provider resulting in a TERMINATED_BY_TPP status

Path Parameters

  • consentId
    Type: string
    required

    Resource identification of the generated consent resource.

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • 204

    Resource updated OK

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/{consentId}/terminate
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/{consentId}/terminate' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Resource updated OK

Cancel Open Consent

​

Cancels an open consent (one that has not been previously approved by the PSU)

Path Parameters

  • consentId
    Type: string
    required

    Resource identification of the generated consent resource.

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • 204

    Resource updated OK

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/{consentId}/cancel
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/{consentId}/cancel' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Resource updated OK

Refresh the consent details from the provider

​

Initiates a synchronous call to the provider to obtain the latest consent details (and status).

Path Parameters

  • consentId
    Type: string
    required

    Resource identification of the generated consent resource.

Query Parameters

  • providerAuthenticationCode
    Type: string
    required

    One-time authentication code returned by the provider.

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • 204

    Resource updated OK

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/{consentId}/refresh
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/{consentId}/refresh?providerAuthenticationCode=' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Resource updated OK

Refresh the user's consents via the linked provider(s)

​

Initiates one or more asynchronous calls to the provider(s) to obtain the latest consent details (and status) for the PSU associated with the JWT

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • 202

    Resource update accepted

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/refresh
curl https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/refresh \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Resource update accepted

Revokes all the user's consents via the linked provider(s)

​

Initiates one or more synchronous calls to the provider(s) to revoke all the consents for the PSU associated with the JWT

Headers

  • x-correlation-id
    Type: string

    Correlation ID for tracking requests across multiple services

Responses

  • 202

    Resource updated OK

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/terminate
curl https://api.acc.ockto.cloud/open-banking/sandbox/ais/consents/terminate \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Resource updated OK

Models

We have a new documentation site with more integration guidance & a rich knowledge base Visit the new Open Banking documentation