bLink API - customer management module (1.0.9.3-six)
Download OpenAPI specification:Download
This is the specification of the bLink 'customer-management' module API. (as implemented by SIX and used by clients (e.g. third party providers)) 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.
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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
[- {
- "customerIdentification": 987654321,
- "externalReference": "123-456-787",
- "name": "Steve Rogers",
- "status": "active",
- "referenceCurrency": "CHF",
- "openingDate": "2018-04-13",
- "personList": [
- {
- "personRelation": "accountOwner",
- "personIdentification": 876543219
}
], - "addressList": [
- {
- "addressIdentification": 12345678
}
]
}
]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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "customerIdentification": 987654321,
- "externalReference": "123-456-787",
- "name": "Steve Rogers",
- "status": "active",
- "referenceCurrency": "CHF",
- "openingDate": "2018-04-13",
- "personList": [
- {
- "personRelation": "accountOwner",
- "personIdentification": 876543219
}
], - "addressList": [
- {
- "addressIdentification": 12345678
}
]
}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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "customer": {
- "customerIdentification": 987654321,
- "externalReference": "123-456-787",
- "name": "Steve Rogers",
- "status": "active",
- "referenceCurrency": "CHF",
- "openingDate": "2018-04-13",
- "personList": [
- {
- "personRelation": "accountOwner",
- "personIdentification": 876543219
}
], - "addressList": [
- {
- "addressIdentification": 12345678
}
]
}, - "kyc": {
- "nonFinancialSituation": {
- "profession": "Philantropist",
- "employingCompany": "Stark Industries",
- "educationLevel": "University",
- "function": "CEO",
- "typeOfEmployment": "employed",
- "riskDomicile": "CH",
- "reasonForDomiciliaryCompany": "Wealth management",
- "sector": "Energy supply",
- "numberOfEmployees": 250,
- "dateOfIncorporation": "2018-04-13",
- "companyPurpose": "Provide sustainable energy",
- "structureControllingPerson": "Anthony Stark (75%), Piper Potts (25%)",
- "structureBeneficialOwners": "Anthony Stark (100%)",
- "reasonForTrust": "Succession Planning",
- "revocability": true,
- "resettled": false,
- "merged": false,
- "beneficialOwner": "Max Muster",
- "beneficiary": "Peter Parker",
- "protector": "Stark Industries",
- "dateOfTrustContract": "2018-04-13"
}, - "financialSituation": {
- "incomeCurrentPeriod": {
- "currency": "CHF",
- "amount": "100000"
}, - "sourceOfIncome": "income",
- "annualTurnover": {
- "currency": "CHF",
- "amount": "200000"
}, - "monetaryWealth": {
- "currency": "CHF",
- "amount": "1000000"
}, - "sourceOfWealth": [
- {
- "sourceOfWealth": "inheritance",
- "currency": "CHF",
- "amount": "25000000",
- "dateOfReceipt": "2018-04-13",
- "originator": {
- "name": "Howard Stark",
- "relationToCustomer": "Relatives",
- "occupation": "Technology Provider"
}
}
], - "priorBank": {
- "namePriorBank": "string",
- "domicilePriorBank": "CH"
}
}
}
}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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
[- {
- "personIdentification": 876543219,
- "externalReference": "987-654-321",
- "customerList": [
- {
- "customerIdentification": 123123
}
], - "fullName": "Tony Stark",
- "countryOfDomicile": "CH",
- "language": "German",
- "contactInformation": [
- {
- "contactIdentification": 123987,
- "medium": "phone",
- "contactMediumType": "business",
- "contactContent": 41998887766,
- "additionalContactInformation": "Prio 1 Phone Number"
}
], - "personDetails": {
- "personType": "naturalPerson"
}, - "taxDomicile": [
- "CH"
]
}
]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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "personIdentification": 876543219,
- "externalReference": "987-654-321",
- "customerList": [
- {
- "customerIdentification": 123123
}
], - "fullName": "Tony Stark",
- "countryOfDomicile": "CH",
- "language": "German",
- "contactInformation": [
- {
- "contactIdentification": 123987,
- "medium": "phone",
- "contactMediumType": "business",
- "contactContent": 41998887766,
- "additionalContactInformation": "Prio 1 Phone Number"
}
], - "personDetails": {
- "personType": "naturalPerson"
}, - "taxDomicile": [
- "CH"
]
}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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
[- {
- "contactIdentification": 123987,
- "medium": "phone",
- "contactMediumType": "business",
- "contactContent": 41998887766,
- "additionalContactInformation": "Prio 1 Phone Number"
}
]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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
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
- Payload
{- "medium": "phone",
- "contactMediumType": "business",
- "contactContent": 41998887766,
- "additionalContactInformation": "Prio 1 Phone Number"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "contactIdentification": 123987,
- "medium": "phone",
- "contactMediumType": "business",
- "contactContent": 41998887766,
- "additionalContactInformation": "Prio 1 Phone Number"
}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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Request Body schema: application/jsonrequired
| addressName | string <= 70 characters Name of the address object |
| mailingInstruction | string <= 35 characters Mailing instruction |
object (postalAddress) |
Responses
Request samples
- Payload
{- "addressName": "Stark Mansion",
- "mailingInstruction": "MainDispatch",
- "postalAddress": {
- "salutation": {
- "receptionRestriction": "confidential",
- "salutation": "Mr.",
- "title": "PhD",
- "overrideSalutation": "Dear Ironman"
}, - "name": {
- "organisationName": "Strak Industries",
- "givenName": "Anthony",
- "middleName": "Edward",
- "lastName": "Stark",
- "nameSuffix": "jr."
}, - "physicalAddress": {
- "careOf": "Piper Potts",
- "toTheAttentionOf": "Jarvis",
- "streetName": "Malibu Point",
- "buildingNumber": 10880,
- "postBox": 12,
- "addressSuffix": "Appartment 1",
- "postCode": 90265,
- "townName": "Malibu",
- "countrySubDivision": "CA",
- "country": "CH"
}
}
}Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "addressIdentification": 12345678,
- "addressName": "Stark Mansion",
- "isDomicile": true,
- "isMailingAddress": true,
- "mailingInstruction": "MainDispatch",
- "dispatchType": "postal",
- "language": "German",
- "postalAddress": {
- "salutation": {
- "receptionRestriction": "confidential",
- "salutation": "Mr.",
- "title": "PhD",
- "overrideSalutation": "Dear Ironman"
}, - "name": {
- "organisationName": "Strak Industries",
- "givenName": "Anthony",
- "middleName": "Edward",
- "lastName": "Stark",
- "nameSuffix": "jr."
}, - "physicalAddress": {
- "careOf": "Piper Potts",
- "toTheAttentionOf": "Jarvis",
- "streetName": "Malibu Point",
- "buildingNumber": 10880,
- "postBox": 12,
- "addressSuffix": "Appartment 1",
- "postCode": 90265,
- "townName": "Malibu",
- "countrySubDivision": "CA",
- "country": "CH"
}
}
}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. |
| Authorization required | string Bearer followed by a base64 encoded OAuth access token |
| 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) |
Request Body schema: application/jsonrequired
| 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
- Payload
{- "addressIdentification": 12345678,
- "addressName": "Stark Mansion",
- "isDomicile": true,
- "isMailingAddress": true,
- "mailingInstruction": "MainDispatch",
- "dispatchType": "postal",
- "language": "German",
- "postalAddress": {
- "salutation": {
- "receptionRestriction": "confidential",
- "salutation": "Mr.",
- "title": "PhD",
- "overrideSalutation": "Dear Ironman"
}, - "name": {
- "organisationName": "Strak Industries",
- "givenName": "Anthony",
- "middleName": "Edward",
- "lastName": "Stark",
- "nameSuffix": "jr."
}, - "physicalAddress": {
- "careOf": "Piper Potts",
- "toTheAttentionOf": "Jarvis",
- "streetName": "Malibu Point",
- "buildingNumber": 10880,
- "postBox": 12,
- "addressSuffix": "Appartment 1",
- "postCode": 90265,
- "townName": "Malibu",
- "countrySubDivision": "CA",
- "country": "CH"
}
}
}Response samples
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 503
{- "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"
}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) |
Responses
Response samples
- 200
{- "requestDateTime": "2018-04-13T11:11:11Z",
- "receivedHeaders": [
- {
- "headerName": "X-Correlation-ID",
- "headerValue": "string"
}
], - "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) |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
"string"Response samples
- 200
{- "requestDateTime": "2018-04-13T11:11:11Z",
- "receivedHeaders": [
- {
- "headerName": "X-Correlation-ID",
- "headerValue": "string"
}
], - "receivedPayload": "... as received ..."
}