Service User Onboarding
Similar to the onboarding of a Service Provider, onboarding a Service User (SU) onto the platform is a standardized process. The onboarding process for a use case differs depending on the applicant's legal status and role in the process, but compared to the onboarding procedure for SP, the process for SU is simplified and largely automated.
When registering for a specific use case, a SU must provide the directory information and all data necessary for SIX to verify that it complies with the admission criteria established for bLink are met. The SU must also confirm that it fulfills the technical requirements required to connect to the SIX testing and production environments. Additionally, the SU must read and agree to the terms of the participation contract.
If all necessary information has been provided and the SU successfully passes the admission criteria, it receives a contract confirmation from SIX and the credentials that allow it to connect to the test environment. In addition, the Service User gets access to the detailed test script. Once the contract is signed, the SU is also entitled to telephone support from SIX (fees might apply).
The following sections outline the information a Service User must provide to register with bLink, as well as the necessary information to connect to the various system environments. The required information comprises general information (e.g., company name, marketing description, contact information) and technical information (e.g., authentication, base urls, IP addresses).
General Information
| Company information | Details |
|---|---|
| Client ID Test Environment | Unique identification of the Service User's test environment assigned by SIX |
| Client ID Prod Environment | Unique identification of the Service User's production environment assigned by SIX |
| Company Name | Company name of the Service User |
| Company Name Abbreviation | Abbreviation of company name for mobile applications |
| Company URL | Website URL of the Service User |
| Short Description Company* | Short description of the company |
| Marketing Description Company* | Marketing description of no more than five bullet points describing the company's claim |
| Product Name | Name of the Product |
| Product Info URL | Website URL of the Product |
| Short Description Product* | Short description of the product |
| Marketing Description Product* | Marketing description of no more than five bullet points describing the product |
| Business Contact | Email address and optional phone number for business inquiries |
| Technical Contact | Email address and optional phone number for technical inquiries |
| Support Contact | Email address and optional phone number for support inquiries |
| Logo | SVG image of company or product logo |
| Icon | SVG image of company or product icon |
| Use Cases | List of use cases that the participant supports |
| Consent Flows | Type of consent flows supported with corresponding clientRedirectUrl for callback |
* This information is deprecated and will be removed with Platform Module V3!
All values are subject to specific character and pattern restrictions, which can be found in the dedicated platform module specification.
Requirements Logo and Icon
- Format: SVG
- Position: Centered
- Max. Size: 100 KB
Icon specific requirements:
- Shape: Square
- Spacing: Include an additional radius or frame equivalent to 50% of the icon's size to facilitate adaptability to various shapes.
- Background: Ensure the background is white; the surrounding space should either be white or transparent.
Example Icon:
Connectivity information for the SIX test environment
SIX has to provide SU with the information listed in the following table regarding the test environment.
| Test Environment - SIX | |||
|---|---|---|---|
| Host Name | api-qa.np.six-group.com | ||
| API Base URLs | |||
| Service | Base URL for Consent 2.0 | Base URL for Consent 2.0 with CaaS | |
| Consent - V2 | /api/bankingservices/xe/b-link-consent-2/consent-flow/v2 | /api/bankingservices/xe/b-link/consent-flow/v2 | |
| Platform - V2 | /api/bankingservices/xe/b-link-consent-2/platform/v2 | /api/bankingservices/xe/b-link/platform/v2 | |
| Account Information Service - V3 | /api/bankingservices/xe/b-link-consent-2/account-information-service/v3 | /api/bankingservices/xe/b-link/account-information-service/v3 | |
| Payments Submission Service - V3 | /api/bankingservices/xe/b-link-consent-2/payments-submission-service/v3 | /api/bankingservices/xe/b-link/payments-submission-service/v3 | |
| Custody Services - V2 | /api/bankingservices/xe/b-link-consent-2/custody-services/v2 | /api/bankingservices/xe/b-link/custody-services/v2 | |
| Customer Management - V1 | /api/bankingservices/xe/b-link-consent-2/customer-management/v1 | /api/bankingservices/xe/b-link/customer-management/v1 | |
| Order Placement - V2 | /api/bankingservices/xe/b-link-consent-2/order-placement/v2 | /api/bankingservices/xe/b-link/order-placement/v2 | |
Connectivity information for the SU test environment
Authentication for the test environment
Certificate authentication is used for connections from SU to SIX. The following table shows the required certificates that must be used for the authentication process in the test environment.
| Certificate Issuer | CN of issuer / type of certificate authority used for test environment |
|---|---|
| Certificates (CA and client cert) | Certificates to be supplied in PEM or CRT format |
| Certificate | Check the requirements on the TLS/Certificates page in the Security section |
Callback for the test environment
SU have to provide a redirect endpoint to receive callbacks from Service Provider. The following table shows examples for possible callback URLs.
| Parameter | Consent-Flow Type | Example |
clientRedirectUri | Consent-Flow 2.0 | https://test-su.example.com/oauth-redirect |
| CaaS | https://webapp.api.six-group.com/redirect/bankingservices/b-link/v2/api-token | |
clientCallbackUri | Consent-Flow 2.0 | n/a |
| CaaS | https://test-su.example.com/callback |
Connectivity information for the SIX production environment
SIX has to provide SU with the information listed in the following table regarding the production environment.
| Production Environment | |||
|---|---|---|---|
| Host Name | api-cert.six-group.com | ||
| API Base URLs | |||
| Service | Base URL for Consent 2.0 | Base URL for Consent 2.0 with CaaS | |
| Consent - V2 | /api/bankingservices/b-link-consent-2/consent-flow/v2 | /api/bankingservices/b-link/consent-flow/v2 | |
| Platform - V2 | /api/bankingservices/b-link-consent-2/platform/v2 | /api/bankingservices/b-link/platform/v2 | |
| Account Information Service - V3 | /api/bankingservices/b-link-consent-2/account-information-service/v3 | /api/bankingservices/b-link/account-information-service/v3 | |
| Payments Submission Service - V3 | /api/bankingservices/b-link-consent-2/payments-submission-service/v3 | /api/bankingservices/b-link/payments-submission-service/v3 | |
| Custody Services - V2 | /api/bankingservices/b-link-consent-2/custody-services/v2 | /api/bankingservices/b-link/custody-services/v2 | |
| Customer Management - V1 | /api/bankingservices/b-link-consent-2/customer-management/v1 | /api/bankingservices/b-link/customer-management/v1 | |
| Order Placement - V2 | /api/bankingservices/b-link-consent-2/order-placement/v2 | /api/bankingservices/b-link/order-placement/v2 | |
Authentication for the production environment
Certificate authentication is also used for connections from SU to SIX. The following table shows the required certificates that must be used for the authentication process in the production environment.
| Certificate Issuer | CN of issuer / type of certificate authority used for test environment |
|---|---|
| Certificates (CA and client cert) | Certificates to be supplied in PEM or CRT format |
| Certificate | Check the requirements on the TLS/Certificates page in the Security section |
Callback for the production environment
SU can use a redirect endpoint to receive callbacks from Service Provider. The following table presents the callback URL for the production environment.
| clientRedirectionEndpointUrl/callbackUrl | https://production-su.example.com/callback |