Signup+ basics
The Signup+ API simplifies the onboarding process. Users can sign up for your service with a single payment, without entering data manually.
Availability
The Signup+ API is in public beta in the UK and Finland only. If you'd like us to support a particular country, speak to customer support and ask us.
Signup+ retrieves user data and support the following integration methods:
- Payments
- Payment first: you collect user details using the
id
of a settled payment created with the Payments API v3. - Automated 18+ age check for payments: you create a payment which settles only if the remitter is older than 18 years old.
- Payment first: you collect user details using the
- Data, where you collect user details through the Signup+ API, usually before a payment.
- Variable recurring payments, where you collect user details from a variable recurring payment mandate
id
.
Which method to choose depends on how you plan to use Signup+. The payments flow creates a smooth payment and signup flow for industries such as financial services. The data only flow includes an additional age verification check before any payments are taken, which is necessary for iGaming merchants.
Payments only flow
The payments only flow simplifies onboarding for your service, allowing a user to register and make a payment at the same time. In this flow:
- The user makes a payment using TrueLayer’s Payments API v3.
- To retrieve the user's data, you send a request to the
/signup-plus
endpoint with the paymentid
. - We return the user data for the account that made the payment.
Data only flow
The data only flow involves verifying the user's identity before doing anything else, such as creating a payment. You can use this information for additional security checks, for example age verification. This reduces risk and improves security. In this flow:
- The user gives consent for you to access their bank data.
- They are redirected to their bank to authenticate, then sent back to your app.
- To retrieve the user's data, you send a request to the Signup+
/accounts
endpoint. - We retrieve the account details for the account that the user has given consent for.
If the user has more than one valid connected account with the same provider, we ask for theaccount_id
of the account that they want to use. - We return the user data for that account.
Variable recurring payments flow
The variable recurring payments flow can help automate the signup process for platforms that accept recurring payments. In this flow:
- The user creates a new mandate for variable recurring payments.
- The user authorises the mandate.
- To retrieve the user's data, you send a request to the
/signup-plus
endpoint with the mandateid
.
UX guidelines
When you integrate Signup+, ensure that your user interface highlights its benefits and maximises adoption. Our UX guidelines for Signup+ contain guidance on how to highlight the benefits of Signup+, create an effective provider selection screen, and the regulatory information you must include.
Limitations
Signup+ API is only available in the UK and Finland.
The Signup+ API provides user data for current accounts only. We don't yet support credit cards, savings accounts, business accounts or joint accounts.
There is also a small group of challenger banks that we don't currently support, though we're looking to change this in the future. These banks and their provider IDs are:
UK | Finland |
---|---|
ob-revolut )ob-transferwise )ob-starling )ob-boi )ob-danske ) | ob-revolut-fi )xs2a-n26-fi ) |
We recommend that you do not include these banks on your provider selection screen.
Updated 5 months ago