Direct Registration

Registration steps for customers who are regulated as AISPs and/or PISPs


As a direct customer, you likely already have an AISP and/or PISP license with the FCA, from which point the following steps are required for you to connect to ASPSPs on the Yapily gateway.

Prerequisites

Depending on which regions you wish to be an AISP and/or PISP in, you will need to first complete the required prerequisites:

Uploading your certificates to the Yapily Console

Once you have followed the prerequisites above for the regions you wish to be an AISP and/or PISP for and have created the required certificates, the next step is to upload the appropriate certificates to the Yapily Console.

Once logged into the Yapily Console, navigate to Certificates and select Upload Certificate. You will then be taken to the following page to upload your certificates:

Yapily Certificate upload

You will need to go through this process twice; once for the transport certificate (OBWAC or QWAC) and once more for the signing certificate (OBSeal or QSEAL). You will need to upload the appropriate .pem file and .key file for both certificate types you upload.

If you have followed the naming convention for the appropriate certificates you are attempting to upload (Naming your Open Banking Certificates or Naming your eIDAS Certificates), then it should be trivial to fill in the following fields:

  • Certificate Key Id : This only applies to OBWAC and OBSeal certificates types and the value to use comes after KID in the file name
  • Type of certificate : This is indicated by the first value in the file name
  • Alias Name : Copy the file name without the extension

Institution Registration Process

Once you have followed the prerequisites above for the regions you wish to be an AISP and/or PISP for, have created the required certificates and have successfully uploaded the certificates to the Yapily Console as above, you are ready to register each Institution you wish to connect to.

First, select an Application with the desired one or more Institution you intend to register by selecting Applications in the Console menu. Next, select Institutions to view each Institution available in the Application. If you haven't already added the Institution to your application, select Add Institutions option to choose the Institution and add it.

At this point, you should have an Institution under Not Registered section. Click on Register to begin the Institution registration process.

Specifying Certificates

On the first page, you will be required to add your signing and transport certificates which will either be your Open Banking certificates (OBWAC and OBSeal) or your eIDAS certificates (QWAC and QSEAL). Depending on which type of certificates you are uploading, the required information may slightly differ. See the examples below:

European example

In addition to the QWAC and QSEAL certificates, you should specify the following:

  • Key : The username provided on registration of OB compliant software
  • Secret : The password provided on registration of OB compliant software (N.B. This may not be required / provided for specific banks)
Please note:

Different banks might require some additional parameters. You can learn more about the registration process of individual banks on the registration form page.

Yapily registration EU example

GB example

In addition to the OBWAC and OBSeal certificates, you should only have to specify the following:

Yapily institution registration UK example

In any case, be sure to check the link to the documentation included for more information on any other additional fields.

After filling out the first page, click Register to complete the registration.

Manual Registration

Manual bank registration requires registering on the banks developer portal and you will have to follow the documented steps for the Institution to obtain these values by following the link included in the registration form page.

Once you have obtained these credentials and entered them into the relevant fields, you can click the Register button to save the completed registration. This should automatically populate Key and Secret fields.

Dynamic Client Registration

You will be prompted for a Key and Secret and the Register button will be available. This indicates that the Institution supports DCR and that you will not need to go through a bespoke registration process for this Institution.

To complete the registration, click the Register button and if successful, the Institution will return a Key and optionally a Secret.

Testing Registrations

In order to test that a registration for an Institution was successful, execute the appropriate authorisation for the Institution and verify that you are able to successfully redirect to the authorisationUrl (or in the case of an embedded Institution, verify that the request executes successfully).

For completeness, for redirect-based flows, you should attempt to log into the Institution using real valid credentials, however with the difficulty of sourcing accounts, successfully redirecting to the Institution log in page without errors is a generally a good indication.

Failed Registrations

If the registration fails when entering the credentials in the Console as described in above, then please raise a ticket with the Support Team with the following information:

  • Application Id / Name
  • Institution Name
  • Time of Registration
  • A description of the error message / screenshot of the failure

If the registration in the Console was successful but there were issues testing the registration, please raise a ticket with the Support Team with the following information:

  • Application Id / Name
  • Institution Name
  • Tracing Id
  • A description of the error message / screenshot of the failure