token

POST

token

Returns the access token that needs be presented for Account Access API calls.

Resource URL

https://hostname/identity/open-banking/v3.1 /token

Header Parameters


Name Values Description
Content-Type

Standard HTTP Header; Represents the format of the payload being provided in the request.This must be set to application/json. The TPP may provide additional information (e.g. a 'q' value and charset). If set to any other value, we will respond with a 415 Unsupported Media Type.

Authorization
(required)

Authorisation header contains the credentials to authenticate a user. It should be a string starting with basic and base 64 encoded Consumer key:Consumer secret. eg: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Body Parameters


Name Values Description
grant_type
(required)

authorization_code or client_credentials or refresh_token.

client_id

Must be sent if authentication method is private_key_jwt,value is client_id of the OAuth Client

client_assertion_type

Must be sent if authentication method is private_key_jwt,value is urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion

Must be sent if authentication method is private_key_jwt,value is authentication token

code

Code returned from the authorize call. Applicable only on grant_type = authorization_code and the value is one fetched from /authorize API

refresh_token

The refresh token for the old access token.Example:2Jc9AqNHCYTWHwUKlWb8NqRPaBbJK10l

scope
(required)

The scope defines the type of operations that the third-party will be performing.

Request Body

Generates Access Token to initiate Account Access methods.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

    Bad Request:Example-Invalid grant_type or code or scope

  • 401

    Unauthorised:Example-Invalid ClientId or ClientSecret

  • 404

    Resource Not Found

  • 415

    Unsupported Media Type

  • 500

    Internal Server Error

Resource Summary

Security

Content Type

application/x-www-form-urlencoded

Working...