Skip to main content
API docs by Redocly

bLink API - customer management module (1.0.9.3-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 'customer-management' module API. This API 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 customer data and alter and create address and contact data.

customer

Returns a list of customers.

Returns a list of all customers. A customer is an object which holds a contract with a (custody-)bank. Paging is done based on the customer object, i.e. if limit is set to 1, then 1 customer 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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a specific customer.

Returns a full client record for a specific customer id.

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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "customerIdentification": 987654321,
  • "externalReference": "123-456-787",
  • "name": "Steve Rogers",
  • "status": "active",
  • "referenceCurrency": "CHF",
  • "openingDate": "2018-04-13",
  • "personList": [
    ],
  • "addressList": [
    ]
}

kyc

Returns the kyc to a specific customer.

Returns the know-your-client record for a specific customer.

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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

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

person

Returns a list with all person objects.

Returns all person records. Paging is done based on the person object, i.e. if limit is set to 1, then 1 person 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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a specific person object.

Returns a person record for a specific person id.

path Parameters
personId
required
string

The persons'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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "personIdentification": 876543219,
  • "externalReference": "987-654-321",
  • "customerList": [
    ],
  • "fullName": "Tony Stark",
  • "countryOfDomicile": "CH",
  • "language": "German",
  • "contactInformation": [
    ],
  • "personDetails": {
    },
  • "taxDomicile": [
    ]
}

Returns the contact details for a specific person.

Returns a contact detail list for a specific person id.

path Parameters
personId
required
string

The persons'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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates new contact details for a specific person.

Creates new contact details for a specific person id.

path Parameters
personId
required
string

The persons'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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Request Body schema: application/json
medium
required
string
Enum: "email" "phone" "fax" "website" "socialMediaProfile"

Medium for contacting the client.

contactMediumType
string
Enum: "private" "business"

Specifies the type of contact details

contactContent
required
string [ 1 .. 70 ] characters

Content of the contact details, e.g. phone number, email-address, Website URL

additionalContactInformation
string <= 70 characters

Used for additional information regarding the contact details

Responses

Request samples

Content type
application/json
{
  • "medium": "phone",
  • "contactMediumType": "business",
  • "contactContent": 41998887766,
  • "additionalContactInformation": "Prio 1 Phone Number"
}

Response samples

Content type
application/json
{
  • "contactIdentification": 123987,
  • "medium": "phone",
  • "contactMediumType": "business",
  • "contactContent": 41998887766,
  • "additionalContactInformation": "Prio 1 Phone Number"
}

address

Creates a new address object for a specific customer.

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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Request Body schema: application/json
required
addressName
string <= 70 characters

Name of the address object

mailingInstruction
string <= 35 characters

Mailing instruction

object (postalAddress)

Responses

Request samples

Content type
application/json
{
  • "addressName": "Stark Mansion",
  • "mailingInstruction": "MainDispatch",
  • "postalAddress": {
    }
}

Response samples

Content type
application/json
{
  • "addressIdentification": 7353
}

Returns the address of a specific customer.

Returns a address record for a specific address id.

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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type
application/json
{
  • "addressIdentification": 12345678,
  • "addressName": "Stark Mansion",
  • "isDomicile": true,
  • "isMailingAddress": true,
  • "mailingInstruction": "MainDispatch",
  • "dispatchType": "postal",
  • "language": "German",
  • "postalAddress": {
    }
}

Updates an existing address object for a specific customer.

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.

Permission-ID
required
string <uuid,>

This contains the permission Id returned by the post permission, which was performed prior to any request.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Authorization
string

Bearer followed by a base64 encoded OAuth access token

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Request Body schema: application/json
required
addressIdentification
required
number

Bank ID of the address object

addressName
string <= 70 characters

Name of the address object

isDomicile
boolean

Indicates whether this address is the domicile address

isMailingAddress
boolean

Indicates whether this address is used for mailing purposes.

mailingInstruction
string <= 35 characters

Mailing instruction

dispatchType
required
string
Enum: "postal" "electronical" "other"

Indicates wether the correspondance is sent out digitally (e.g. to the e-banking) or physically.

language
string <= 35 characters

Language for all communication concerning this address

object (postalAddress)

Responses

Request samples

Content type
application/json
{
  • "addressIdentification": 12345678,
  • "addressName": "Stark Mansion",
  • "isDomicile": true,
  • "isMailingAddress": true,
  • "mailingInstruction": "MainDispatch",
  • "dispatchType": "postal",
  • "language": "German",
  • "postalAddress": {
    }
}

Response samples

Content type
application/problem+json
{
  • "type": "/problems/TECHNICAL_ERROR",
  • "title": "This is the general problem description",
  • "detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
  • "instance": "path/to/corresponding/resource"
}

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

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)

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - 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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

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)

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. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - 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 ..."
}