Consent API - Belfius Developer Portal

Get security token

Token endpoint provides the possibility to get an access-token, optional logical_id, SCA_token and optionally refresh_token based on grant_type. The refresh_token can be used to get a new access_token and refresh_token. It reacts based on grant_type which can be 'authorization_code' or 'refresh_token'. Please note that we do not support header transfer-encoding: chuncked.

Parameters

Authorization Header required string

Passing client_id and client_secret as an HTTP Basic authorization header with Base64 encoding.

Request-ID Header required string

ID of the request, unique to the call, as determined by the initiating party. It has to be a valid UUID in V04 format.

example:

"99391c7e-ad88-49ec-a2ad-99ddcb1f7721"

Accept Header required string

It must be of type application/json including version number. [Accept:application/vnd.belfius.api+json; version=3].

example:

"application/vnd.belfius.api+json; version=3"

Content-Type Header required string

It should be application/x-www-form-urlencoded.

example:

"application/x-www-form-urlencoded"

Request

Both payloads are valid requests, do not use them in the same request.

Name	Type	Description
AuthorizationCodeBasedTokenRequestPayload	object	The token request based on authorization_code grant type.	conditional
grant_type	string	Grant type the client will use to get tokens. authorization_code refresh_token	required
code	string	authorization code received previously from authorization server.	required
redirect_uri	string	URI string used in redirect-based OAuth grants, such as authorization_code and implicit. Must be equal to the one provided during the authorization code / implicit request.	required
code_verifier	string	PKCE code verifier as per RFC https://tools.ietf.org/html/rfc7636.	required
RefreshTokenBasedTokenRequestPayload	object	The token request based on refresh_token grant type.	conditional
grant_type	string	Grant type the client will use to get tokens. authorization_code refresh_token	required
refresh_token	string	Original refresh token provided by authorization server to the client at the time of authorization & consent.	required
scope	string	Optional. The scope of the access request. The requested scope MUST NOT include any scope not originally granted by the resource owner (although it can reduce that scope), and if omitted is treated as equal to the scope originally granted by the resource owner.	optional

Response

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Headers

Response-ID: Same as Request-ID, received in request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

ErrorModel

Fixed-form error tokens mapping to specific errors.

example:
```
string
```
error (string)
Error specific code, could be used directly by consumer's software.

example:
```
string
```
error_code (string)
Full description of the error.

example:
```
string
```
error_description (string)

Post /token

Request example

Response example

There is no example response provided

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

Introduction

Hosts

Example screen

Navigate to an endpoint to see sample code

Get consent uris.

Parameters

Request-ID Header required string

Accept Header required string

Accept-Language Header required string

Redirect-URI Header required string

Client-ID Header required string

Code-Challenge-Method Header required string

Code-Challenge Header required string

scope Query required string

Response

400 Bad Request

Headers

error (string)

error_code (string)

error_description (string)

401 Unauthorized / authentification failure

Headers

error (string)

error_code (string)

error_description (string)

403 Forbidden

Headers

error (string)

error_code (string)

error_description (string)

404 Not found

Headers

error (string)

error_code (string)

error_description (string)

405 Method Not Allowed

Headers

error (string)

error_code (string)

error_description (string)

406 Not Acceptable

Headers

error (string)

error_code (string)

error_description (string)

495 SSL certificate error. Mutual TLS can not be established. It may occur when an unregistered client( or a client with an invalid/expired certificate) trying to access a secure api.

Headers

error (string)

error_code (string)

error_description (string)

500 Internal Server Error

Headers

error (string)

error_code (string)

error_description (string)

503 Service Unavailable

Headers

error (string)

error_code (string)

error_description (string)

Request example

Response example

Get security token

Parameters

Authorization Header required string

Request-ID Header required string

Accept Header required string

Content-Type Header required string

Request

Response

200 Token response

400 Bad Request

Headers

error (string)

error_code (string)

error_description (string)

401 Unauthorized / authentification failure

Headers

error (string)

error_code (string)