Skip to main content
API docs by Redocly

bLink API - platform module (3.0.0.5-six_caas)

Download OpenAPI specification:Download

URL: https://www.six-group.com/en/products-services/banking-services/blink.html

This is the specification of the bLink 'platform' module API.

directory

participant information Information about participating parties.

Retrieve a list of all registered clients (e.g., third party providers)

Returns a list of clients with information regarding software and supported use cases.

query Parameters
status
string (Directory Participant Status)
Default: "ACTIVE"
Enum: "ACTIVE" "INACTIVE" "SUSPENDED" "ONBOARDING_DEVELOPMENT"
Example: status=ACTIVE

Returns clients or providers with the corresponding status.

embed_assets
string (Embed Asset Type)
Default: "ALL"
Enum: "ALL" "ICON" "LOGO" "NONE"
Example: embed_assets=ALL
  • ALL = Embed both logos and icons as base64
  • LOGO = Embed only logos as base64 (no icons)
  • ICON = Embed only icons as base64 (no logos)
  • NONE = No embedded assets
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 20

The number of items to return.

header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Retrieve the information for a registered client (e.g. third party provider)

Returns information regarding software and supported use cases of a client.

path Parameters
clientId
required
string <= 30 characters

id of the client

query Parameters
embed_assets
string (Embed Asset Type)
Default: "ALL"
Enum: "ALL" "ICON" "LOGO" "NONE"
Example: embed_assets=ALL
  • ALL = Embed both logos and icons as base64
  • LOGO = Embed only logos as base64 (no icons)
  • ICON = Embed only icons as base64 (no logos)
  • NONE = No embedded assets
header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type
application/json
{
  • "clientId": "CIDX1234567890",
  • "status": "ACTIVE",
  • "companyName": "ACME",
  • "companyNameAbbreviation": "ACME",
  • "companyUrl": "https://www.acme.com",
  • "productName": "ACME accounting software",
  • "productInfoUrl": "https://acme.com/amce_accounting",
  • "contact": [
    ],
  • "logo": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj4KICA8Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgc3R5bGU9ImZpbGw6cmVkOyIgLz4KPC9zdmc+Cg==",
  • "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj4KICA8Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgc3R5bGU9ImZpbGw6cmVkOyIgLz4KPC9zdmc+Cg==",
  • "registrationDate": "2018-04-13",
  • "lastModified": "2018-04-13T11:11:11Z",
  • "useCases": [
    ],
  • "consentFlows": [
    ],
  • "features": {
    }
}

Retrieve a list of all registered providers (e.g., financial institutions)

Returns a list of providers with information regarding software and supported use cases.

query Parameters
status
string (Directory Participant Status)
Default: "ACTIVE"
Enum: "ACTIVE" "INACTIVE" "SUSPENDED" "ONBOARDING_DEVELOPMENT"
Example: status=ACTIVE

Returns clients or providers with the corresponding status.

embed_assets
string (Embed Asset Type)
Default: "ALL"
Enum: "ALL" "ICON" "LOGO" "NONE"
Example: embed_assets=ALL
  • ALL = Embed both logos and icons as base64
  • LOGO = Embed only logos as base64 (no icons)
  • ICON = Embed only icons as base64 (no logos)
  • NONE = No embedded assets
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 20

The number of items to return.

header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Retrieve the information for a registered provider (e.g., financial institutions)

Returns information regarding software and supported use cases of a provider.

path Parameters
providerId
required
string <= 30 characters

id of the provider

query Parameters
embed_assets
string (Embed Asset Type)
Default: "ALL"
Enum: "ALL" "ICON" "LOGO" "NONE"
Example: embed_assets=ALL
  • ALL = Embed both logos and icons as base64
  • LOGO = Embed only logos as base64 (no icons)
  • ICON = Embed only icons as base64 (no logos)
  • NONE = No embedded assets
header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type
application/json
{
  • "providerId": "IIDX1234567890",
  • "status": "ACTIVE",
  • "companyName": "ACME",
  • "companyNameAbbreviation": "ACME",
  • "companyUrl": "https://www.acme.com",
  • "productName": "ACME accounting software",
  • "productInfoUrl": "https://acme.com/amce_accounting",
  • "contact": [
    ],
  • "logo": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj4KICA8Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgc3R5bGU9ImZpbGw6cmVkOyIgLz4KPC9zdmc+Cg==",
  • "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj4KICA8Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgc3R5bGU9ImZpbGw6cmVkOyIgLz4KPC9zdmc+Cg==",
  • "registrationDate": "2018-04-13",
  • "lastModified": "2018-04-13T11:11:11Z",
  • "useCases": [
    ],
  • "consentFlows": [
    ],
  • "features": {
    }
}

diagnostics

health status of the API

Endpoint to check the health status of the API for GET method.

header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
string

Name and version of the of the client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "receivedPayload": "... as received ..."
}

health status of the API

Endpoint to check the health status of the API for POST method.

header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
string

Name and version of the of the client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "receivedPayload": "... as received ..."
}

routinginstructions

instructed routes per communication

Returns instructed routes for service user to service provider communication

header Parameters
X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
string

Name and version of the of the client software

X-Instance-ID
string <= 64 characters

(Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "message": "string",
  • "instructedRoutingTargets": [
    ]
}