Surfacing Our Open Banking Connection

For a partner to be able to fully submit an application to YouLend via API, we will require banking/sales data for the merchant.

For YouLend hosted journeys, YouLend gather this directly from the merchant - a merchant can either connect to our open banking provider Plaid, or upload .pdf bank statements.

For API integrated journeys, there are multiple ways partners can provide YouLend with banking data. If a partner already stores their merchant's banking data, we have endpoints to receive this and accept PDF & JSON formats. This guide will explain the process of surfacing our own Open Banking connection (powered by Plaid) to provide YouLend with bank statements via Open Banking.

When creating a lead via API, the 200 response in will contain a openBankingURL.

Response example (Create a lead)

{
    "leadId": "881fae34-8871-4678-b389-843888421501",
    "leadURL": "https://partners.staging-youlend.com/dashboard/youraccount/881fae34-8871-4678-b389-843888421501/companydetails",
    "signUpURL": "https://partners.staging-youlend.com/dashboard/youlendapisignup?emailAddress=mike.bloggs%2bcontract1%40youlend.com&leadId=881fae34-8871-4678-b389-843888421501",
    "openBankingURL": "https://partners.staging-youlend.com/apply/dashboard/secureplaidconnect?leadId=881fae34-8871-4678-b389-843888421501&country=unitedKingdom&companyName=OB Testing"
}

The openBankingURL will redirect a merchant to a YouLend hosted page, where we will ask the merchant to connect their main business bank account.

The partner can embed this URL within a button on their UI "To finish your application, please verify your bank account".

Submitting a lead for decision

In terms of fully submitting a lead via API when using our Open Banking connection, we recommend the below approach:

1. Create a lead
   1. Response includes the openBankingURL
2. Send significant persons information to the Update significant persons endpoint
3. Redirect the user to the YouLend hosted Open Banking page to connect their bank account
   1. You can receive immediate feedback of this step being completed once the user has connected their bank account via Open Banking by subscribing to the ONB10058 webhook event
4. Once you have received the success confirmation from the above webhook, send a POST request to the Submit stage 1 endpoint

Example payload ONB10058

{
  "EventCode": "ONB10058",
  "Message": "Banking data received from the merchant",
  "EventProperties": {
    "EventId": "2f0d6285-cdd4-4666-a13e-60ee27781d6b",
    "LeadId": "a06495c3-b88a-4ad2-a9e2-59b1926b20b6"
  }
}

📘

Good to know

Read our Introduction to Onboarding guide to learn more about the application process via API

Open Banking merchant journey

📘

Good to know

Partners can surface the Open Banking flow within an iframe / web-view, or open the journey in a new tab

📘

Good to know

If the user is completing the journey on their mobile device, they will be redirected to their banking app via deep linking. If the user is completing the journey on a desktop, they will be redirected to the browser / online banking equivalent