GET /v1/obie/tokens/{token}

Overview

This endpoint retrieves information on an access token.

https://sandbox.konsentus.com/v1/obie/tokens/{token}

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

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

Path Parameters

token REQUIRED
string
The access token generated by Konsentus.

Response Properties

data object
response data
access_token string
The access token generated by Konsentus. The authorization code is bound to the client identifier and redirection URI. If grant_type in the request was set to client_credentials then the token in the response will be hardcoded to good-access-token.
expires_in integer
If the access token expires, the server replies with the duration of time the access token is granted for.
token_type string
The type of token, typically just the string 'bearer’.
active boolean
It says whether the token is expired or deleted.
errors array<object>

        See error documentation for fields and descriptions

Responses

200

Request successful and access token information retrieved.

{
  "data": {
    "access_token": string,
    "expires_in": integer,
    "token_type": string,
    "active": boolean,
  }
}

401

Unable to Authorize.

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

404

Not Found.

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

Response Example

200 OK

Success

{
  "data": {
    "access_token": "8c9378f8-e27f-4e0a-a643-d73585d1249f",
    "expires_in": 31104000,
    "token_type": "bearer",
    "active": true,
  }
}
Last Updated: 8/9/2019, 3:47:34 PM