# GET /v1/oauth2/token/{token}

Archived documentation

This documentation refers to V1.6. See Release Notes for more information.

# Overview

This endpoint returns an access token which includes an access token including an active property which gives approval for the bank to pass the account information/payment.

https://sandbox.konsentus.com/v1/oauth2/token/{token}

# Request Properties

# Headers

Authorization REQUIRED
string
Basic Auth Header
fi_reference_id REQUIRED
string
A string representing the FI authenticating with the system

Authentication Headers

x-eidas REQUIRED
string
Base64 encoded eIDAS certificate

eIDAS Certificate Headers

# Path Parameters

token REQUIRED
string
The access token generated by Konsentus.

# Response Properties

data object
response data
token string
The access token generated by Konsentus.
auth_code string
The auth code generated by Konsentus.
created_time string
Creation date of the token.
updated_time string
Updated date of the token.
deleted_time string
Deleted date of the token.
account_id string
User account_id for the OAuth 2.0 client that requested this token.
tpp_id string
Client identifier/TPP id for the OAuth 2.0 client that requested this token.
fi_id string
fi_id for the OAuth 2.0 client that requested this token.
psd2_roles [string]
A JSON array containing a list of psd2 roles associated with this token and TPP.
redirect_uri string
Valid preregistered redirect URI.
scope string
A JSON string containing a space-separated list of scopes associated with this token.
active boolean
Boolean indicator of whether or not the presented token is currently active.
error object

        See error documentation for fields and descriptions

# Responses

# 200

Request received, token data returned.

{
  "token": string,
  "auth_code": string,
  "created_time": string,
  "deleted_time": string,
  "updated_time": string,
  "account_id": string,
  "tpp_id": string,
  "fi_id": string,
  "psd2_role": string,
  "redirect_uri": string,
  "scope": string,
  "active": boolean
}

# 401

Unable to authorize

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

# 404

Token not found

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

# Response Example

# 200 OK

Request received, token data returned.

{
  "data": {
    "token": "832018ac-7174-4966-a46b-e4811dc66e0d",
    "auth_code": "406raajjhsxr20s",
    "created_time": "2021-05-29T16:11:46.650Z",
    "updated_time": "2018-06-05T09:22:18.384Z",
    "deleted_time": null,
    "account_id": "1",
    "tpp_id": "PSDGB-FCA-kt-484347",
    "fi_id": "testFI",
    "psd2_roles": "PSP_PI",
    "redirect_uri": "https://www.google.com",
    "scope": "pay",
    "active": true
  }
}
Last Updated: 8/9/2019, 3:47:34 PM