Skip to main content

​
Scopes

  • Open Data 🌐
  • Account Information 🔒
  • Payment Initiation 🔒
  • VRP 🔒

​
Live Environment

Precondition: To connect to live Open Banking entities, whether you are accessing account information or initiating payments, your business must have the right regulatory permissions as per the Open Banking Guide.
  1. Upload your transport and signing certificates (PEMs) created in the Open Banking directory, along with the keys into Yapily’s certificate vault.
  2. Add First Direct from the Live tab to your Dashboard application and add your Signing key Id, which can be obtained from the Open Banking Directory.
  3. Select your Open Banking transport and signing certificates from the relevant drop-downs lists then click Next.
  4. Click to register to auto-register with the bank. If registration is successful, the key and secret will be populated from the institution’s response.
  5. Make sure to click Save in order not to lose these credentials, as a further registration attempt with the same Open Banking software statement is likely to fail.

​
Migration to 3.1.1

Update: 20/02/2020 HSBC Group ASPSPs (HSBC, First Direct and M&S Bank) will terminate the current AIS 2.0 and 1.1 PIS API versions. To ensure you are running on version 3.1.1 for both AIS and PIS, you will need to have a valid eIDAS QWAC and QSEAL certificates, and go through our registration process again before the 28th February 2020. All of your consents from the old version will migrate to updated version. Steps on how to do this are outlined below:
  1. Upload your public eIDAS certificates into OBIE Directory’s SSA and copy the QSEAL kId.
  2. Upload your public and private eIDAS into Yapily’s certificate vault
  3. Go to your application’s institution tab and edit first direct change the Signing KeyId to the QSEAL kId you copied from OBIE Directory. Select the QSEAL and QWAC you uploaded in 2. and press next
  4. Press “Download and Register”, wait until the registration process is done, then click save.
  5. Make sure to click Save in order not to lose these credentials, as a further registration attempt with the same Open Banking software statement is likely to fail.

​
VRP Sweeping Access

In order to access the VRP endpoints we have to grant your Yapily application additional scopes. If you do not have these scopes then please contact your customer success manager to get them added.
The following steps are not intended for Yapily Connect customers.
Precondition: To use VRP on firstdirect a manual registration via API is required. Pre-requisites for Manual registration:
  • Valid OBWAC / OBSEAL certificates
  • PIS registration details for firstdirect
You can use existing PIS registration details for this institution to gain VRP sweeping access. The registration details can be found on the Yapily Console for the given application. If a new registration is required (e.g. if you are using a new redirectUri for VRP and it is not covered in the existing registration) then you can perform a DCR request using the steps outlined in Live Environment. The existing or new registration credentials from the Yapily Console will be used in the steps below.

​
Steps Required for Manual registration

  1. Upload the signing (OBSEAL) and transport (OBWAC) certificates if not already present
You can check if the certificate is present already by navigating to the Console -> Certificates. If absent please upload the certificate. Once confirmed, we need the UUID of the certificate which can be found in the Console -> Certificates -> Certificate; the UUID will appear in the browser URL bar as follows: https://console.yapily.com/certificates/<UUID> Save the UUID and remember for which kind of key it corresponds to: e.g. SIGNING_KEY_UUID = d16f87d3-4222-4173-b8b9-44aeccacae7d Once you have done it for the signing key, repeat the process for your transport certificate.
  1. Call the manual registration endpoint
The final step is to call the manual registration endpoint with the certificate UUIDs and credentials from your application created on the portal. The apiTypes field in the example has both types but if the registration in question grants PIS access only then only provide PISP. If a custom redirect URI (not Yapily’s) is used for the registration then you can provide it in the redirectUri field. The clientId field corresponds to the key field on the Yapily Console. Request 
curl --location --request POST 'https://api.yapily.com/institutions/firstdirect/manual/register' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic ...' \
     --data-raw '{
            "signingKeyID": "$SIGNING_KEY_UUID",
            "transportKeyID": "$TRANSPORT_KEY_UUID",
            "clientId": "$CLIENT_ID",
            "softwareStatementId": "$SSA_ID",
            "organisationId": "$ORGANISATION_ID",
            "apiTypes" : ["AISP", "PISP"],
            "redirectUri" : "<optional-redirect>"
            }'
Response 
{
"id": "a0460a91-4b4c-422a-bbe6-bebe0b92e308"
}
This is the Yapily registration id which can be used to Get, Modify, Delete the registration.

​
Support

If you require technical support with certificate management, please contact Support.