Skip to main content
API docs by Redocly

bLink API - custody services module (1.0.10.5-fi)

Download OpenAPI specification:Download

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

This is the specification of the bLink 'custody-services' module API. (as implemented by providers (e.g. financial institutions) and used by SIX) It is part of the OpenWealth APIs for the connectivity between custody banks and WealthTechs (e.g. Portfolio Management Systems). This API allows the user to receive data from custody banks regarding accounts and positions. The API is designed to be used for either update end of day data batches or single near-realtime account/position information. Furthermore, this API allows the user to receive data from custody banks regarding transactions. In this version only transactions which include effective cash or securities movements are in scope and corporate actions are delivered only on a informative basis.

customeraccounts

Returns all customers and respective accounts accessible for the logged in user.

This endpoint returns a highlevel list of customers and the respective accounts accessible for the logged in user. Paging is done based on the customerOverview object, i.e. if limit is set to 1, then 1 customerOverview will be returned per page.

query Parameters
cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a specific customers and respective accounts accessible for the logged in user.

This endpoint returns a highlevel list of a customer and the respective accounts accessible for the logged in user.

path Parameters
customerId
required
string

The customer's id

query Parameters
cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

positions

Returns all positions for a specific customer.

Returns all positions (incl. investment cash accounts) for a specific customer. Paging is done based on the account object, i.e. if limit is set to 1, then 1 account will be returned per page.

path Parameters
customerId
required
string

The customer's id

query Parameters
date
required
string <date>
Example: date=2019-12-31

Full-date according to ISO 8601 i.e. YYYY-MM-DD format.

eodIndicator
required
boolean
Default: true
Example: eodIndicator=true

Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today.

dateType
required
string
Enum: "transactionDate" "bookingDate" "valueDate"

Indicates which type of date is decisive for the data shown.

cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "customer": {
    }
}

Returns the positions for a customer's specific account.

Returns all positions for a specific account. Paging is done based on the position object, i.e. if limit is set to 1, then 1 position will be returned per page.

path Parameters
accountId
required
string

The customer's account identification

query Parameters
date
required
string <date>
Example: date=2019-12-31

Full-date according to ISO 8601 i.e. YYYY-MM-DD format.

eodIndicator
required
boolean
Default: true
Example: eodIndicator=true

Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today.

dateType
required
string
Enum: "transactionDate" "bookingDate" "valueDate"

Indicates which type of date is decisive for the data shown.

cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "customer": {
    }
}

transactions

Returns transactions for a specific customer.

Returns all transactions for the a specific customer. Paging is done based on the transaction object, i.e. if limit is set to 1, then 1 transaction will be returned per page.

path Parameters
customerId
required
string

The customer's id

query Parameters
date
required
string <date>
Example: date=2019-12-31

Full-date according to ISO 8601 i.e. YYYY-MM-DD format.

dateType
required
string
Enum: "transactionDate" "bookingDate" "valueDate"

Indicates which type of date is decisive for the data shown.

eodIndicator
required
boolean
Default: true
Example: eodIndicator=true

Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today.

cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "transactions": [
    ]
}

Returns the transactions a specific account.

Returns the transactions for all positions in a specific account. Paging is done based on the transaction object, i.e. if limit is set to 1, then 1 transaction will be returned per page.

path Parameters
accountId
required
string

The customer's account identification

query Parameters
date
required
string <date>
Example: date=2019-12-31

Full-date according to ISO 8601 i.e. YYYY-MM-DD format.

dateType
required
string
Enum: "transactionDate" "bookingDate" "valueDate"

Indicates which type of date is decisive for the data shown.

eodIndicator
required
boolean
Default: true
Example: eodIndicator=true

Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today.

cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "transactions": [
    ]
}

Returns the transactions for a specific position.

Returns transactions for a specific position. Paging is done based on the transaction object, i.e. if limit is set to 1, then 1 transaction will be returned per page.

path Parameters
positionId
required
string

The position's id

query Parameters
date
required
string <date>
Example: date=2019-12-31

Full-date according to ISO 8601 i.e. YYYY-MM-DD format.

dateType
required
string
Enum: "transactionDate" "bookingDate" "valueDate"

Indicates which type of date is decisive for the data shown.

eodIndicator
required
boolean
Default: true
Example: eodIndicator=true

Indicates whether the position data is end-of-day (eod) data for the positions. If the parameter is set to false, the most recent data is shown, incl intraday changes on the position if the date is set to today.

cursor
string

An opaque string value used for pagination

limit
integer <int32> >= 1

Maximum 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.

Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "transactions": [
    ]
}

diagnostics

Returns all specified request headers and additional diagnostic information

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

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

Authorization
string

Bearer followed by a base64 encoded OAuth access token

User-Agent
string

Name and version of the of the client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

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

Returns all specified request headers, the request body and additional diagnostic information

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

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

Authorization
string

Bearer followed by a base64 encoded OAuth access token

User-Agent
string

Name and version of the of the client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

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 ..."
}